Skip to main content
POST
List analytics events

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body schema.

appUuid
string<uuid>
required

App whose analytics events to list.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
kinds
enum<string>[]

Event kinds to include.

Available options:
pageview,
error,
custom

Match against event name, pathname, or error message.

Required string length: 1 - 512
occurredAfter
string

Include events that occurred after this ISO timestamp.

occurredBefore
string

Include events that occurred before this ISO timestamp.

limit
integer
default:100

Maximum number of events to return.

Required range: 1 <= x <= 200
offset
integer
default:0

Number of events to skip.

Required range: 0 <= x <= 9007199254740991

Response

Successful response

events
Events · object[]
required

Analytics events matching the filters.