AdvertiserMax Report API
This document explains how advertisers or implementation partners can use the AdvertiserMax Report API to retrieve sales and click reporting data for external reporting, reconciliation, or dashboard use.
Overview
- AdvertiserMax provides REST API access to advertiser reporting data.
- The two primary report endpoints are SalesReport and ClickReport.
- Requests are made using the advertiser account ID in the endpoint path.
- Each request must authenticate with the advertiser's API key.
- Responses can be returned as XML, JSON, or CSV.
- The API key is required for all SalesReport and ClickReport requests.
- A missing or invalid API key returns 401 Unauthorized.
- Keep API keys private and do not expose them in public code repositories or client-side scripts.
- The API allows 25 requests per minute.
- If the request limit is exceeded, the API returns 429 Too Many Requests.
- Integrations should pause and retry after the request window resets.
- Retrieve the advertiser API key from AdvertiserMax Web Services.
- Choose the report endpoint: SalesReport or ClickReport.
- Send requests with startDate, endDate, page, and pageSize.
- Use pageSize=1000 for larger pulls to reduce total request count.
- Continue requesting pages until no additional records are returned.
- Store returned data in the advertiser's reporting system or dashboard.
- Schedule the integration to run daily, weekly, or monthly depending on reporting needs.
Base URL and Endpoint Pattern
Base URL: /api
GET /api/{advertiserID}/SalesReport
GET /api/{advertiserID}/ClickReport
Authentication
API Key: Each advertiser account has an API key available in AdvertiserMax under Web Services.
Supported Response Formats
|
Format |
Use Case |
|
application/json |
Recommended for most modern integrations and dashboards. |
|
application/xml |
Useful for legacy integrations or XML-based data workflows. |
|
text/csv |
Useful for flat-file imports, spreadsheet review, or scheduled reporting exports. |
SalesReport Endpoint
Purpose: Retrieves transaction-level sales report data.
GET /api/{advertiserID}/SalesReport
Example:
GET /api/1062874/SalesReport?startDate=2026-08-01&endDate=2026-08-31&page=1&pageSize=1000
|
Parameter |
Required |
Description |
|
startDate |
Yes |
Lower bound of the date range in YYYY-MM-DD format. |
|
endDate |
No |
Upper bound of the date range in YYYY-MM-DD format. Defaults to today if not supplied. |
|
programID |
No |
Filters results to a specific advertiser program. |
|
domainID |
No |
Filters results to a specific publisher domain. |
|
page |
No |
Page number to request. Default is 1. |
|
pageSize |
Yes |
Maximum records per page. Must be between 1 and 1000. Default is 50. |
|
orderBy |
No |
Sort direction. Valid values: Asc, Desc. Default is Desc. |
|
sortBy |
No |
Field used for sorting. Default is DatePosted. |
|
SalesReport Sort Fields |
|
Commission |
|
DatePosted |
|
Domain |
|
Program |
|
SaleId |
|
OrderNumber |
|
SaleAmount |
|
TrafficSource |
ClickReport Endpoint
Purpose: Retrieves click activity for advertiser reporting and traffic analysis.
GET /api/{advertiserID}/ClickReport
Example:
GET /api/1062874/ClickReport?startDate=2026-08-01&endDate=2026-08-31&page=1&pageSize=1000
|
Parameter |
Required |
Description |
|
startDate |
Yes |
Lower bound of the date range in YYYY-MM-DD format. |
|
endDate |
No |
Upper bound of the date range in YYYY-MM-DD format. Defaults to today if not supplied. |
|
programID |
No |
Filters results to a specific advertiser program. |
|
domainID |
No |
Filters results to a specific publisher domain. |
|
page |
No |
Page number to request. Default is 1. |
|
pageSize |
Yes |
Maximum records per page. Must be between 1 and 1000. Default is 50. |
|
orderBy |
No |
Sort direction. Valid values: Asc, Desc. Default is Desc. |
|
sortBy |
No |
Field used for sorting. Default is DateClicked. |
|
ClickReport Sort Fields |
|
CampaignName |
|
CategoryName |
|
DateClicked |
|
TrafficSource |
|
DomainId |
|
DomainName |
|
ProgramName |
Pagination
Large report results are paginated. Use page and pageSize to retrieve each page of the data set. The maximum pageSize is 1000.
page=1&pageSize=1000
page=2&pageSize=1000
page=3&pageSize=1000
Rate Limits
Response Codes
|
Code |
Meaning |
|
200 |
Successful request. |
|
204 |
The request is valid, but no data is available. |
|
400 |
Invalid parameter or request value. |
|
401 |
Unauthorized. A valid API key is required. |
|
403 |
Request forbidden, commonly due to request limit restrictions. |
|
404 |
Invalid endpoint, unsupported format, or resource not found. |
|
429 |
Request limit exceeded. Only 25 requests per minute are allowed. |
|
500 |
Server error. Contact support@flexoffers.com for investigation. |
Recommended Implementation Flow
Monthly Reconciliation Recommendation
For monthly reconciliation, pull the full month by date range and request the maximum page size. This reduces the number of API calls and makes it easier to validate that all sales or clicks for the reporting period were imported.
GET /api/{advertiserID}/SalesReport?startDate=2026-08-01&endDate=2026-08-31&page=1&pageSize=1000