latestOpenAPI 3.0.12026-08-10314983.7 KB

a276d2543838

Events

get/v1/bots/{bot_id}/events/stream

Path parameters

bot_idstring required

The ID of the bot

Query parameters

versionstring required

The version of the bot (either DRAFT or LIVE)

page_sizeinteger

The maximum number of events to return. The service may return fewer than this value. The maximum value allowed is 100; value above 100 will be coerced to 100.

page_tokenstring

A page token, received from a previous ListEvent call. Provide this to retrieve a subsequent page.

start_timestring required

The starting date for the time range of the events, inclusive.

end_timestring required

The ending date for the time range of the events, exclusive.

eventstring

The event name to filter on. When provided, only occurences of that given event will be returned

conversation_idstring

The conversation to filter on. When provided, only events for the given conversation will be returned

user_idstring

The user to filter on. When provided, only events for the given user will be returned

campaign_idstring

The campaign to filter on. When provided, only events for the given campaign will be returned

Response

A successful response.

next_page_tokenstring