Skip to main content
GET
Get clicks timeline

Authorizations

x-api-key
string
header
required

API Key authentication for programmatic access.

How to use:

  1. Create an API key from your dashboard settings
  2. Include the key in the x-api-key header with each request
  3. API keys have granular permissions (domains, shortLinks, files, stats, apiKeys)

Example:

Types of API keys:

  • User keys: Linked to your user account (one per organization)
  • Bot keys: Autonomous machine users (one per organization)

Security notes:

  • Keep your API keys secure and never commit them to version control
  • API keys cannot access authentication endpoints (/auth/*)
  • Keys can be revoked at any time from the dashboard

Query Parameters

Filter by specific short link UUIDs

Example:
domainIds
array

Filter by domain UUIDs

Example:
folderIds
array

Filter by folder UUIDs

Example:
tagIds
array

Filter by tag UUIDs

Example:
startDate
string<date-time> | null

Start date for analytics range

Example:

"2024-01-01T00:00:00Z"

endDate
string<date-time> | null

End date for analytics range

Example:

"2024-01-31T23:59:59Z"

Response

Clicks timeline retrieved successfully

Clicks over time response

data
object[]
required

Array of daily click counts

totalClicks
number
required

Total clicks across all dates

Required range: x >= 0
Example:

5234