Method: GET /advertiser/listStats
Description: You can retrieve statistics for advertising campaigns created in your HilltopAds advertising account.
Parameters:
name | description | example | comment |
key | A unique API key that you can generate in the API section of your HilltopAds account | nXzgO3Bc | This is a required parameter in the request. |
Date | The day for which you need to retrieve statistics data. | 2023-01-01 | By default, the response will provide statistics for yesterday. |
Date2 | Specify this parameter if you need statistics for a specific period. | 2023-01-31 | This date will be considered the last day of the period, and the date parameter will be the first day. |
GEO | Specify this parameter if you need statistics for specific countries.
| UK | To retrieve data for multiple countries, list them separated by commas.
|
zoneID | Specify this parameter if you need statistics for specific zones. | 4OACSGAI8 | To retrieve data for multiple zones, list them separated by commas. |
campaignID | Specify this parameter if you need statistics for specific campaigns. | 123456 | To retrieve data for multiple campaigns, list them separated by commas. |
adID | Specify this parameter if you need statistics for specific advertisements. | 123456 | To retrieve data for multiple advertisements, list them separated by commas. |
group | Specify this parameter to group the data. | date | You can group by: date, hours, GEO, zoneID, campaignID, adID. |
Request Example:
To retrieve statistics for campaign 123456 for the period from February 1st to March 31st, 2023, grouped by date, you should write the following request:
https://hilltopads.com/api/advertiser/listStats?key=nXzgO3Bc&date=2023-02-01&date2=2023-03-31&campaignId=123456&group=date