List events

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 endpoints 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. 401 without a validated bearer, 503 when the warehouse is unreachable.

Request

1 field.

FieldInTypeRequiredDescription
limitqueryinteger—Limit is how many rows to return, newest first.

Response

StatusBodyMeaning
200event.eventListok
defaultproblem-detailsrefused

200 body — 11 fields.

FieldInTypeAlwaysDescription
databodyevent.productEvent[]—Data is the events, newest first.
data[].distinctIdbodystring—DistinctID is the person/visitor the event is attributed to.
data[].eventbodystring—Event is the event name, e.g. page_viewed or signup_completed.
data[].idbodystring—ID is the row's stable event id — the client's own idempotency id when it sent one, else the server-minted one.
data[].pathbodystring—Path is the URL's path component, the key the topPages lens groups by.
data[].productbodystring—Product is the surface that emitted the event.
data[].propertiesbodyany—Properties 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 JSON-encoded string).
data[].sessionIdbodystring—SessionID groups the events of one visit.
data[].timestampbodystring—Timestamp is when the event happened, RFC3339 UTC.
data[].typebodystring—Type is the row's kind — the plane's discriminator: page, track, identify or group.
data[].urlbodystring—URL is the full page address the event fired on.

Failure carries the platform error shape — see Errors.

Examples

hanzo event insights events
import { Configuration, EventApi } from 'hanzoai';

const api = new EventApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getEventInsightsEvents();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import EventApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = EventApi(client).get_event_insights_events()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.EventAPI.GetEventInsightsEvents(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, event_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = event_api::get_event_insights_events(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.EventApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new EventApi(client).getEventInsightsEvents();
curl https://api.hanzo.ai/v1/event/insights/events \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches event through the event tool, which names its 9 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_event_economic"
         }
       }
     }'

Event API · All Hanzo APIs · Interactive reference

Was this page useful?