Follow

AerServ Reporting API

*To enable this feature, please contact your account manager to acquire your private hash key.

The following directions below will enable publishers to set up automated reporting scripts to receive a .CSV download of performance data based on your preferred criteria.

Reporting API URL: http://platform.aerserv.com/site_reports/export

Required parameters to include in your query:

Parameter Format     Description 
report_from_date= mm/dd/yyyy
  • Start date of report
report_to_date= mm/dd/yyyy
  • End date of report
username=  Aerserv Username
  • Name assigned to your account. This is the name that you use to log into your AerServ account.
hash=

 

  • Unique security key that will be assigned to your account. Please contact your account manager for assistance in obtaining your private hash key.
report_type= canned_date
  •  By Date
  canned_ad_source
  •  By Adsource 
  canned_geo
  •  By Geo
  canned_os
  •  By Operating System 
  canned_placement
  • (Optional...if included, restricts download to the given PLC. Include multiple PLCs by comma separating them – i.e. &placement=500,501,502)

 

  canned_tag  
  • (Optional...if included, restricts download to specific keyword. Include multiple keywords by comma separating them – i.e. &keyword=keyword1,keyword2,keyword3). 
  • This report is based on the keyword tag set up with the platform
  canned_matchedtag
  • This report is based on the keyword tag set up with the platform
  canned_pubkeys
  • This report is based on the publisher key values that has been set up within the platform
  • This will provide metrics based on publisher key value pairings
  [report id]
  • By custom report. If a publisher has created a custom report and wishes to pull this specific report using report API, the report_type will need to refer to the corresponding report ID assigned to the custom report. The report id can be retrieved in the URL that generates the custom report. 
No_export_headers=  1
  •  Raw data
   0
  •  CSV

 

There are 7 canned reports that you can select from in addition to building custom reports.  For example:

By Date (report_type=canned_date)

http://platform.aerserv.com/site_reports/export?report_from_date=01/01/2015&report_to_date=01/02/2015&hash=a00100aaa&username=test&report_type=canned_date&no_export_headers=0

By Ad Source (report_type=canned_adsource)

http://platform.aerserv.com/site_reports/export?report_from_date=01/01/2015&report_to_date=01/02/2015&hash=a00100aaa&username=test&report_type=canned_ad_source&no_export_headers=0

By GEO (report_type=canned_geo)

http://platform.aerserv.com/site_reports/export?report_from_date=01/01/2015&report_to_date=01/02/2015&hash=a00100aaa&username=test&report_type=canned_geo&no_export_headers=0

By Operating System (report_type=canned_OS)

http://platform.aerserv.com/site_reports/export?report_from_date=01/01/2015&report_to_date=01/02/2015&hash=a00100aaa&username=test&report_type=canned_os&no_export_headers=0             

By Placement (report_type=canned_placement)

http://platform.aerserv.com/site_reports/export?report_from_date=01/01/2015&report_to_date=01/02/2015&hash=a00100aaa&username=test&report_type=canned_placement&no_export_headers=0

By All Keyword (report_type=canned_keyword)

http://platform.aerserv.com/site_reports/export?report_from_date=01/01/2015&report_to_date=01/02/2015&hash=a00100aaa&username=test&report_type=canned_keyword&no_export_headers=0

 

 

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.

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk