Skip to main content
POST
Ad Revenue Reports API

About the API

The Ad Revenue Reports API is a Platform API, meaning it serves use cases spanning multiple products rather than being tied to just one. For example, the Criczop Cricket Feed API delivers cricket content and is a product-specific API for Criczop. In contrast, the Ad Revenue Reports API provides revenue data for your entire Account ID, covering Property IDs linked to various Zop products. This API lets you query custom time ranges, apply filters, and select specific breakdowns.
POST is used to allow complex filtering and payloads that may exceed standard GET query string limits.

Important 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:
    • display: Display ads served on our products, such as those of sizes 300x250, 320x50 and so on.
    • interstitial: Full page ads served on our products, such as Interstitial, Rewarded, Google Vignette and so on.
    • video: Video / VAST ads served on our products.
    • native: Native ads served on our products, outside of standard IAB sizes.
    • additional - performance ads: Performance / affiliate ads served on our products. For these ads, we receive payments only on conversions, such as installs, sign ups, etc. We do not record impressions or clicks for this ad format.
    • additional - backfilled ads: Ads served from Content Discovery Networks (such as but not limited to Taboola, MGID, Outbrain). We do not record impressions or clicks for this ad format.
    • others: Any other unclassified ad format. You would usually not see any significant portion of your revenue attributed to this ad format. If you do, please contact your Gamezop Account Manager and we’ll look into it.
  • List of possible product values:
    • gamezop
    • quizzop
    • astrozop
    • criczop
    • feedzop
    • events: Every Property ID in our system is mapped to a product. events refers to seasonal products we create during festivals, sporting events, or other events of national / global importance. Our partners send traffic to these products only during such seasonal events.
    • performance-ads-reseller: Only partners using Gamezop Campaign Links will receive this product in their Ad Revenue Reports API.

API specification

Authorizations

Authorization
string
header
required

You can find the Bearer token for this API under Settings & Admin > API Tokens within the Gamezop Business Dashboard.

Body

application/json
start_date
string<date>
required

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

Example:

"2025-06-25"

end_date
string<date>
required

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

Example:

"2025-06-30"

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.

Example:

"1234"

metrics
enum<string>[]

(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.
Available options:
impressions,
clicks,
ctr,
ecpm,
revenue,
total-revenue
breakdowns
enum<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. 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.
Available options:
date,
week,
month,
caap,
country,
ad-format,
product,
property-id

Response

HTTP 200 OK. Revenue data returned successfully.

data
object
success
boolean

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