Overview:
The directions below will allow publishers to set up automated reporting scripts to receive a .CSV download of performance data based on preferred criteria.
How to Enable
To enable this feature, please generate your API Key access token in the Account Settings section within the AerServ | InMobi platform.
How to Access
Reporting API URL: https://reporting-api.aerserv.com/generate_report
Required parameters to include in your query:
| Parameter | Format | Description |
|---|---|---|
| start_date | yyyy-mm-dd |
|
| end_date | yyyy-mm-dd |
|
| access_token |
|
|
| report_type= | canned_date |
|
| canned_ad_source |
|
|
| canned_geo |
|
|
| canned_os |
|
|
| canned_placement |
|
|
| canned_pubkeys |
|
|
| canned_pmp |
|
|
| [report id] |
|
|
| include_header | TRUE |
|
| FALSE |
|
Available Reports
There are 8 canned reports that you can select from in addition to building custom reports.
By Date (report_type=canned_date):
https://reporting-api.aerserv.com/generate_report?start_date=2018-10-01&end_date=2018-10-02&access_token=DU8783-78HF-C873H-X8934&report_type=canned_date&include_header=true
By Ad Source (report_type=canned_adsource):
https://reporting-api.aerserv.com/generate_report?start_date=2018-10-01&end_date=2018-10-02&access_token=DU8783-78HF-C873H-X8934&report_type=canned_adsource&include_header=true
By App (report_type=canned_app):
https://reporting-api.aerserv.com/generate_report?start_date=2018-10-01&end_date=2018-10-02&access_token=DU8783-78HF-C873H-X8934&report_type=canned_app&include_header=true
By GEO (report_type=canned_geo):
https://reporting-api.aerserv.com/generate_report?start_date=2018-10-01&end_date=2018-10-02&access_token=DU8783-78HF-C873H-X8934&report_type=canned_geo&include_header=true
By Operating System (report_type=canned_OS):
https://reporting-api.aerserv.com/generate_report?start_date=2018-10-01&end_date=2018-10-02&access_token=DU8783-78HF-C873H-X8934&report_type=canned_OS&include_header=true
By Placement (report_type=canned_placement):
https://reporting-api.aerserv.com/generate_report?start_date=2018-10-01&end_date=2018-10-02&access_token=DU8783-78HF-C873H-X8934&report_type=canned_placement&include_header=true
By PubKeys (report_type=canned_pubkeys):
https://reporting-api.aerserv.com/generate_report?start_date=2018-10-01&end_date=2018-10-02&access_token=DU8783-78HF-C873H-X8934&report_type=canned_pubkeys&include_header=true
By Private Marketplace (report_type=canned_pmp):
https://reporting-api.aerserv.com/generate_report?start_date=2018-10-01&end_date=2018-10-02&access_token=DU8783-78HF-C873H-X8934&report_type=canned_pmp&include_header=true
By Custom Report (report_type=<CUSTOM REPORT ID>):
https://reporting-api.aerserv.com/generate_report?start_date=2018-10-01&end_date=2018-10-02&access_token=DU8783-78HF-C873H-X8934&report_type=<customreportID>&include_header=true
Custom Report ID can be found when you edit the Custom Report. Within the view, the ID is located at the top of the page called "Reporting ID"
Update Regarding Our Reporting Service
AerServ has recently implemented a throttling mechanism to the reporting service that powers the platform dashboard page, platform reporting console, and reporting APIs. To help with the overall stability of our platform AerServ implemented a threshold for each publisher account on how much data can be extracted in a 10 second duration. If there are too many simultaneous reporting queries coming from the platform or the API that exceeds our threshold during that 10 second interval, the UI will alert the publisher to try again shortly. Within the API, you will receive an error message that would look like the following:
{"error": "Request has been throttled. Publisher 214 has requested to use 30 of maximum 20 RSUs in the time range of 10s"} A status code of "429" will be returned as a response from the reporting API if the publisher has reached their reporting threshold.
Comments