Docs
API

Get metrics

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

Returns aggregate metrics (visitors, views, bounce rate, duration, revenue) for the current and previous period.

Request

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

const metrics = await res.json();

Query parameters

period

string

Time period. One of today, yesterday, 24h, 7d, 30d, 3m, 6m, 12m, this_week, this_month, this_year, all_time, custom. Default: 30d.

start

string

Custom start date (ISO 8601). Overrides period.

end

string

Custom end date (ISO 8601). Overrides period.

tz

string

Timezone for date calculations. Default: UTC.

filters

string

JSON-encoded filter object.

Response

{
  "people_current": 2946,
  "views_current": 13249,
  "bounced_current": 41.04,
  "duration_current": 198636.71,
  "revenue_current": 323.04,
  "sales_current": 14,
  "converting_visitors_current": 13,
  "people_previous": 3805,
  "views_previous": 17470,
  "bounced_previous": 36.56,
  "duration_previous": 211907.77,
  "revenue_previous": 323.84,
  "sales_previous": 13,
  "converting_visitors_previous": 13
}