> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Send Telemetry Events

> 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       |

## OpenAPI

````json POST /api/v1/statistics.telemetry
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "Statistics"
  },
  "servers": [
    {
      "url": "https://apiexplorer.support.rocket.chat"
    }
  ],
  "tags": [
    {
      "name": "Channels Engagement"
    },
    {
      "name": "Messages Engagement"
    },
    {
      "name": "Statistics"
    },
    {
      "name": "Users Engagement"
    }
  ],
  "paths": {
    "/api/v1/statistics.telemetry": {
      "post": {
        "tags": [
          "Statistics"
        ],
        "summary": "Send Telemetry Events",
        "description": "Send one or more telemetry events to the workspace. Each event increases a usage counter that is stored as a workspace setting.\n\nThe 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.\n\n### Changelog\n| Version | Description |\n| ------- | ----------- |\n| 4.6.0   | Added       |",
        "operationId": "post-api-v1-statistics.telemetry",
        "parameters": [
          {
            "$ref": "#/components/parameters/Auth-Token"
          },
          {
            "$ref": "#/components/parameters/UserId"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "params": {
                    "type": "array",
                    "description": "The list of telemetry events to send. Each event is an object.",
                    "items": {
                      "type": "object",
                      "properties": {
                        "eventName": {
                          "type": "string",
                          "description": "The event type. Either `slashCommandsStats` or `updateCounter`.",
                          "enum": [
                            "slashCommandsStats",
                            "updateCounter"
                          ],
                          "example": "slashCommandsStats"
                        },
                        "timestamp": {
                          "type": "number",
                          "description": "The time the event happened, as a Unix timestamp in milliseconds.",
                          "example": 1759920000000
                        },
                        "command": {
                          "type": "string",
                          "description": "The slash command that was run, without the leading `/`. Use with the `slashCommandsStats` event.\nThe `jitsi` command increases the `Jitsi_Start_SlashCommands_Count` setting by 1. Other commands return a success response but don't change any counter.",
                          "example": "jitsi"
                        },
                        "settingsId": {
                          "type": "string",
                          "description": "The ID of the counter setting to increase by 1. Use with the `updateCounter` event.",
                          "example": "Engagement_Dashboard_Load_Count"
                        }
                      },
                      "required": [
                        "eventName"
                      ]
                    },
                    "example": [
                      {
                        "eventName": "slashCommandsStats",
                        "command": "jitsi"
                      }
                    ]
                  }
                },
                "required": [
                  "params"
                ]
              },
              "examples": {
                "Slash Command Event": {
                  "value": {
                    "params": [
                      {
                        "eventName": "slashCommandsStats",
                        "timestamp": 1759920000000,
                        "command": "jitsi"
                      }
                    ]
                  }
                },
                "Settings Counter Event": {
                  "value": {
                    "params": [
                      {
                        "eventName": "updateCounter",
                        "settingsId": "Engagement_Dashboard_Load_Count"
                      }
                    ]
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "$ref": "#/components/responses/trueSuccess"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorType": {
                      "type": "string"
                    }
                  }
                },
                "examples": {
                  "Missing Params": {
                    "value": {
                      "success": false,
                      "error": "must have required property 'params'",
                      "errorType": "error-invalid-params"
                    }
                  },
                  "Invalid Params Type": {
                    "value": {
                      "success": false,
                      "error": "must be array",
                      "errorType": "error-invalid-params"
                    }
                  },
                  "Missing Event Name": {
                    "value": {
                      "success": false,
                      "error": "must have required property 'eventName'",
                      "errorType": "error-invalid-params"
                    }
                  },
                  "Invalid Timestamp Type": {
                    "value": {
                      "success": false,
                      "error": "must be number",
                      "errorType": "error-invalid-params"
                    }
                  },
                  "Unknown Body Property": {
                    "value": {
                      "success": false,
                      "error": "must NOT have additional properties",
                      "errorType": "error-invalid-params"
                    }
                  },
                  "Unknown Event": {
                    "value": {
                      "success": false,
                      "error": "event not found"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authorizationError"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "Auth-Token": {
        "name": "X-Auth-Token",
        "in": "header",
        "description": "The token of the authenticated user.",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "RScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f"
      },
      "UserId": {
        "name": "X-User-Id",
        "in": "header",
        "description": "The user ID of the authenticated user.",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "rbAXPnMktTFbNpwtJ"
      }
    },
    "responses": {
      "trueSuccess": {
        "description": "OK",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "success": {
                  "type": "boolean"
                }
              }
            },
            "examples": {
              "Example 1": {
                "value": {
                  "success": true
                }
              }
            }
          }
        }
      },
      "authorizationError": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "success": {
                  "type": "boolean"
                },
                "error": {
                  "type": "string"
                }
              }
            },
            "examples": {
              "Authorization Error": {
                "value": {
                  "success": false,
                  "error": "You must be logged in to do this."
                }
              }
            }
          }
        }
      }
    }
  }
}
````