Home > Supply Side Platform > How to Pull Statistics via API/XML

How to Pull Statistics via API/XML

Application Program Interface (API) allows you to pull statistics directly from Adtelligent servers and allows you to integrate these reports into your own reporting system if needed. Please see the documentation attached at the end of the article.

 


How to pull statistics via API?

 

In order to get and replace {replace_me} part in &auth_token={replace_me} parameter with your unique authorization token for your SSP account you just need to contact our Support Team. The token can be provided only upon your request and sent only to the email address associated with your account for security reasons.

 

Below you can find the examples of the most popular API/XML requests along with the correspondent parameters inserted into API URLs.

 

  • Statistics by days (change the period of time to the one you need): 

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=date&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

  • All sources for a selected period of time (change the period of time to the one you need):

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=source&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

  • Particular source, the selected period of time (change the period of time, change source ID):

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=source&source=XXXXX&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

  • All campaigns, selected period of time (change the period of time to the one you need):

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=campaign&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

  • All campaigns by definite source (change the period of time, change source ID/aid to the one you need):

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=campaign&source=XXXXX&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

  • Sources that were bidding on a particular campaign (change the period of time, change campaign ID):

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=source&campaign=XXXXX&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

  • Domains by a specific campaign (change the period of time, change campaign ID):

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=domain&campaign=XXXXX&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

  • Domains by a specific source (change the period of time, change source ID):

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=domain&source=XXXXX&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

 

How to pull cross reports via API?

 

Below you can find the examples of the most popular cross reports by API/XML requests. More details about parameters you can find in the documentation attached at the end of the article.

 

 

Important: Please keep in mind, in cross reports in order to receive names of sub-slices added to the report parameters, please also add them to the fields parameter. 

 

(if &report=domain,source,campaign then &fields=domain,source,campaign)

 

If you have only one parameter &report=domain then the name of the slice will be added by default.

 

 

 

  • Cross report with domains, sources, and campaigns (change the period of time):

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=domain,source,campaign&date_from=2018-02-01&date_to=2018-03-01&fields=domain,source,campaign,ad_ requests,ad_opportunities,impressions_good&auth_token={replace_me}

 

  •  Cross report by a specific channel with sources, and domains (change the period of time, change channel ID):

 

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=channel,domains,sources&channel=XXXXX&date_from=2018-02-01&date_to=2018-03-01&fields=channel,domains,sources,ad_ requests,ad_opportunities,impressions_good&auth_token={replace_me}

 

 

 

 

 

 

  •  Cross report by a specific source with player sizes for UTC Time Zone (change the period of time, change source ID):

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=sources,player_size_agg&source=XXXXX&tz=UTC&date_from=2018-02-01&date_to=2018-03-01&fields=sources,player_size_agg,ad_ requests,ad_opportunities,impressions_good&auth_token={replace_me}

 

 

  • Cross report by a specific source with player sizes. Only ad_requests in descending order. (change the period of time, change source ID):

 

https://ssp.adtelligent.com/api/statistics/ssp2.xml?report=sources,player_size_agg&source=XXXXX&fields=ad_requests&sort=-ad_requests&date_from=2018-02-01&date_to=2018-03-01&fields=sources,player_size_agg,ad_ requests,ad_opportunities,impressions_good&auth_token={replace_me}

 

 


How to see the statistics via XML format?

 

You can also receive statistics in XML format. Just add .xml into the API URL in the following way (depicted in the screenshot below):

 

 

https://ssp.adtelligent.com/api/statistics/ssp2.xml?report=date&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

 

 

 


How to pull statistic data by Channel?

 

If you need statistics only for a particular channel, you can generate the link for that channel in the Channel settings. You can easily download the documentation that will help you with XML link modification by clicking on the "Download" button that is on the right of XML link field. This documentation is also attached to this document.


How to pull statistic data by environment?

 

  • In order to pull the statistics by the environment (Desktop, Mobile WEB, Mobile APP, CTV) for all sources you need to add the environment field to the link below:

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=source&environment=desktop&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

  • In order to pull the statistics by the environment (Desktop, Mobile WEB, Mobile APP, CTV) for all campaigns you need to add the environment field to the link below:

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=campaign&environment=desktop&date_from=2018-02-01&date_to=2018-03-01&auth_token={replace_me}

 

The parameter environment= should be followed by a valid value and the period of time should be also adjusted to fit the required timeframe.

 

The list of valid environment= values:

desktop
mobile_web
mobile_app
ctv

 

 


How to pull statistics by Today and Yesterday?

 

It is also possible to insert variables like yesterday and today to make the value of the correspondent date updated dynamically.

 

https://ssp.adtelligent.com/api/statistics/ssp2?report=campaign&date_to=today&auth_token={replace_me}

 

In order to get the same statistics for sources replace the value campaign with a source.