List click events
GET /clicks
GET /clicks
Operation
GET
/clicks
Returns click events scoped to the caller. Admins see all clicks; non-admin callers are scoped to their own publisher. Requires start_date and end_date; defaults to the last 30 days when omitted.
Operation ID:
listClicks
·
Tags: Clicks
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
start_date
|
query | No | string | Inclusive lower bound on clicked_at |
end_date
|
query | No | string | Inclusive upper bound on clicked_at |
advertiser_id
|
query | No | string | Advertiser id or slug |
network_id
|
query | No | string | Network id or slug |
campaign_id
|
query | No | string | — |
publisher_id
|
query | No | integer | Admin-only scope override |
country
|
query | No | string | — |
page
|
query | No | integer | — |
per_page
|
query | No | integer | — |
limit
|
query | No | integer | — |
Request Body
No request body is defined for this operation.
Responses
Content Types
application/json
{
"description": "Clicks list",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Click"
}
},
"meta": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"data",
"meta"
]
}
}
}
}{
"$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 click events | GET |
/api/v1/clicks |
OpenAPI operationId: listClicks. |
GET /api/v1/clicks
OpenAPI
List click events