Hanzo
OpenapiEvent

Returns the caller org's most recent product events, newest first.

Returns the caller org's most recent product events, newest first.

GET /v1/event/insights/events

Addresshttps://api.hanzo.ai/v1/event/insights/events
MethodGET
Operationget_event_insights_events
AuthAuthorization: Bearer $HANZO_API_KEY

Returns the caller org's most recent product events, newest first. The console's raw-event view over event.event — the same table the capture doors fill — one row per stored event, with the row's attributes returned as the properties object.

The org is the validated principal's — never a parameter — and a read requires a real bearer, never the write-only publishable key. 403 without a validated bearer, 503 when the warehouse is unreachable.

Request

1 field.

FieldInTypeRequiredDescription
limitqueryintegerLimit is how many rows to return, newest first.

Response

StatusBodyMeaning
200eventListok

200 body — 11 fields.

FieldInTypeAlwaysDescription
databodyproductEvent[]Data is the events, newest first.
data[].distinctIdbodystringDistinctID is the person/visitor the event is attributed to.
data[].eventbodystringEvent is the event name, e.g.
data[].idbodystringID is the row's stable event id — the client's own idempotency id when it sent one, else the server-minted one.
data[].pathbodystringPath is the URL's path component, the key the topPages lens groups by.
data[].productbodystringProduct is the surface that emitted the event.
data[].propertiesbodyanyProperties is the row's attributes map as a JSON object (string values — the plane stores Map(String,String), so a nested value the caller sent is a…
data[].sessionIdbodystringSessionID groups the events of one visit.
data[].timestampbodystringTimestamp is when the event happened, RFC3339 UTC.
data[].typebodystringType is the row's kind — the plane's discriminator: page, track, identify or group.
data[].urlbodystringURL is the full page address the event fired on.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Event API · All Hanzo APIs · Interactive reference

How is this guide?

On this page