API reference

Live, hand-maintained spec rendered with Scalar. Click any endpoint and use Test Request to send a real call.

Quickstart, 60 seconds

  1. 1. Mint a key in Settings → API keys with the links:write scope.
  2. 2. Send your first request:
    curl -X POST https://api.qrindo.com/api/v1/links \
      -H "Authorization: Bearer $QRINDO_KEY" \
      -H "Idempotency-Key: $(uuidgen)" \
      -H "Content-Type: application/json" \
      -d '{ "target_url": "https://example.com/launch", "title": "Launch" }'
  3. 3. Visit the returned short_url to test the redirect, then poll /api/v1/links/{code}/stats?period=7d for analytics.

Core concepts

Qrindo Public API v1.0 · 157 public endpoints · Base URL: https://api.qrindo.com/api/v1

Overview

Bearer-token (API key or OAuth client_credentials) REST API for the Qrindo platform. Designed for partner products that need to mint dynamic links, render QR codes, read analytics, and subscribe to scan events.

Authentication

Every request requires Authorization: Bearer <token>.

Token kind Format Best for
API key qrf_live_... / qrf_test_... Long-lived backend integrations
OAuth access token JWT (RS256) Compliance / rotation-heavy partners

Errors

Errors generally follow RFC 7807 problem-json. Report query validation failures use application/json with timestamp, status, error and message, as documented in the report 400 responses.

{
  "type": "https://qrindo.com/errors/rate_limited",
  "title": "Too many requests",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: 10000 req/min per API key. Retry in 12s.",
  "instance": "01HRV..."
}

Idempotency

Pass Idempotency-Key: <uuid> on any POST. Retrying with the same key + body replays the cached response. Retrying with a different body returns 409 idempotency_replay_mismatch.

Rate limits

Per-key per-minute, with RFC 9331 headers (RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset).

Reserved codes (printing before you know the destination)

Stickers are usually printed in bulk, before anyone knows where each one will point. Create those codes with content_type: "placeholder" and no target_url: each one is a real, scannable code whose scan renders the hosted "This QR code is reserved" page, which shows that code so whoever is holding the sticker can read it back to you. target_url is null on a reserved code, and GET /links?content_type=placeholder is the unassigned pool.

Assigning one is an ordinary destination change: POST /links/{code}/rotate, a PATCH /links/{code} with a target_url, or a bulk target_url on PATCH /links/batch. The reserved page is replaced by the redirect and the printed QR keeps working. PATCH /links/batch with reset_to_placeholder: true is the reverse, for a sticker that comes back or is re-sold: the code returns to the reserved page with a fresh payload, while its title, tags, folder, QR design, scans and history stay as they were.

All endpoints

The interactive reference below reads the same spec and can send real requests.

Identity

GET /me

Inspect current API key

Auth: BearerAuth

Responses

StatusDescription
200OK

POST /links

Create a link

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
Idempotency-Key header string —

Request body (JSON)

NameTypeRequiredDescription
qr_color stringnull —
qr_bg_color stringnull —
qr_shape "square" | "rounded" | "dot" | "dots" | "classy" | "extra-rounded" | "diamond" | "null" —
qr_logo stringnull — PNG, JPEG or WebP raster image as a base64 data URI.
qr_frame objectnull —
qr_eye_shape "square" | "rounded" | "circle" | "leaf" | "null" —
qr_eye_color stringnull —
qr_eye_ball_color stringnull —
qr_gradient_from stringnull —
qr_gradient_to stringnull —
qr_logo_shape "rounded" | "circle" | "square" | "null" —
target_url string (uri) — Required for `url` links. Must be omitted when `content_type` is `placeholder`.
content_type "url" | "placeholder" — `placeholder` reserves the code for stickers printed before their destinations are known. Assign it later with `POST /links/{code}/rotate`, a `PATCH /links/{code}` carrying a `target_url`, or a bulk `target_url`.
placeholder object — Copy for the reserved page. Both text fields are optional; left out, the page falls back to its own wording and still shows the code.
code string — Optional vanity slug. 4-8 chars, [A-Za-z0-9_-].
title string —
active boolean —
tags string[] —
folder_id string — A folder in this workspace (see `/folders`). Null or omitted leaves the code unfiled.

Responses

StatusDescription
201Created
400Validation failed
409Code conflict or idempotency mismatch

POST /links/{code}/rotate

Rotate the destination, keep the code

The printed QR never changes. On a reserved (`placeholder`) code this is how it is ASSIGNED: the code becomes a live `url` link and the reserved page is replaced by a redirect.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
code path string yes

Request body (JSON)

NameTypeRequiredDescription
target_url string (uri) yes

Responses

StatusDescription
200OK

POST /links/batch

Create up to 100 links in one call

Returns 201 if all succeed, 207 (multi-status) on partial failure. Each item reports its own success/error. Items may mix `url` links and `placeholder` (reserved, unassigned) codes, which is how a print run is created before its destinations are known.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
Idempotency-Key header string —

Request body (JSON)

NameTypeRequiredDescription
items object[] yes

Responses

StatusDescription
201All created
207Partial success
401Missing, malformed, expired, or revoked token.

POST /links/import

Bulk import links from CSV

Accepts text/csv or multipart/form-data (a `file` field). CSV columns: target_url,code,title,tags (tags pipe-separated).

Auth: BearerAuth

Responses

StatusDescription
201All imported
207Partial import
413Upload exceeds the size limit.

QR

GET /qr/{codeAndExt}

Render a stored link's QR

`png` and `svg` are screen images. `pdf` and `eps` are print files: sized in millimetres by the print parameters, with outlined text, and described on the `X-Qr-Print` response header (trim, page, bleed, code size, colour). A size that cannot print is refused with 400 and the reason.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
codeAndExt path string yes
size query integer —
fg query string —
bg query string —
ec query "L" | "M" | "Q" | "H" —
trimW query number — Finished width of the printed piece, in `unit`. A width alone makes a square piece.
trimH query number — Finished height of the printed piece, in `unit`.
unit query "mm" | "cm" —
bleed query number — Bleed on every side, beyond the trim, in millimetres.
safe query number — Margin inside the trim that the code keeps clear of, in millimetres.
qrMm query number — Width of the code on the piece, in `unit`. Omit to fill the safe area.
colorSpace query "rgb" | "cmyk" — `cmyk` writes DeviceCMYK, with every neutral on the black plate alone.
marks query "0" | "1" — Crop marks outside the bleed.

Responses

StatusDescription
200PNG, SVG, PDF or EPS bytes
400A print size that cannot make a printable file, with the reason

POST /qr/render

Render arbitrary content (no link stored)

Auth: BearerAuth

Responses

StatusDescription
200Rendered image or print file

POST /qr/batch

Render many stored links into one ZIP

Renders up to 50 of your links as PNG, SVG, PDF or EPS and streams them back as a single ZIP archive, one `{code}.{format}` file each. Print files share one size, given by the print options. Codes that don't belong to the workspace are skipped.

Auth: BearerAuth

Responses

StatusDescription
200ZIP archive of QR images or print files
400A print size that cannot make a printable file, with the reason; nothing is zipped
404None of the provided codes resolved to a link

Analytics

GET /reports/access-history

Read access history report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/account-churn

Read account churn report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/account-history

Read account history report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/account-retention

Read account retention report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/acquisition

Read acquisition report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/adoption

Read platform feature adoption

Operator-only platform report. Requires analytics:read; the API key resolver always selects a workspace or code, so this handler returns 404 on the reporting mount. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/ai-visibility

Read ai visibility report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/alerts/events

Read alerts events report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/alerts

Read alerts report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/annotations

Read annotations report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/anomalies

Read anomalies report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/attention

Read attention report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/attribution

Read attribution report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/audit-actions

Read audit actions report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/batches/{batchId}/curve

Read a batch activation cohort curve

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
batchId path string yes
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
days query integer —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/batches/production

Read batches production report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/batches

Read batches report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
horizonDays query integer —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/behaviour/funnel

Read behaviour funnel report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
bucket query "day" | "week" | "month" — Unrecognized values fall back to day.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/behaviour/log

Read behaviour log report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
stream query "account" | "visitor" —
name query string —
userId query string —
source query string —

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/behaviour/logins

Read behaviour logins report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
bucket query "day" | "week" | "month" — Unrecognized values fall back to day.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/behaviour/visitors

Read behaviour visitors report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
bucket query "day" | "week" | "month" — Unrecognized values fall back to day.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/breakdown

Read a dimension breakdown

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
dim query "code" | "workspace" | "botEngine" | "country" | "city" | "region" | "device" | "os" | "browser" | "deviceModel" | "language" | "utmSource" | "utmMedium" | "utmCampaign" | "continent" | "visitorClass" | "networkType" | "channel" | "networkOrg" | "postalCode" | "visitorTimezone" | "anonymizer" | "utmTerm" | "utmContent" | "clickIdSource" | "host" | "outcome" | "variant" | "tag" | "contentType" | "referrer" | "folder" —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/campaigns

Read campaigns report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/captured-leads/{id}

Read captured leads detail report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/captured-leads

Read captured leads report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/code-inventory

Read code inventory report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer —
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
page query integer —
search query string —
ownerId query string —

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/codes/{code}

Read a code analytics profile

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
code path string yes
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/codes

Read the code analytics leaderboard

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/cohorts

Read cohorts report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/consumers

Read consumers report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/conversion-goals

Read conversion goals report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/costs

Read costs report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/coverage

Read coverage report

Requires analytics:read. Returns shared signal capture epochs and coverage gaps for the requested window. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/demand

Read demand report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/designs

Read designs report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/destination-health

Read destination health report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/destination-health/failing

List the codes whose destination is failing

The failing subset of `/reports/destination-health`, as the codes themselves rather than totals. Requires analytics:read. Read-only reporting mount: write methods return 405. Scoped to the API key workspace, optionally narrowed to an owned code. `checked` is the denominator and the only field that separates a true zero from a silence: `checked = 0` beside `failing = 0` does not mean nothing is broken, it means nothing has been looked at yet. The sweep is budgeted, so a large workspace can sit with `checked` well below `eligible` for a long time. Do not render a "0 broken" badge on that state - read `lastCheckedAt` and show nothing instead. It accepts the shared reporting query parameters, but only `limit` changes this response; the ceiling is 500 and `truncated` carries the shortfall.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
limit query integer — Maximum rows for handlers that accept a row limit.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/dormant-accounts

Read dormant accounts in the caller workspace

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code. Verified in production on 2026-11-09: API key requests return 200 for the caller workspace.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
minDormantDays query integer —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/email-deliveries

Read email deliveries report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/engagement

Read engagement report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/erasure

Read erasure report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/event-history

Read event history report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
eventAction query string —
eventAudience query "new" | "returning" | "unattributed" —

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/events.csv

Export scan events as CSV

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200CSV download.
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/events/crawlers

Read events crawlers report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
surface query "marketing" | "landing" | "app" | "api" —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/events/landing-health

Read events landing health report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/events/opt-outs

Read tracking opt-out volumes

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/events

Read paginated scan events

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
cursor query string —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/export.csv

Export an analytics panel as CSV

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
panel query "engagement" | "pages" | "funnel" | "segments" | "attribution" | "visitors" | "cohorts" | "campaigns" | "market" | "referrers" | "demand" | "anomalies" | "seasonal" | "pipeline" | "hotLeads" | "goals" | "interactions" | "scans" | "revenue" | "codes" | "series" | "breakdown" | "geo" | "heatmap" | "live" | "aiVisibility" | "searchQueries" | "workspaces" —
dim query string —
liveWindow query integer —

Responses

StatusDescription
200CSV download.
302When panel=scans, redirects to events.csv with the remaining query parameters.
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/first-week-adoption

Read first week adoption report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/funnel

Read funnel report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/geo

Read geographic scan points

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/goals

Read goals report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/heatmap

Read scan activity by day and hour

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/hot-leads

Read hot leads report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/interactions

Read interactions report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/known-visitors/unlabelled

Read visitors without a saved label

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/known-visitors

Read known visitors report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/latest-signups

Read latest signups report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405. Verified in production on 2026-11-09: API key requests return 403.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/lead-funnel

Read lead funnel report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/lead-ownership

Read lead ownership report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/live

Read current visitor activity

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
liveWindow query integer —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/log-summary

Read log summary report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/market

Read market report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/message-recipients

Read message recipients report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/new-vs-returning

Compare new and returning visitors

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/nudge-variants

Read nudge variants report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/overview

Read scan overview and comparison metrics

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code. Verified in production on 2026-11-09: API key requests return 200 for the caller workspace.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/pages

Read pages report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/pipeline

Read pipeline report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/placement-alignment

Read placement alignment report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
siteId query string —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/placements

Read placements report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
siteId query string —
includeRetired query "0" | "1" | "true" | "false" —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/product-activity

Read product activity report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/referrals/series

Read referrals series report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/referrals

Read referrals report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/referrers

Read referrers report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/relay-health

Read relay health report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/reliability

Read platform reliability metrics

Operator-only platform report. Requires analytics:read; the API key resolver always selects a workspace or code, so this handler returns 404 on the reporting mount. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/repoints/effect

Read repoints effect report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string yes
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
version query integer yes
spanHours query integer —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/repoints/effects

Read repoints effects report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
spanHours query integer —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/repoints/markers

Read repoints markers report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/repoints

Read repoints report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/report-images/{id}

Read an operator report attachment

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/reports/{id}

Read an operator report detail

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/reports

Read the operator report queue

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string —
to query string —
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer —
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
q query string —
type query "bug" | "feature" | "idea" | "question" —
status query "new" | "triaged" | "needs_info" | "planned" | "in_progress" | "shipped" | "declined" | "duplicate" —
priority query "low" | "medium" | "high" | "urgent" —
area query "leads" | "api" | "other" | "links" | "qr" | "analytics" | "billing" | "team" | "sites" | "relay" | "account" —
assigneeId query string —
sort query "newest" | "oldest" | "votes" | "updated" —
cursor query string —
openOnly query "true" | "false" —
excludeId query string —

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/retention

Read retention report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/revenue

Read revenue report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/rules/series

Read rules series report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/rules

Read rules report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/sales-pipeline

Read sales pipeline report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405. Verified in production on 2026-11-09: API key requests return 403.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
dealId query string —

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/saved-segments

Read saved segments report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/search-queries

Read search queries report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/seasonal

Read seasonal report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/security-census

Read security census report

Operator-only. Requires analytics:read, but an API key still receives 403: requireSuperAdmin reads session auth, which API key authentication never sets. This path is mounted for parity and is unavailable to API key integrations. Write methods return 405. Verified in production on 2026-11-09: API key requests return 403.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Operator-only. API key authentication does not set session auth, so requireSuperAdmin returns 403 even when analytics:read is present. Missing scope or an IP restriction can also return a standard problem.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/segments

Read segments report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/series

Read scan and visitor time series

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/shares

Read shares report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/sites/{siteId}/units

Read the unit analytics league for a site

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
siteId path string yes
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
zone query string —
sort query "visitors" | "scans" | "leads" | "label" | "change" | "lastScanAt" —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/sites/{siteId}/zones

Read analytics rollups by site zone

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
siteId path string yes
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/sites/series

Read sites series report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
siteIds query string —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/sites

Read sites report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
sort query "name" | "visitors" | "conversions" | "scans" | "leads" | "change" | "lastScanAt" | "units" —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/subscriptions

Read subscriptions report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/summary

Read summary report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/targets

Read metric targets and progress

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/verticals

Read verticals report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/visitors/{visitor}

Read a visitor journey

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
visitor path string yes Visitor hash containing 4 to 16 hexadecimal characters.
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/visitors

Read visitors report

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
grade query "hot" | "warm" | "cold" —
converted query "0" | "1" | "true" | "false" —
dormantDays query integer —
minSessions query integer —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/vocabulary

Read analytics filter and metric vocabularies

Requires analytics:read. Returns shared analytics vocabularies and limits. Write methods return 405.

Auth: BearerAuth

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/whoami

Resolve the request visitor identity

Requires analytics:read. Resolves the visitor identity of this request from its network and visitor cookie. Write methods return 405.

Auth: BearerAuth

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/workspaces/{id}

Read a workspace analytics profile

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

GET /reports/workspaces

Read the workspace analytics league

Requires analytics:read. Read-only reporting mount: write methods return 405. Data is scoped to the API key workspace, optionally narrowed to an owned code. Verified in production on 2026-11-09: API key requests return 200 for the caller workspace.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
range query "1h" | "24h" | "7d" | "30d" | "90d" | "365d" | "today" | "yesterday" | "wtd" | "mtd" | "qtd" | "ytd" | "last_week" | "last_month" | "custom" — Reporting window. Custom bounds use from and to.
from query string — Window start as YYYY-MM-DD in tz, or an ISO timestamp.
to query string — Exclusive window end as YYYY-MM-DD in tz, or an ISO timestamp.
tz query string — IANA time zone for calendar boundaries; defaults to UTC.
granularity query "auto" | "minute" | "5min" | "hour" | "day" | "week" — Time bucket size; overly fine windows return 400.
compare query "0" | "1" | "true" | "false" — Include comparison when true or 1.
compareMode query "custom" | "previous" | "year" — Comparison baseline mode.
compareFrom query string — Custom comparison start.
compareTo query string — Custom comparison end.
includeBots query "0" | "1" | "true" | "false" — Include bots when true or 1; excluded by default.
includeInternal query "0" | "1" | "true" | "false" — Include internal visitors when true or 1; excluded by default.
botsOnly query "0" | "1" | "true" | "false" — Count only bots when true or 1.
botEngine query string — Shared analytics query control; applicability depends on the report.
code query string — Narrow to a code owned by this API key workspace; another workspace code returns 404.
workspaceId query string — Accepted by the shared validator but ignored on this mount. The API key always selects its own workspace.
country query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
city query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
region query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
device query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
os query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
browser query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
referrerHost query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitor query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
deviceModel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
language query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmMedium query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmCampaign query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
continent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorClass query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkType query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorBucket query "people" | "crawlers" | "automated" | "unknown" — Shared analytics query control; applicability depends on the report.
channel query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
networkOrg query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
asn query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
postalCode query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
visitorTimezone query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
anonymizer query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmTerm query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
utmContent query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
clickIdSource query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
host query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
outcome query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
variant query string — Segment clause: a bare value or an operator such as in:JO,AE, not:JO, contains:amm or isNull:.
limit query integer — Maximum rows for handlers that accept a row limit.
offset query integer — List page offset for handlers that paginate.
segmentId query string — Saved segment applied underneath explicit population and segment filters.
folderId query string — Accepted by the shared validator but ignored by the API key scope resolver.
tag query string — Accepted by the shared validator but ignored by the API key scope resolver.
contentType query string — Accepted by the shared validator but ignored by the API key scope resolver.
sort query "name" | "createdAt" | "visitors" | "conversions" | "scans" | "sessions" | "leads" | "codes" | "lastActivityAt" —

Responses

StatusDescription
200OK
400Invalid report query parameters. Shared analytics validation returns a JSON error envelope; public API validation can return a standard problem.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
405The reporting API is read-only. Authenticated requests with analytics:read using write methods return 405 before shared-factory handlers run.
429Per-key minute window exceeded.

Events

GET /events

List raw scan events

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
cursor query string —
limit query integer —
from query string (date-time) —
to query string (date-time) —
code query string —

Responses

StatusDescription
200OK

Public

POST /public/preview

Demo-only: ten-minute disposable short link

Auth: public

Request body (JSON)

NameTypeRequiredDescription
target_url string (uri) yes

Responses

StatusDescription
200Disposable short link + QR
429Per-key minute window exceeded.

GET /public/stats/{code}

Public scan stats for a link (no auth)

Auth: public

Parameters

NameInTypeRequiredDescription
code path string yes

Responses

StatusDescription
200OK
404Resource not found.
429Per-key minute window exceeded.

GET /public/preview/{codeAndExt}

QR image for a demo preview link

Renders the QR for a code created by `POST /public/preview`. Unauthenticated and rate-limited. The preview expires 10 minutes after creation, after which this returns 404.

Auth: public

Parameters

NameInTypeRequiredDescription
codeAndExt path string yes

Responses

StatusDescription
200QR image
404Resource not found.

GET /public/platform-stats

Aggregate platform counters

Lifetime totals powering the marketing site's live numbers. Unauthenticated, rate-limited, and served from a 5-minute cache - `cached: true` marks a response served from it. Scans are lifetime per-link counters, so the number never decreases as old scan events age out of retention.

Auth: public

Responses

StatusDescription
200OK

Folders

GET /folders

List folders

Every folder in the workspace, oldest first, each with the number of live codes filed in it.

Auth: BearerAuth

Responses

StatusDescription
200OK
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.

POST /folders

Create a folder

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
Idempotency-Key header string —

Request body (JSON)

NameTypeRequiredDescription
name string yes
color string —

Responses

StatusDescription
201Created
400Validation failed

PATCH /folders/{id}

Rename or recolour a folder

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes

Request body (JSON)

NameTypeRequiredDescription
name string —
color string —

Responses

StatusDescription
200OK
404Resource not found.

DELETE /folders/{id}

Delete a folder

The codes filed in it are NOT deleted. They become unfiled.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes

Responses

StatusDescription
204Deleted
404Resource not found.

Brand Kits

GET /brand-kits

List brand kits

Read all brand kits in the token's workspace. Requires the `links:read` scope.

Auth: BearerAuth

Responses

StatusDescription
200OK
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
429Per-key minute window exceeded.

GET /brand-kits/{id}

Get a brand kit

Read a brand kit in the token's workspace. Requires the `links:read` scope.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes Brand kit id (ULID).

Responses

StatusDescription
200OK
400Validation failed.
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
404Resource not found.
429Per-key minute window exceeded.

QR Designs

GET /qr-designs

List saved QR designs

Read all saved QR designs in the token's workspace. Requires the `links:read` scope.

Auth: BearerAuth

Responses

StatusDescription
200OK
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
429Per-key minute window exceeded.

Domains

GET /domains

List custom domains

Read custom domains in the token's workspace, including ownership status and usability. Requires the `links:read` scope. DNS verification challenges and records are omitted.

Auth: BearerAuth

Responses

StatusDescription
200OK
401Missing, malformed, expired, or revoked token.
403Token does not carry the required scope or IP.
429Per-key minute window exceeded.

Webhooks

GET /webhooks

List webhook subscriptions

Auth: BearerAuth

Responses

StatusDescription
200OK
401Missing, malformed, expired, or revoked token.

POST /webhooks

Create a webhook subscription

The `secret` is returned once; use it to verify the Qrindo-Signature header (t=...,v1=HMAC-SHA256("{t}.{rawBody}")).

Auth: BearerAuth

Request body (JSON)

NameTypeRequiredDescription
url string (uri) yes
events "scan.created" | "link.created" | "link.updated" | "link.deleted"[] yes
active boolean —

Responses

StatusDescription
201Created (secret returned once)
400Validation failed.
402Plan webhook limit reached

DELETE /webhooks/{id}

Delete a webhook subscription

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes

Responses

StatusDescription
204Deleted
404Resource not found.

POST /webhooks/{id}/test

Send a test delivery (webhook.test event)

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes

Responses

StatusDescription
200Queued

GET /webhooks/{id}/deliveries

List recent delivery attempts for a webhook

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes

Responses

StatusDescription
200OK
404Resource not found.

POST /deeplinks

Create a deeplink

Auth: BearerAuth

Request body (JSON)

NameTypeRequiredDescription
code string —
title string —
targets object —
active boolean —

Responses

StatusDescription
201Created
400Validation failed.

Sites

GET /sites

List sites

Every site in the workspace the API key belongs to. Not paginated.

Auth: BearerAuth

Responses

StatusDescription
200OK
401Missing, malformed, expired, or revoked token.

POST /sites

Create a site

Requires the `links:write` scope.

Auth: BearerAuth

Request body (JSON)

NameTypeRequiredDescription
name string yes
pack_key string — Unit template pack to seed labels and destinations from.
external_id string —
address string —

Responses

StatusDescription
201Created
400Validation failed.
401Missing, malformed, expired, or revoked token.

GET /sites/{id}

Get one site

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes Site id (ULID).

Responses

StatusDescription
200OK
404Resource not found.

GET /sites/{id}/units

List the units of a site

Returns units in fixed unit-number order, including any gaps left by deleted units, so a printed sheet keeps its numbering.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes Site id (ULID).

Responses

StatusDescription
200OK
404Resource not found.

POST /sites/{id}/units/batch

Create units in bulk

Creates up to 100 units and a link code for each. Per-unit success and failure are reported individually; the call itself returns 201 even when some units failed. Requires the `links:write` scope.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes Site id (ULID).

Request body (JSON)

NameTypeRequiredDescription
count integer —
start_at integer — First unit number. Defaults to the site's next free number.
label_pattern string — Label template, e.g. "Table {n}".
zone string —
destination object yes What every created unit points at. Same shape as a link's content.

Responses

StatusDescription
201Created (inspect `results` for per-unit outcomes)
400Validation failed.
404Resource not found.

GET /sites/{id}/leaderboard

Scan leaderboard for a site

Units ranked by scan count, plus the count of units never scanned.

Auth: BearerAuth

Parameters

NameInTypeRequiredDescription
id path string yes Site id (ULID).

Responses

StatusDescription
200OK
404Resource not found.

Conversions

POST /conversions

Report a conversion against a scan

Closes the loop on a scan. The redirect hands your destination a join key (`qr_click_id`); you hand a conversion back against it, and the scan that started it finally has an outcome. **Idempotency is the contract.** Every platform that sends conversion callbacks retries them - on a timeout, on a 500, on a deploy - and revenue that doubles on a retry is more dangerous than revenue that is missing: a missing number gets investigated, an inflated one gets believed. Send `external_id` (your own id for the conversion) and a replay answers `200` with `duplicate: true`, never an error you would queue and retry forever. Without it, a retry is indistinguishable from a second sale. **Send at least one join key** - `code`, `click_ref`, `session_id` or `visitor`. With none of them the conversion belongs to the workspace and to nothing inside it, which is a number that can be summed and never explained, so it is refused rather than accepted as an orphan. `value_cents` is in MINOR units and the field name says so: a field called `value` taking 12.50 from one integrator and 1250 from the next is a bug nobody can reproduce, and floating-point money is how a revenue report ends up fractionally wrong with nobody able to say why.

Auth: BearerAuth

Request body (JSON)

NameTypeRequiredDescription
code string — The short code. A code your key does not own is a 404, never someone else's attribution.
click_ref string — The `qr_click_id` the redirect appended to your destination URL.
session_id string —
visitor string —
kind string — Your name for this kind of conversion, e.g. `purchase`, `booking`.
value_cents integer — Minor units. 1250 is 12.50.
currency string — ISO 4217, three letters.
external_id string — Your id for this conversion. Send it - it is what makes a retry safe.
occurred_at string (date-time) — When it happened, if not now. ISO 8601.
metadata object —

Responses

StatusDescription
200Already recorded. The same `external_id` arrived before; this is the answer to a retry and carries the id of the conversion that already exists.
201Recorded
400No join key was sent, or the body failed validation.
404The code is not one this key's workspace owns.

OAuth

POST /oauth/token

Issue an access token

Client-credentials grant. Accepts `application/x-www-form-urlencoded` (per RFC 6749) or `application/json`; any other content type is 415. `client_credentials` is the only supported grant type. Errors use the OAuth `{error, error_description}` shape, NOT the RFC 9457 problem document the rest of this API returns.

Auth: public

Request body (JSON)

NameTypeRequiredDescription
grant_type "client_credentials" yes
client_id string yes
client_secret string yes
scope string —

Responses

StatusDescription
200Token issued
400Unsupported grant type
401Invalid client
415Unsupported content type

Try a request

The full reference above is part of this page. The interactive tester is a third-party bundle (Scalar), so it loads only when you ask for it. Click any endpoint inside it and use Test Request to send a real call.

Prefer the raw document? /openapi.yaml