Data & privacy

Raw exports and GDPR requests.

Generated

This page is generated from api/openapi/v1.yaml (OpenAPI 3.1.0, API version 1.0.0).

Export raw events (NDJSON stream)

GET/v1/properties/{pid}/exports/events

Scope: export:read. Plan feature raw_export (Pro and above). At most 31 days per call; default: yesterday. One JSON object per line, IP addresses never included.

Parameters

Name	In	Type	Required	Description
pid	path	string	yes	Property id.
date_range	query	"last_7_days" | "last_28_days" | "last_90_days" | "this_month" | "last_month" | "yesterday" | "today"		Date preset. Ignored when start and end are given.
start	query	string
end	query	string

Responses

Status	Description
200	Events, one JSON object per line.
400	Invalid body or query (invalid_request), with errors[] for validation failures.
401	Missing, invalid, expired or revoked API key (unauthorized).
402	The plan does not include the feature (plan_required) or a monthly quota is used up (quota_exceeded). required_plan is the cheapest plan that unlocks it.
403	The key lacks the required scope (forbidden_scope).
404	Unknown endpoint, or a property / object that does not exist or is not accessible with this key (not_found).

GDPR access request — every event of a visitor or user

GET/v1/properties/{pid}/subjects/{id}

Scope: privacy:write. id is a visitor id or your business user id. Recorded in the privacy requests and the audit log.

Parameters

Name	In	Type	Required	Description
pid	path	string	yes	Property id.
id	path	string	yes	Visitor id or business user id.

Responses

Status	Description
200	Events, one JSON object per line.
400	Invalid body or query (invalid_request), with errors[] for validation failures.
401	Missing, invalid, expired or revoked API key (unauthorized).
403	The key lacks the required scope (forbidden_scope).
404	Unknown endpoint, or a property / object that does not exist or is not accessible with this key (not_found).

GDPR erasure request — delete every event of a visitor or user

DELETE/v1/properties/{pid}/subjects/{id}

Scope: privacy:write. Deletes raw events and the derived session and segment rows carrying the identifier.

Parameters

Name	In	Type	Required	Description
pid	path	string	yes	Property id.
id	path	string	yes	Visitor id or business user id.

Responses

Status	Description
200	Erased.
400	Invalid body or query (invalid_request), with errors[] for validation failures.
401	Missing, invalid, expired or revoked API key (unauthorized).
403	The key lacks the required scope (forbidden_scope).
404	Unknown endpoint, or a property / object that does not exist or is not accessible with this key (not_found).

Response fields

Field	Type	Required	Description
erased	boolean	yes
request_id	string	yes