💰Ad Revenue Reports API

Track your revenue from our products over an easy-to-use API.

This API allows you to programmatically retrieve ad revenue data from Gamezop’s platform. You can query custom time ranges, apply filters, and choose specific breakdowns. This documentation reflects the current version of the API.

View deprecated version here.

Making the request

API endpoint

POST https://api.platform.gamezop.com/v1/ad-revenue-data

POST is used to allow complex filtering and payloads that may exceed standard GET query string limits.

Headers

Name	Type	Description
Authorization: Bearer*	String	Bearer token to authenticate requests. Available in your Gamezop Business Dashboard or through your Gamezop Account Manager.
Content-Type*	String	Must be application/json

Request body

All dates must follow the YYYY-MM-DD format.

Name	Type	Description
start_date*	String	Start date (inclusive). Must not be earlier than 2018-06-01.
end_date*	String	End date (inclusive). Cannot be in the future or earlier than start_date.
property_id	String	(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.
metrics	String []	(Optional) Allows you to define which revenue-related metric(s) you want the API to return. These are the supported metrics values: 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
breakdowns	String []	(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. These are the supported breakdowns values: 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

Sample request

Here's a sample cURL request:

curl --request POST \
  --url https://api.platform.gamezop.com/v1/ad-revenue-data \
  --header 'Authorization: Bearer 12345678-5e32-405e-a193-4a513ce14a73' \
  --header 'Content-Type: application/json' \
  --data '{
    "start_date": "2025-01-01",
    "end_date": "2025-01-31",
    "metrics": [
      "impressions",
      "clicks",
      "revenue"
    ],
    "breakdowns": [
      "date",
      "country",
      "product"
    ]
  }'

---

Understanding the response

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.

HTTP response codes

200: OK

Sample response body:

{
  "data": {
    "account_id": 123,
    "ad_revenue": [
      {
        "date": "2025-01-03",
        "week": "2024-12-30",
        "month": "2025-01-01",
        "country": {
          "code": 13,
          "name": "India"
        },
        "product":"quizzop",
        "impressions": 1000,
        "clicks": 150,
        "revenue": 21.157600
      },
      {
        "date": "2025-01-04",
        "week": "2024-12-30",
        "month": "2025-01-01",
        "country": {
          "code": 13,
          "name": "India"
        },
        "product":"quizzop",
        "impressions": 1200,
        "clicks": 200,
        "revenue": 30.250000
      }
    ]
  },
  "success": true
}

Notes on the response:

• data.account_id is the Account ID mapped to your Bearer Token

• data.ad_revenue is an array of objects. Each object captures a set of breakdowns, and the ad revenue metrics against a combination of all those breakdowns. For instance, here's how you would read the first object from the sample response above:

For 3rd January 2025 (which belongs to the week of 30th December 2024 and to the month of 1st January 2025), from your users visited Quizzop in India, your share of revenue was USD 21.157600. 1000 ad impressions were served to these users, and they clicked on the ads a total of 150 times.

400: Bad Request

Here are the error messages you could receive:

• Both “start date” and “end date” must be present in the request

• “Start date” cannot be greater than “end date”

• “Start date” or “end date” cannot be in the future (current time is calculated in UTC+05:30 timezone)

• If “caap” breakdown is included, start date cannot be less than 2025-01-01

• “Start date” cannot be less than 2018-06-01

• Dates should be formatted as YYYY-MM-DD

• Metrics and / or breakdowns passed in the request contain unsupported values. Please refer to our API docs to see the list of supported values: https://gzp.gg/ad-revenue-data-api

401: Unauthorized

Here are the error messages you could receive:

• The Property ID or IDs that you are requesting data for does not belong to the Account whose Bearer Token you have used

---

Other notes

• The data returned by this API represents estimated earnings only and is not final. If our systems detect invalid traffic (IVT) on your account, we reserve the right to deduct affected amounts prior to payment. Finalized earnings, net of any IVT deductions, can be tracked in the Revenue Metrics > Payments section of the Gamezop Business Dashboard.

• All revenue data is recorded in the UTC+05:30 timezone (Asia/Kolkata). For example, if the API returns a revenue of USD 100 for the date 2025-01-01, it corresponds to the time period from 2024-12-31 18:30:00 UTC to 2025-01-01 18:30:00 UTC

• When fetching revenue data for the current date, you may observe frequent positive or negative fluctuations. This can occur due to exchange rate variations and because ad networks typically take 24–48 hours from the time of revenue generation to report stable figures to us.

• You don't need to pass your Account ID to us in the API request. We find your Account ID using the Bearer Token you use for authorization.

• Revenue data is always returned with six-decimal precision and is denominated in USD.

• Note on dates:

  • Revenue data is available only for dates on or after 2018-06-01

  • CAAP breakdown data is available only for dates on or after 2025-01-01

  • Accurate country-level revenue data is available only from 2023-01-01 onward. For earlier dates, all revenue is reported under country ID 1179, labeled as Country breakdown unavailable (until 31 Dec 2022)

• When you request a CAAP breakdown, the total revenue returned may be less than the total revenue reported without the CAAP breakdown. Read the note here to learn why this happens.

• When you request a country breakdown, we report 2 values for each country: id and name. You can find a list of all supported country id and name values here.

• List of possible ad_format values:

• List of possible product values:

  • gamezop

  • quizzop

  • astrozop

  • criczop

  • newszop