Retrieve team metrics

Request

Returns real-time activity metrics for admins in the specified team. For each admin, the response includes counts of open, idle, and snoozed conversations.

This endpoint requires the realtime_monitoring feature to be enabled for your workspace.

Security

bearerAuth

Path

team_idstringrequired

The unique identifier of the team to retrieve metrics for. Use GET /teams to list available team IDs.

Example:42

Query

idle_thresholdinteger

The number of seconds after which an open conversation is considered idle. Clamped to the range 1–86400. Defaults to 1800 (30 minutes).

Default:1800

Example:idle_threshold=1800

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default:"Preview"

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

curl -i -X GET \
  'https://api.intercom.io/teams/42/metrics?idle_threshold=1800' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: Preview'

Responses

Successful response

Bodyapplication/json

typestring

Example:"team_metric.list"

dataArray of objects(team_metric)

Response

{
  "type": "team_metric.list",
  "data": [
    { … },
    { … }
  ]
}