Ad Spend (Advertiser Analytics)

Use /reports/adspend to get campaign data from every supported ad network.

Note

Scope: All resources in this route require the private:read scope.

Getting Spend Totals

Request

GET /reports/adspend?group_by={group_by}&start_date={start_date}&end_date={end_date}&products={products}&countries={countries}&networks={networks}&format={format}

Arguments

Argument	Type	Description
start_date	Date	(yyyy-MM-dd) First date to report on, inclusive. With a granularity other than daily, we round it down to the nearest period. Default: the earliest data available.
end_date	Date	(yyyy-MM-dd) Last date to report on, inclusive. With a granularity other than daily, we round it up to the nearest period. Default: the latest data available.
group_by	List	One or more pivots, separated by commas. Available pivots: product, country, date, store, and network. Note: For the store and storefront options to work, you’ll also need to set combine=true.
products	List	(productId | productId1, productId2, …) Products to include in the response. Default: all active products in your account.
countries	List	(isoCode | isoCode1;isoCode2;isoCodeN) Countries to limit the report to. Get country codes from /data/countries. Default: all countries.
networks	List	Only include data from these ad networks. Separate multiple networks with commas. Default: all. Get network names from the /data/stores route.
format	String	Output format: JSON or CSV. Defaults to JSON. Note: With format=csv, we don’t fully serialize sub-objects (like the product in /ads/products/…), only their reference, to avoid repetition.

Response

Field	Type	Description
installs	Number	The total number of installs generated by ad campaigns.
clicks	Number	The number of times an ad from your campaign was clicked or tapped.
impressions	Number	The number of times one of the ads in your campaign was seen.
cost	Money	The total amount of money spent on campaigns.
cpc	Money	The average cost of a single click.
cpa	Money	The average cost of a single acquisition (install).
ctr	Percent	A number between 0 and 1 representing the click-through rate for all ads in the campaign.

Example Response for Totals for the Last 30 Days

GET /reports/adspend?start_date=-30

{
  "installs": 1000,
  "clicks": 15000,
  "impressions": 239012,
  "cost": "12123.94",
  "cpc": "0.86",
  "cpa": "12.94",
  "ctr": "0.06",
  "date": "2018-05-08"
}

Getting Spend Details

Request

GET /reports/adspend?group_by={group_by}&start_date={start_date}&end_date={end_date}&products={products}&countries={countries}&format=csv

Arguments

Argument	Type	Description
start_date	Date	(yyyy-MM-dd) First date to report on, inclusive. With a granularity other than daily, we round it down to the nearest period. Default: the earliest data available.
end_date	Date	(yyyy-MM-dd) Last date to report on, inclusive. With a granularity other than daily, we round it up to the nearest period. Default: the latest data available.
group_by	List	One or more pivots, separated by commas. Available pivots: product, country, date, store, and network. Note: For the store and storefront options to work, you’ll also need to set combine=true.
products	List	(productId | productId1, productId2, …) Products to include in the response. Default: all active products in your account.
countries	List	(isoCode | isoCode1;isoCode2;isoCodeN) Countries to limit the report to. Get country codes from /data/countries. Default: all countries.
networks	List	Only include data from these ad networks. Separate multiple networks with commas. Default: all. Get network names from the /data/stores route.
format	String	Output format: JSON or CSV. Defaults to JSON. Note: With format=csv, we don’t fully serialize sub-objects (like the product in /ads/products/…), only their reference, to avoid repetition.

Response

The leaves use the same format as above, plus one or more group_by fields that match your request.

Field	Type	Description
product_id	Long	The ID of the product this leaf is for. Returned when group_by includes product.
product	Product	The full product object. Returned when group_by includes product.
country	String	The full name of the country this leaf is for. Returned when group_by includes countries.
iso	String	The ISO code of the country this leaf is for. Returned when group_by includes countries.
date	String	The date this leaf is for, in yyyy-mm-dd format. Returned when group_by includes dates.

Example Response for by Day

// GET /reports/adspend/?group_by=dates&start_date=-30

{
  "2018-05-08": {
    "installs": 1000,
    "clicks": 15000,
    "impressions": 239012,
    "cost": "12123.94",
    "cpc": "0.86",
    "cpa": "12.94",
    "ctr": "0.06",
    "date": "2018-05-08"
  },
  ...
}