Get aggregated metrics
Returns aggregated ad performance metrics for your tenant over a date range, with an optional time series breakdown.
Definitions (high level):
- Ad request: a request that asked for offers
- Impression: an ad was rendered/shown to a user
- Click: a user clicked through on a rendered ad
- Signal: a captured signal event
- Estimated earnings: revenue in USD (2 decimal places)
Validation Rules:
startTimemust be before or equal toendTime(ISO 8601)- Maximum date range: 31 days when
granularity=hour, 365 days otherwise granularityis optional. When omitted, notimeSeriesis returned.
Authorizations
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
Start of date range (ISO 8601) ISO 8601 timestamp
End of date range (ISO 8601) ISO 8601 timestamp
Filter by a single tenant client ID
Filter by a single grouping ID
hour or day. Enables time series in the response.
hour, day