API Best Practices
Setting a Delay
Please set a delay between API calls of at least 5 minutes, including on any failed calls.
Setting a Timeout
Some API Calls, like this one, contain a significant amount of data and therefore may take longer to load. In this case, please configure the timeout to 120 seconds, for best results.
Notations:
- Cost is USD
- Results are sorted by Cost by default
Parameters:
- api_key [STRING] = Marketer API Key
- user_id [INT] = Marketer ID
- from_date = Results starting from this day
- to_date = Results ending with this day
- valid date formats:
- mm/dd/yyyy
- yyyy/mm/dd
- mm-dd-yyyy
- yyyy-mm-dd
- valid date formats:
- campaign_id = Offer ID
- offer_id = Offer ID
- start_row = Start with results from that number
- limit = Limit number of results by that number
- dimensions = field(s) by which results will be grouped
- valid dimension inputs:
- date
- publisher_id
- campaign_id
- os
- example of dimensions → dimensions=[date,campaign_id]
- at least one dimension is required
- valid dimension inputs:
Sample JSON Response
{"success": true,"message": "None","data": [{"date": "2022-02-25","campaign_id": #####,"campaign_name": "Your Offer Name Here","publisher_id": #####,"impressions": "7829321","clicks": "25731","conversions": "336","os": "Android","cost": "1428.0000"},{"date": "2022-02-25","campaign_id": #####,"campaign_name": "Offer Name Here","publisher_id": #####,"impressions": "6066411","clicks": "0","conversions": "254","os": "Mac","cost": "1079.5000"},{"date": "2022-02-25","campaign_id": #####,"campaign_name": "Offer Name Here","publisher_id": #####,"impressions": "4419563","clicks": "58459","conversions": "238","os": "Windows","cost": "1079.0000"}]}