Sign in

v1

latestOpenAPI 3.1.02026-07-22123157.1 KB

Ad Revenue Reports API

Track your revenue from our products over an easy-to-use API. The API provides a JSON response with an array of data.ad_revenue objects. Each report object will contain the metrics that you requested for, attributed to the combination of breakdowns you included in your request. All dates must follow the YYYY-MM-DD format.

post/v1/ad-revenue-data

Request body

start_datestring date required

Start date (inclusive), in YYYY-MM-DD format. Must not be earlier than 2018-06-01.

end_datestring date required

End date (inclusive), in YYYY-MM-DD format. Cannot be in the future or earlier than start_date.

property_idstring

(Optional) Limits the data to a specific Property ID. If you don't pass anything, data is returned for all Properties under your Account. More about Accounts and Properties here.

metricsstring[]

(Optional) Allows you to define which revenue-related metric(s) you want the API to return. If you do not pass any values in the API request body for this, we will return the following metrics by default: impressions, ecpm, and revenue.

Supported values:

  • impressions: Total number of ad impressions shown to your users on Gamezop's products.
  • clicks: Total number of clicks that users made on the ads that were shown to them on Gamezop's products.
  • ctr: Click-through rate, calculated as {(clicks/impressions)*100}. We serve ads from a mix of multiple ad networks, and not all of them report clicks data to us. When calculating CTR, we only factor in impressions from those ad networks that report both clicks and impressions to us.
  • ecpm: Effective cost per mille. This metric reflects the total revenue made (including Gamezop's share of revenue) for every 1000 ad impressions, calculated as {(revenue/impressions)*1000}. We serve ads from a mix of multiple ad networks, and not all of them report impressions data to us. When calculating eCPM, we only factor in revenue from those ad networks that report impressions data to us.
  • revenue: Your share of advertising revenue from Gamezop's products, captured in USD.
  • total-revenue: Total advertising revenue, including Gamezop's share, made on your Account. This is captured in USD.
breakdownsstring[]

(Optional) Allows you to define how you want the revenue metrics to be broken down in the API response. You can pass multiple values, and all breakdowns will be applied. If you do not pass any values in the API request body for this, we will apply the following breakdowns by default: date and property-id.

Supported values:

  • date: Break down revenue data by date.
  • week: Break down data by week. The week field in the response always represents the Monday of the corresponding ISO week. Revenue is aggregated from Monday through Sunday.
  • month: Break down data by month. The month field always represents the first day of the corresponding ISO month.
  • caap: Break down data by Custom Ad Attribution Parameters (CAAP). Do not pass this breakdown unless you're using our CAAP functionality.
  • country: Break down data by country. See the Important notes section above for a list of supported country codes.
  • ad-format: Break down data by the ad formats served to your users on our products. See the Important notes section above for a list of all supported ad formats.
  • product: Break down data by the Gamezop product where ads were served (such as Gamezop, Quizzop, etc.). See the Important notes section above for a list of all possible product values.
  • property-id: Break down data by your Property IDs.

Example request

{
  "start_date": "2025-06-25",
  "end_date": "2025-06-30",
  "property_id": "1234"
}

Response

HTTP 200 OK. Revenue data returned successfully.

successboolean

Boolean value that is always true, unless there is an error in the API response.