Events

Analytics_GetEventAttributeValues

SecuritybasicAuth
Request
path Parameters
bot_id
required
string
attribute_key
required
string
Request Body schema: application/json
required
query
string
Responses
200

A successful response.

Response Schema: application/json
Array of objects (TrackingEventAttribute)
Array
key
string
value
string
post/v1/bots/{bot_id}/events/attributes/{attribute_key}/values
Request samples
application/json
{ }
Response samples
application/json
{
  • "attributes": [
    • {
      }
    ]
}

Analytics_ListEventDefinitions

SecuritybasicAuth
Request
path Parameters
bot_id
required
string
query Parameters
page_token
string
page_size
integer <int32>
team_id
string
Responses
200

A successful response.

Response Schema: application/json
Array of objects (EventDefinition)
next_page_token
string
get/v1/bots/{bot_id}/events/definitions
Request samples 
Response samples 
application/json
{
  • "event_definitions": [
    • {
      }
    ],
  • "next_page_token": "string"
}
Analytics_CreateEventDefinition
SecuritybasicAuth 
Request 
path Parameters
bot_id
required
string
 
Request Body schema: application/json
required
event
string
 
description
string
 
team_id
string
 
Responses 
200
A successful response.


Response Schema: application/json
object (EventDefinition) 
 
id
string
 
team_id
string
 
bot_id
string
 
event
string
 
description
string
 
created_at
string <date-time> 
 
last_seen_at
string <date-time> 
 
volume_30_day
integer <int32> 
 
post/v1/bots/{bot_id}/events/definitions
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "event_definition": {
    • "id": "string",
    • "team_id": "string",
    • "bot_id": "string",
    • "event": "string",
    • "description": "string",
    • "created_at": "2019-08-24T14:15:22Z",
    • "last_seen_at": "2019-08-24T14:15:22Z",
    • "volume_30_day": 0
    }
}
Analytics_ComputeEventsFunnel
SecuritybasicAuth 
Request 
path Parameters
bot_id
required
string
 
Request Body schema: application/json
required
end_time
required
string
 
start_time
required
string
 
required
Array of objects (FunnelStep) 
 
version
required
string
 
breakdown_property
string
 
order_type
string (one of 'strict' or  'sequential') 
 Default:  "sequential"
 
Array of objects (FunnelStepFilter) 
 
Responses 
200
A successful response.


Response Schema: application/json
Array of objects (FunnelStepResultByCohort) 
 
 Array 
Array of objects (FunnelStepResult) 
 
 Array 
event_id
string
 
count
integer <int32> 
 
order
integer <int64> 
 
breakdown_value
string
 
post/v1/bots/{bot_id}/events/funnel
Request samples 
application/json
{
  • "version": "string",
  • "start_time": "string",
  • "end_time": "string",
  • "steps": [
    • { }
    ]
}
Response samples 
application/json
{
  • "result": [
    • {
      }
    ]
}
Analytics_ListEvents
SecuritybasicAuth 
Request 
path Parameters
bot_id
required
string
The ID of the bot


 
query Parameters
version
required
string
The version of the bot (either DRAFT or LIVE)


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


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


 
page_size
integer <int32> 
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_token
string
A page token, received from a previous ListEvent call.
Provide this to retrieve a subsequent page.


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


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


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


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


 
Responses 
200
A successful response.


Response Schema: application/json
Array of objects (TrackingEvent) 
 
next_page_token
string
 
get/v1/bots/{bot_id}/events/stream
Request samples 
Response samples 
application/json
{
  • "events": [
    • {
      }
    ],
  • "next_page_token": "string"
}
Analytics_ListEventsWithFilters
SecuritybasicAuth 
Request 
path Parameters
bot_id
required
string
The ID of the bot


 
Request Body schema: application/json
required
end_time
required
string
The ending date for the time range of the events, exclusive.


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


 
version
required
string (The version of the bot (either DRAFT or LIVE)) 
 
page_size
integer <int32> 
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_token
string
A page token, received from a previous ListEvent call.
Provide this to retrieve a subsequent page.


 
event
string (The event name to filter on. When provided, only occurences of that given event will be returned) 
 
conversation_id
string (The conversation to filter on. When provided, only events for the given conversation will be returned) 
 
user_id
string (The user to filter on. When provided, only events for the given user will be returned) 
 
campaign_id
string (The campaign to filter on. When provided, only events for the given campaign will be returned) 
 
Array of objects (AttributeFilter) 
 
Responses 
200
A successful response.


Response Schema: application/json
Array of objects (TrackingEvent) 
 
next_page_token
string
 
post/v1/bots/{bot_id}/events/stream
Request samples 
application/json
{
  • "version": "string",
  • "start_time": "string",
  • "end_time": "string"
}
Response samples 
application/json
{
  • "events": [
    • {
      }
    ],
  • "next_page_token": "string"
}
Analytics_TrackEvent
SecuritybasicAuth 
Request 
path Parameters
bot_id
required
string
 
Request Body schema: application/json
required
id
string
 
version
string
 
user_id
string
 
event
string
 
object
 
object (TrackEventRequestContext) 
 
timestamp
string <date-time> 
 
Responses 
200
A successful response.


Response Schema: application/json
event_id
string
 
post/v1/bots/{bot_id}/events/track
Request samples 
application/json
{ }
Response samples 
application/json
{
  • "event_id": "string"
}
Analytics_GetTeamEvents
SecuritybasicAuth 
Request 
path Parameters
team_id
required
string
 
query Parameters
start_time
required
string
The starting date for the time range of the events, inclusive.


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


 
user_id
string
The id of the customer


 
page_size
integer <int32> 
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_token
string
A page token, received from a previous ListEvent call.
Provide this to retrieve a subsequent page.


 
Responses 
200
A successful response.


Response Schema: application/json
Array of objects (TrackingEvent) 
 
next_page_token
string
 
get/v1/teams/{team_id}/events
Request samples 
Response samples 
application/json
{
  • "events": [
    • {
      }
    ],
  • "next_page_token": "string"
}
Analytics_ListTeamEventDefinitions
SecuritybasicAuth 
Request 
path Parameters
team_id
required
string
 
query Parameters
bot_id
string
 
page_token
string
 
page_size
integer <int32> 
 
Responses 
200
A successful response.


Response Schema: application/json
Array of objects (EventDefinition) 
 
next_page_token
string
 
get/v1/teams/{team_id}/events/definitions
Request samples 
Response samples 
application/json
{
  • "event_definitions": [
    • {
      }
    ],
  • "next_page_token": "string"
}
SecurityPrivacyLegal & ComplianceCookie Statement
© 2025 Sinch. All rights reserved.