Operation

GET /clicks

Returns daily click aggregates (one row per advertiser per click_date) for a required inclusive date window up to 90 days. Searchkick-backed when the cluster is healthy, with automatic SQL fallback when Searchkick is unavailable or search execution fails. Non-admin callers are scoped to advertisers visible through their publisher; admins may omit publisher_id for all publishers or pass publisher_id to filter one publisher.

Operation ID: listClicks · Tags: Clicks

Parameters

Name In Required Type Description
start_date query Yes string Inclusive start date (YYYY-MM-DD).
end_date query Yes string Inclusive end date (YYYY-MM-DD). Must be on or after start_date.
publisher_id query No integer Admin-only publisher filter. Ignored for non-admin callers (they always see their own publisher).
page query No integer
per_page query No integer
limit query No integer Alias for per_page.

Request Body

No request body is defined for this operation.

Responses

Content Types

  • application/json
{
  "description": "Click rows ordered by click_date desc, click_count desc, advertiser_id asc.",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Click"
            }
          },
          "meta": {
            "$ref": "#/components/schemas/ClicksListMeta"
          }
        },
        "required": [
          "data",
          "meta"
        ]
      }
    }
  }
}

{
  "$ref": "#/components/responses/BadRequest"
}

{
  "$ref": "#/components/responses/Unauthorized"
}

{
  "$ref": "#/components/responses/Forbidden"
}

API Playground

Run this GET request with your API key, or open it in a new tab. Path uses sample IDs where the OpenAPI path has {parameters}. Sign in to enable live testing with your API key.

Action Method Endpoint Description
List advertiser click totals for a date range GET /api/v1/clicks OpenAPI operationId: listClicks.
GET /api/v1/clicks OpenAPI

List advertiser click totals for a date range


    
Ask Dex AIIntegration help

If this page feels TLDR, ask Dex AI.

Dex AI speaks your language, and all the other languages you may not. It will write the integration for you with the right endpoint and headers in one plain-English answer.