Docs
API

Get custom events

GEThttps://api.visitors.now/v1/analytics/custom-events

Returns custom events ranked by visitors. Supports cursor-based pagination.

Request

index.ts
const res = await fetch("https://api.visitors.now/v1/analytics/custom-events?period=7d", {
  headers: { Authorization: `Bearer ${VISITORS_API_KEY}` },
});

const { data, nextCursor } = await res.json();

Query parameters

period

string

Time period. Default: 30d.

start

string

Custom start date (ISO 8601).

end

string

Custom end date (ISO 8601).

tz

string

Timezone. Default: UTC.

filters

string

JSON-encoded filter object.

cursor

string

Pagination cursor from a previous response.

limit

number

Number of results per page. Default: 50.

search

string

Filter events by name.

Response

{
  "items": [
    {
      "event": "signup",
      "people": 142,
      "views": 156
    },
    {
      "event": "purchase",
      "people": 87,
      "views": 93
    },
    {
      "event": "download",
      "people": 64,
      "views": 71
    }
    // ...
  ],
  "nextCursor": null
}