Overview

Every route lives under /v2, for example https://api.analytics.remcostoeten.nl/v2/health. The live OpenAPI document is served at /v2/openapi/json, with interactive docs at /v2/openapi; the API reference on this site is generated from the same document.

ConventionsCopy Anchor Link

• Lists answer { data, nextCursor }; single resources answer { data }.
• Timestamps are ISO 8601 in UTC.
• Every response carries x-request-id.
• Aggregate reads of a public project are cached for 60 seconds (Cache-Control: public, s-maxage=60); everything else is private, no-store.
• Every list and breakdown also answers format=csv|json|sql (or Accept: text/csv) with the whole list as one download, up to 1 million rows.

Shared query parametersCopy Anchor Link

An unknown dimension answers 400 VALIDATION_FAILED, in breakdown/:dimension and in filter[<dimension>] alike.

Events the server client sends without a visitor or session share the id server. They count in pageviews, events and every breakdown of events, but never as a visitor or a session: visitors, sessions, bounce rate, session duration, pages per session, conversion rate, paths, retention, lifecycle, stickiness, the map's visitors, and the visitor, session and people lists leave them out.

ErrorsCopy Anchor Link

Every error uses one envelope:

{
  "error": {
    "code": "VALIDATION_FAILED",
    "message": "The request does not match the schema",
    "details": { "fields": [{ "path": "/period", "message": "Expected union value" }] },
    "requestId": "req_01J8Z3",
    "docs": "https://api.analytics.remcostoeten.nl/v2/openapi#errors/VALIDATION_FAILED"
  }
}