Docs
API

Get UTMs

GEThttps://api.visitors.now/v1/analytics/utms

Returns UTM campaign data ranked by visitors. Requires a type parameter. Supports cursor-based pagination.

Request

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

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

Query parameters

type

stringrequired

UTM type. One of source, medium, campaign, content, term.

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.

Response

{
  "items": [
    {
      "value": "twitter",
      "people": 312,
      "views": 891
    },
    {
      "value": "newsletter",
      "people": 198,
      "views": 423
    },
    {
      "value": "producthunt",
      "people": 145,
      "views": 312
    }
    // ...
  ],
  "nextCursor": null
}