Stats API

Aggregate metrics over a period.

Returns single-number values for each requested metric over the specified period.

get/stats/aggregate

Request

  • Base URL: https://api.zenovay.com/api/external/v1
  • URL: https://api.zenovay.com/api/external/v1/stats/aggregate
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Query parameters

site_idstring uuid required

Website UUID. Find in your dashboard URL or via GET /websites.

'day' | '7d' | '30d' | 'month' | '6mo' | '12mo' required
OR
string required

Custom range: custom:YYYY-MM-DD,YYYY-MM-DD. Max 366 days.

Time period for the query.

datestring date

ISO 8601 date used as anchor for the period (default today).

metricsstring required

Comma-separated list of metrics, e.g. visitors,pageviews,bounce_rate.

filtersstring

Plausible-style filter clauses joined by ;:

  • country==US — equals
  • country==US,CA — equals one of
  • browser!=Safari — not equals

With filters, visitors counts the matching visits. pageviews, events and bounce_rate are real page views of the matching visits:

  • a single device== or browser== filter (one value each): any period size;
  • other filters: up to 5,000 matching visits, in a period after page view tracking started for the site;
  • beyond that they are null (never the visit count). meta.note says which applies. visit_duration is null with filters.

Response

Successful aggregate.

successtrue required
timestampstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.