Docs/API REFERENCE/Periods, timezones, and pagination

Periods, timezones, and pagination

Common parameters

Parameter Required Description
websiteId Yes Website ID belonging to the bearer token.
period No today, yesterday, last24h, last7d, last30d, wtd, mtd, ytd, all, or custom. Defaults to last30d.
startDate For custom ISO 8601 start date.
endDate For custom ISO 8601 end date.
timezone No IANA timezone such as America/New_York. Defaults to UTC.
limit Lists only Integer from 1 through 100.
cursor Lists only Opaque cursor returned by the preceding page.

When period=custom, both dates are required. Do not construct or modify cursors. Continue until pagination.hasMore is false or nextCursor is null.

{
  "data": [],
  "pagination": { "limit": 50, "hasMore": false, "nextCursor": null }
}

CLI equivalents include --period, --start-date, --end-date, --timezone, --limit, and --all.

Need help? Contact us for assistance.

Suggest features? We'd love your feedback