Skip to main content

Get user events

Retrieve events associated with a specific user.

Query Parameters
bot string

The ID of the bot

userId string REQUIRED

The unique ID of the user generated internally. This is usually in the format {botId_userId}

eventName string

The name of the event. Use this parameter to filter results by event name.

offsetTimestamp string

The offset timestamp (ISO format) from which to start retrieving events. Use this parameter to paginate through event results.

limit integer

The maximum number of events to retrieve per request. Use this parameter for result pagination and limiting the response size.

Responses
200

Successful response with a list of user events

Schema OPTIONAL
message string OPTIONAL

Message indicating the response status

data object[] OPTIONAL

List of user events

id string OPTIONAL

The ID of the event

botId string OPTIONAL

The ID of the bot

userId string OPTIONAL

The user's unique ID

event string OPTIONAL

The name of the event

source string OPTIONAL

The source of the event

payload object OPTIONAL
timestamp number OPTIONAL

The timestamp of the event

user object OPTIONAL
city string OPTIONAL

The user's city

country string OPTIONAL

The user's country code

firstName string OPTIONAL

The user's first name

gender string OPTIONAL

The user's gender

lastName string OPTIONAL

The user's last name

profileComplete string OPTIONAL

The completeness of the user's profile

userId string OPTIONAL

The user's unique ID

createdAt date-time OPTIONAL

The creation timestamp of the event

updatedAt date-time OPTIONAL

The last update timestamp of the event

400

Bad Request

Schema OPTIONAL
error string OPTIONAL

Error details

401

Unauthorized request or invalid X-Auth-Token or botId

406

Not Acceptable

500

Internal Server Error

Schema OPTIONAL
error string OPTIONAL

Error details