Intercom API (unofficial showcase)
GET/teams/{team_id}/metrics

Get real-time team activity metrics

Retrieves real-time activity metrics for admins in a specified team, including counts of open, idle, and snoozed conversations. The realtime_monitoring feature must be enabled for the workspace; use idle_threshold to set when an open conversation counts as idle.

3 parameters
team_idstringrequired
The unique identifier of the team to retrieve metrics for.
idle_thresholdintegeroptional
The number of seconds after which an open conversation is considered idle. Clamped to 1–86400 seconds. Defaults to 1800 seconds when omitted.
Default:1800
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

4 status codes
200Returns per-admin activity metrics for the team, including counts of open, idle, and snoozed conversations.
typestringoptional
dataarray<object>optional
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
403Returned when the workspace does not have the realtime_monitoring feature enabled.

One documented failure

  • api_plan_restricted

    Real-time monitoring is not enabled for your workspace.

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the team does not exist.

One documented failure

  • team_not_found

    Team not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 403 is returned when the realtime_monitoring feature is not enabled, and a 404 is returned when no team exists with the given team_id path parameter. idle_threshold is clamped to the range 1–86400 seconds and defaults to 1800 when omitted.