Send one or more telemetry events to the workspace. Each event increases a usage counter that is stored as a workspace setting.
The workspace processes the events in the order you send them. If an event has an unknown eventName, the request fails with event not found, but the events before it in the list are still processed.
Changelog
| Version | Description |
|---|---|
| 4.6.0 | Added |
The token of the authenticated user.
The user ID of the authenticated user.
{
"params": [
{
"eventName": "slashCommandsStats",
"timestamp": 1759920000000,
"command": "jitsi"
}
]
}{
"params": [
{
"eventName": "updateCounter",
"settingsId": "Engagement_Dashboard_Load_Count"
}
]
}The list of telemetry events to send. Each event is an object.
The event type. Either slashCommandsStats or updateCounter.
The time the event happened, as a Unix timestamp in milliseconds.
The slash command that was run, without the leading /. Use with the slashCommandsStats event.
The jitsi command increases the Jitsi_Start_SlashCommands_Count setting by 1. Other commands return a success response but don't change any counter.
The ID of the counter setting to increase by 1. Use with the updateCounter event.
OK
{
"success": true
}Bad Request
{
"success": false,
"error": "must have required property 'params'",
"errorType": "error-invalid-params"
}{
"success": false,
"error": "must be array",
"errorType": "error-invalid-params"
}{
"success": false,
"error": "must have required property 'eventName'",
"errorType": "error-invalid-params"
}{
"success": false,
"error": "must be number",
"errorType": "error-invalid-params"
}{
"success": false,
"error": "must NOT have additional properties",
"errorType": "error-invalid-params"
}{
"success": false,
"error": "event not found"
}Unauthorized
{
"success": false,
"error": "You must be logged in to do this."
}