Event Schemas
Event schemas define the analytics events that should be tracked during agent sessions. Attach a schema to an experiment to verify that the correct events fire during user journeys.
Paste your API key to use the Try it panels below. Don't have one? Create an account.
POST
/api/v1/event-schemas Create a new event schema| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
project_id | uuid | body | Yes | ID of the project |
name | string | body | Yes | Schema name |
platform | string | body | No | Analytics platform identifier |
credentials | json | body | No | Platform credentials for event verification |
domains | json | body | No | Domains to monitor for events |
events | json | body | No | Expected event definitions |
cURL
Response
GET
/api/v1/event-schemas List event schemas| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
limit | integer | query | No | Number of results to return (default: 20) |
cursor | uuid | query | No | Cursor for pagination |
project | uuid | query | No | Filter by project ID |
cURL
Response
GET
/api/v1/event-schemas/{id} Get event schema by ID| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
id | uuid | path | Yes | Event schema ID |
cURL
Response
PATCH
/api/v1/event-schemas/{id} Update an event schema| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
id | uuid | path | Yes | Event schema ID |
name | string | body | No | Schema name |
credentials | json | body | No | Platform credentials |
domains | json | body | No | Domains to monitor |
events | json | body | No | Expected event definitions |
cURL
Response
DELETE
/api/v1/event-schemas/{id} Delete an event schema| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
id | uuid | path | Yes | Event schema ID |
cURL
Response