Integration

REST API

Read your own analytics, replays and heatmap data from your own tools.

Base URL

Every endpoint lives under /api/v1 on your Seentics host. On the hosted service that is:

text

https://app.seentics.com/api/v1

Self-hosting? Use your own origin. The path is the same.

Authentication

Send your API key in an X-API-Key header. Every request needs one — there are no unauthenticated read endpoints.

bash

curl -H "X-API-Key: $SEENTICS_API_KEY" \
  "https://app.seentics.com/api/v1/raw/v1/catalogue"

Not a Bearer token

Earlier versions of these docs showed Authorization: Bearer YOUR_API_KEY. The server does not accept that and will answer 401. Use X-API-Key.

See API keys for creating one and choosing its scopes.

The endpoint catalogue

Rather than a list here that can fall behind the server, Seentics publishes its own catalogue. Every endpoint, its parameters, its required scope and a copy-paste curl example are generated from the router itself.

GET/api/v1/raw/v1/catalogue

The full list of readable endpoints, with parameters and scopes. Requires a key.

The dashboard renders the same catalogue for you, already filled in with your website ID. Open Developers → API reference on any site — that is the authoritative list, and it cannot describe an endpoint that no longer exists.

Why it lives there and not here

A hand-written endpoint table in docs drifts the moment a route changes, and this one had. Generating it from the router is the only version that stays true.

What is available

The API is grouped by module. These are the mount points; the catalogue has the endpoints under each.

Group	Path prefix	Covers
`raw`	`/api/v1/raw`	Raw events, heatmap points and recording metadata — the reporting surface most integrations want.
`analytics`	`/api/v1/analytics`	Aggregated traffic, sources, devices and geography.
`funnels`	`/api/v1/funnels`	Funnel definitions and their step metrics.
`automations`	`/api/v1/automations`	Automation definitions and execution stats.
`replays`	`/api/v1/replays`	Session lists and recording payloads.
`heatmaps`	`/api/v1/heatmaps`	Click and scroll data per page.
`websites`	`/api/v1/websites`	Your sites, and the API keys attached to them.
`privacy`	`/api/v1/privacy`	Reserved — returns 501, not yet implemented.

Errors

Errors come back as JSON with an error field and the matching HTTP status.

json

{ "error": "Authorization header required" }

401 — no key, or a key the server does not recognise.
403 — the key is valid but lacks the scope for that endpoint, or is scoped to a different website.
404 — no such website, funnel, session or automation.
429 — rate limited. Back off and retry.