Skip to main content
GET
/
api
/
v2
/
metrics
/
geo
Get metrics broken down by country
curl --request GET \
  --url https://mcp.zeroclick.ai/api/v2/metrics/geo \
  --header 'x-zc-api-key: <api-key>'
{
  "startTime": "<string>",
  "endTime": "<string>",
  "totals": {
    "adRequests": 123,
    "impressions": 123,
    "clicks": 123,
    "estimatedEarnings": 123
  },
  "breakdown": [
    {
      "adRequests": 123,
      "impressions": 123,
      "clicks": 123,
      "estimatedEarnings": 123,
      "country": "<string>"
    }
  ],
  "freshness": {
    "lastUpdatedAt": "<string>",
    "nextUpdateAt": "<string>"
  }
}

Authorizations

​
x-zc-api-key
string
header
required

Tenant API Key with developer:data:read scope, sent in the x-zc-api-key header. Create an API key from https://developer.zeroclick.ai/ by navigating to API Keys and selecting the Organization API Keys tab. This is a private API key and must be stored securely - never expose it in public-facing code or client-side applications.

Query Parameters

​
startTime
string<date-time>
required

Start of date range (ISO 8601) ISO 8601 timestamp

​
endTime
string<date-time>
required

End of date range (ISO 8601) ISO 8601 timestamp

​
clientId
string

Filter by a single tenant client ID

​
groupingId
string

Filter by a single grouping ID

Response

Aggregated totals plus per-country breakdown.

​
startTime
string
required
​
endTime
string
required
​
totals
object
required
​
breakdown
object[]
required
​
freshness
object
required