Overview

Analytics APIs

Analytics APIs can be utilized to retrieve events via an HTTP request. By using these APIs, you can retrieve the following supported events mentioned in the next section.

Supported Events

Track Events
- track.add.success
- track.update.success
- track.remove.success
Recording Events
- beam.recording.success
Error Events
- client.publish.failed
- client.subscribe.failed
- client.join.failed
- client.disconnected
- client.connect.failed

Event data can be queried up to last 30 days.

What can I build?

You can use track events to get a better understanding of user activity and build tools around it as explained in use cases
You can use error events to dig deeper into the issues which your users are facing.


curl --location --request GET \
    'https://api.100ms.live/v2/analytics/events?room_id=<room_id>' \
    --header 'Authorization: Bearer <management_token>'

Allowed Filters

To be specified as query parameters

Name	Type	Description	Required
room_id	`string`	Unique identifier of the room you wish to fetch events for	yes
type	`string`	Any one or more of the supported event names. Can be specified multiple times to include more than one event (for example `type=track.add.success&` `type=track.update.success&` `type=client.publish.failed`). (Default: all supported events)	no
session_id	`string`	Unique session identifier (Can be found in using sessions APIs)	no
peer_id	`string`	Unique identifier of peer/participant	no
user_id	`string`	Filter events based on your internal user identifier	no
beam_id	`string`	This is relevant only when type=`beam.recording.success`. Specify this only when you want to look at recording events.	no
error	`bool`	Set this to true if you want to receive only the error events. (Default: false)
limit	`int`	Determines the number of event objects to be included in response (Default:`10`, Min: `1`, Max: `100`)	no
start	`string`	Specify next value from the last response to get next set of result.	no

Response Object

Attribute	Description
`limit`	Number of events in current response
`total`	Total number of events
`next`	Used to fetch next set of results, to be specified in the `start` query parameter in subsequent request. Next has non empty value only when there are more events to be queried.
`events`	List of events, refer individual event page for detailed structure of each event type.

Pagination

Results are paginated with default events count 10, extendable up to 100 by specifying it in limit query parameter.
If there are more events available then next will have a string value. This should be specified in the subsequent call as start query parameter to get further events.
Results are snapshot when query is executed for the first time, newer events (after first query) won’t appear while iterating results
Next results will expire after 24 hours from the first query time.

Postman collection

You can use our Postman collection to start exploring 100ms APIs.

Refer to the Postman guide to get started with 100ms API collection.

List sessions Track Events

Have a suggestion? Recommend changes ->