Skip to main content
POST
/
api
/
v1
/
analytics
/
metrics
curl --request POST \
  --url https://mcp.zeroclick.ai/api/v1/analytics/metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "2026-01-01T00:00:00Z",
  "endDate": "2026-01-15T23:59:59Z"
}
'
{
  "data": [
    {
      "dimensions": {
        "tenantClientId": "<string>",
        "tenantGroupingId": "<string>"
      },
      "metadata": {
        "tenantClientName": "<string>"
      },
      "timeSeries": [
        {
          "prompts": 123,
          "eligiblePrompts": 123,
          "promptsWithMatchedAds": 123,
          "responsesWithImpressions": 123,
          "impressions": 123,
          "clicks": 123,
          "estimatedEarnings": 123,
          "datetime": "<string>",
          "date": "<string>"
        }
      ],
      "totals": {
        "prompts": 123,
        "eligiblePrompts": 123,
        "promptsWithMatchedAds": 123,
        "responsesWithImpressions": 123,
        "impressions": 123,
        "clicks": 123,
        "estimatedEarnings": 123
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Tenant API Key with developer:data:read scope. 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.

Body

application/json
​
startDate
string
required

Start date in ISO 8601 format (e.g., "2026-01-01T00:00:00Z")

​
endDate
string
required

End date in ISO 8601 format (e.g., "2026-01-31T23:59:59Z")

​
dimensions
enum<string>[]

Dimensions to group by. Empty array returns overall aggregates. Can combine entity dimensions (TENANT_CLIENT_ID, TENANT_GROUPING_ID) with one time dimension (HOURLY or DAILY). Time dimensions are mutually exclusive.

Available options:
TENANT_CLIENT_ID,
TENANT_GROUPING_ID,
HOURLY,
DAILY
​
tenantClientIds
string[]

Optional filter by tenant client IDs (max 100 items)

​
tenantGroupingIds
string[]

Optional filter by tenant grouping IDs (max 100 items)

Response

Successful response with aggregated metrics and optional time series breakdown

Developer analytics metrics response

​
data
object[]
required

Array of groups, each containing dimension values, time series data, and totals