You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: descriptions/0/api.intercom.io.yaml
+118Lines changed: 118 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -12383,6 +12383,88 @@ paths:
12383
12383
message: Whatsapp message not found
12384
12384
schema:
12385
12385
"$ref": "#/components/schemas/error"
12386
+
"/teams/{team_id}/metrics":
12387
+
get:
12388
+
summary: Retrieve team metrics
12389
+
parameters:
12390
+
- name: Intercom-Version
12391
+
in: header
12392
+
schema:
12393
+
"$ref": "#/components/schemas/intercom_version"
12394
+
- name: team_id
12395
+
in: path
12396
+
required: true
12397
+
description: The unique identifier of the team to retrieve metrics for. Use `GET /teams` to list available team IDs.
12398
+
example: "42"
12399
+
schema:
12400
+
type: string
12401
+
- name: idle_threshold
12402
+
in: query
12403
+
required: false
12404
+
description: The number of seconds after which an open conversation is considered idle. Clamped to the range 1–86400. Defaults to 1800 (30 minutes).
12405
+
schema:
12406
+
type: integer
12407
+
default: 1800
12408
+
example: 1800
12409
+
tags:
12410
+
- Monitoring
12411
+
operationId: getTeamMetrics
12412
+
description: |
12413
+
Returns real-time activity metrics for admins in the specified team. For each admin, the response includes counts of open, idle, and snoozed conversations.
12414
+
12415
+
This endpoint requires the `realtime_monitoring` feature to be enabled for your workspace.
12416
+
responses:
12417
+
'200':
12418
+
description: Successful response
12419
+
content:
12420
+
application/json:
12421
+
schema:
12422
+
$ref: "#/components/schemas/team_metric_list"
12423
+
examples:
12424
+
successful_response:
12425
+
value:
12426
+
type: team_metric.list
12427
+
data:
12428
+
- type: team_metric
12429
+
admin_id: "123"
12430
+
open: 5
12431
+
idle: 2
12432
+
snoozed: 1
12433
+
- type: team_metric
12434
+
admin_id: "456"
12435
+
open: 3
12436
+
idle: 0
12437
+
snoozed: 2
12438
+
'401':
12439
+
"$ref": "#/components/responses/Unauthorized"
12440
+
'403':
12441
+
description: Feature not enabled
12442
+
content:
12443
+
application/json:
12444
+
examples:
12445
+
feature_disabled:
12446
+
value:
12447
+
type: error.list
12448
+
request_id: "req-456"
12449
+
errors:
12450
+
- code: api_plan_restricted
12451
+
message: "Real-time monitoring is not enabled for your workspace."
12452
+
schema:
12453
+
"$ref": "#/components/schemas/error"
12454
+
'404':
12455
+
description: Team not found
12456
+
content:
12457
+
application/json:
12458
+
examples:
12459
+
team_not_found:
12460
+
value:
12461
+
type: error.list
12462
+
request_id: "req-789"
12463
+
errors:
12464
+
- code: team_not_found
12465
+
message: "Team not found"
12466
+
schema:
12467
+
"$ref": "#/components/schemas/error"
12386
12468
"/news/news_items":
12387
12469
get:
12388
12470
summary: List all news items
@@ -18600,6 +18682,40 @@ components:
18600
18682
"$ref": "#/components/schemas/customer_request"
18601
18683
required:
18602
18684
- email
18685
+
team_metric:
18686
+
type: object
18687
+
description: Per-admin activity metrics within a team.
18688
+
properties:
18689
+
type:
18690
+
type: string
18691
+
example: "team_metric"
18692
+
admin_id:
18693
+
type: string
18694
+
description: The unique identifier for the admin.
18695
+
example: "123"
18696
+
open:
18697
+
type: integer
18698
+
description: The number of open conversations assigned to the admin.
18699
+
example: 5
18700
+
idle:
18701
+
type: integer
18702
+
description: The number of idle conversations assigned to the admin. A conversation is idle when it has been open and waiting for an admin reply longer than the idle_threshold.
18703
+
example: 2
18704
+
snoozed:
18705
+
type: integer
18706
+
description: The number of snoozed conversations assigned to the admin.
18707
+
example: 1
18708
+
team_metric_list:
18709
+
type: object
18710
+
description: A list of team metrics.
18711
+
properties:
18712
+
type:
18713
+
type: string
18714
+
example: "team_metric.list"
18715
+
data:
18716
+
type: array
18717
+
items:
18718
+
$ref: "#/components/schemas/team_metric"
18603
18719
away_status_reason:
18604
18720
type: object
18605
18721
properties:
@@ -27387,6 +27503,8 @@ tags:
27387
27503
x-displayName: Macros
27388
27504
- name: Messages
27389
27505
description: Everything about your messages
27506
+
- name: Monitoring
27507
+
description: Real-time monitoring metrics for your workspace. Use these endpoints to track admin workload and conversation activity in real time.
0 commit comments