Events
Operations around Events and Event data.
Endpoints
GET /api/websites/:websiteId/events
GET /api/websites/:websiteId/event-data/events
GET /api/websites/:websiteId/event-data/fields
GET /api/websites/:websiteId/event-data/values
GET /api/websites/:websiteId/event-data/statsGET /api/websites/:websiteId/events
Gets website event details within a given time range.
Parameters
startAt: Timestamp (in ms) of starting date.endAt: Timestamp (in ms) of end date.query: (string | string) Search text.page: (number | optional, default 1) Determines page.pageSize: (string | optional) Determines how many results to return.orderBy: (string | optional) Order by column name.
Sample response
{
"data": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"websiteId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"sessionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"createdAt": "0000-00-00T00:00:00Z",
"urlPath": "/docs/api/authentication",
"urlQuery": "",
"referrerPath": "/docs/api",
"referrerQuery": "",
"referrerDomain": "",
"pageTitle": "Overview – Umami",
"eventType": 1,
"eventName": ""
},
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"websiteId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"sessionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"createdAt": "0000-00-00T00:00:00Z",
"urlPath": "/",
"urlQuery": "utm_source=apollo&utm_medium=outbound-email&utm_campaign=founders",
"referrerPath": "",
"referrerQuery": "",
"referrerDomain": "",
"pageTitle": "Umami",
"eventType": 1,
"eventName": ""
}
],
"count": 1000,
"page": 1,
"pageSize": 20
}GET /api/websites/:websiteId/event-data/events
Gets event data names, properties, and counts
Parameters
startAt: Timestamp (in ms) of starting date.endAt: Timestamp (in ms) of end date.event: (optional) Event name filter.
Sample response
[
{
"eventName": "button-click",
"propertyName": "id",
"dataType": 1,
"total": 4
},
{
"eventName": "button-click",
"propertyName": "name",
"dataType": 1,
"total": 4
},
{
"eventName": "track-product",
"propertyName": "price",
"dataType": 2,
"total": 2
}
]GET /api/websites/:websiteId/event-data/fields
Gets event data property and value counts within a given time range.
Parameters
websiteId: (uuid) Website key identifier.startAt: Timestamp (in ms) of starting date.endAt: Timestamp (in ms) of end date.
Sample response
[
{
"propertyName": "age",
"dataType": 2,
"value": "33",
"total": 1
},
{
"propertyName": "age",
"dataType": 2,
"value": "31",
"total": 4
},
{
"propertyName": "gender",
"dataType": 1,
"value": "female",
"total": 4
},
{
"propertyName": "gender",
"dataType": 1,
"value": "male",
"total": 1
}
]GET /api/websites/:websiteId/event-data/values
Gets event data counts for a given event and property
Parameters
startAt: Timestamp (in ms) of starting date.endAt: Timestamp (in ms) of end date.eventName: Event name.propertyName: Property name.
Sample response
[
{ "value": "female", "total": 4 },
{ "value": "male", "total": 1 }
]GET /api/websites/:websiteId/event-data/stats
Gets summarized website events, fields, and records within a given time range.
Parameters
startAt: Timestamp (in ms) of starting date.endAt: Timestamp (in ms) of end date.
Sample response
[
{
"events": 16,
"fields": 13,
"records": 26
}
]