Restructure omni services and add Chatwoot research snapshot
This commit is contained in:
@@ -0,0 +1,39 @@
|
||||
type: array
|
||||
description: Agent summary report containing conversation statistics grouped by agent.
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
description: The agent (user) ID
|
||||
conversations_count:
|
||||
type: number
|
||||
description: Number of conversations assigned to the agent during the date range
|
||||
resolved_conversations_count:
|
||||
type: number
|
||||
description: Number of conversations resolved by the agent during the date range
|
||||
avg_resolution_time:
|
||||
type: number
|
||||
nullable: true
|
||||
description: Average time (in seconds) to resolve conversations. Null if no data available.
|
||||
avg_first_response_time:
|
||||
type: number
|
||||
nullable: true
|
||||
description: Average time (in seconds) for the first response. Null if no data available.
|
||||
avg_reply_time:
|
||||
type: number
|
||||
nullable: true
|
||||
description: Average time (in seconds) between replies. Null if no data available.
|
||||
example:
|
||||
- id: 1
|
||||
conversations_count: 150
|
||||
resolved_conversations_count: 120
|
||||
avg_resolution_time: 3600
|
||||
avg_first_response_time: 300
|
||||
avg_reply_time: 600
|
||||
- id: 2
|
||||
conversations_count: 75
|
||||
resolved_conversations_count: 60
|
||||
avg_resolution_time: 1800
|
||||
avg_first_response_time: 180
|
||||
avg_reply_time: 420
|
||||
@@ -0,0 +1,34 @@
|
||||
type: object
|
||||
description: Channel summary report containing conversation counts grouped by channel type and status. Available in version 4.10.0+.
|
||||
additionalProperties:
|
||||
type: object
|
||||
description: Conversation statistics for a specific channel type (e.g., Channel::WebWidget, Channel::Api)
|
||||
properties:
|
||||
open:
|
||||
type: number
|
||||
description: Number of open conversations
|
||||
resolved:
|
||||
type: number
|
||||
description: Number of resolved conversations
|
||||
pending:
|
||||
type: number
|
||||
description: Number of pending conversations
|
||||
snoozed:
|
||||
type: number
|
||||
description: Number of snoozed conversations
|
||||
total:
|
||||
type: number
|
||||
description: Total number of conversations
|
||||
example:
|
||||
Channel::WebWidget:
|
||||
open: 10
|
||||
resolved: 20
|
||||
pending: 5
|
||||
snoozed: 2
|
||||
total: 37
|
||||
Channel::Api:
|
||||
open: 5
|
||||
resolved: 15
|
||||
pending: 3
|
||||
snoozed: 1
|
||||
total: 24
|
||||
@@ -0,0 +1,19 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
name:
|
||||
type: string
|
||||
email:
|
||||
type: string
|
||||
thumbnail:
|
||||
type: string
|
||||
availability:
|
||||
type: string
|
||||
metric:
|
||||
type: object
|
||||
properties:
|
||||
open:
|
||||
type: number
|
||||
unattended:
|
||||
type: number
|
||||
@@ -0,0 +1,34 @@
|
||||
type: object
|
||||
description: First response time distribution report grouped by channel type. Shows the count of conversations with first response times in different time buckets.
|
||||
additionalProperties:
|
||||
type: object
|
||||
description: First response time distribution for a specific channel type (e.g., Channel::WebWidget, Channel::Api)
|
||||
properties:
|
||||
0-1h:
|
||||
type: number
|
||||
description: Number of conversations with first response time less than 1 hour
|
||||
1-4h:
|
||||
type: number
|
||||
description: Number of conversations with first response time between 1-4 hours
|
||||
4-8h:
|
||||
type: number
|
||||
description: Number of conversations with first response time between 4-8 hours
|
||||
8-24h:
|
||||
type: number
|
||||
description: Number of conversations with first response time between 8-24 hours
|
||||
24h+:
|
||||
type: number
|
||||
description: Number of conversations with first response time greater than 24 hours
|
||||
example:
|
||||
Channel::WebWidget:
|
||||
0-1h: 150
|
||||
1-4h: 80
|
||||
4-8h: 45
|
||||
8-24h: 30
|
||||
24h+: 15
|
||||
Channel::Api:
|
||||
0-1h: 75
|
||||
1-4h: 40
|
||||
4-8h: 20
|
||||
8-24h: 10
|
||||
24h+: 5
|
||||
@@ -0,0 +1,50 @@
|
||||
type: object
|
||||
description: Inbox-label matrix report showing the count of conversations for each inbox-label combination.
|
||||
properties:
|
||||
inboxes:
|
||||
type: array
|
||||
description: List of inboxes included in the report
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
description: The inbox ID
|
||||
name:
|
||||
type: string
|
||||
description: The inbox name
|
||||
labels:
|
||||
type: array
|
||||
description: List of labels included in the report
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
description: The label ID
|
||||
title:
|
||||
type: string
|
||||
description: The label title
|
||||
matrix:
|
||||
type: array
|
||||
description: 2D array where matrix[i][j] represents the count of conversations in inboxes[i] with labels[j]
|
||||
items:
|
||||
type: array
|
||||
items:
|
||||
type: number
|
||||
example:
|
||||
inboxes:
|
||||
- id: 1
|
||||
name: Website Chat
|
||||
- id: 2
|
||||
name: Email Support
|
||||
labels:
|
||||
- id: 1
|
||||
title: bug
|
||||
- id: 2
|
||||
title: feature-request
|
||||
- id: 3
|
||||
title: urgent
|
||||
matrix:
|
||||
- [10, 5, 3]
|
||||
- [8, 12, 2]
|
||||
@@ -0,0 +1,39 @@
|
||||
type: array
|
||||
description: Inbox summary report containing conversation statistics grouped by inbox.
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
description: The inbox ID
|
||||
conversations_count:
|
||||
type: number
|
||||
description: Number of conversations created in the inbox during the date range
|
||||
resolved_conversations_count:
|
||||
type: number
|
||||
description: Number of conversations resolved in the inbox during the date range
|
||||
avg_resolution_time:
|
||||
type: number
|
||||
nullable: true
|
||||
description: Average time (in seconds) to resolve conversations. Null if no data available.
|
||||
avg_first_response_time:
|
||||
type: number
|
||||
nullable: true
|
||||
description: Average time (in seconds) for the first response. Null if no data available.
|
||||
avg_reply_time:
|
||||
type: number
|
||||
nullable: true
|
||||
description: Average time (in seconds) between replies. Null if no data available.
|
||||
example:
|
||||
- id: 1
|
||||
conversations_count: 150
|
||||
resolved_conversations_count: 120
|
||||
avg_resolution_time: 3600
|
||||
avg_first_response_time: 300
|
||||
avg_reply_time: 600
|
||||
- id: 2
|
||||
conversations_count: 75
|
||||
resolved_conversations_count: 60
|
||||
avg_resolution_time: 1800
|
||||
avg_first_response_time: 180
|
||||
avg_reply_time: 420
|
||||
@@ -0,0 +1,21 @@
|
||||
type: array
|
||||
description: Outgoing messages count report grouped by entity (agent, team, inbox, or label).
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
description: The ID of the grouped entity (agent, team, inbox, or label).
|
||||
name:
|
||||
type: string
|
||||
description: The name of the grouped entity.
|
||||
outgoing_messages_count:
|
||||
type: number
|
||||
description: The total number of outgoing messages for this entity in the given time range.
|
||||
example:
|
||||
- id: 1
|
||||
name: Agent One
|
||||
outgoing_messages_count: 42
|
||||
- id: 2
|
||||
name: Agent Two
|
||||
outgoing_messages_count: 18
|
||||
@@ -0,0 +1,29 @@
|
||||
type: object
|
||||
properties:
|
||||
avg_first_response_time:
|
||||
type: string
|
||||
avg_resolution_time:
|
||||
type: string
|
||||
conversations_count:
|
||||
type: number
|
||||
incoming_messages_count:
|
||||
type: number
|
||||
outgoing_messages_count:
|
||||
type: number
|
||||
resolutions_count:
|
||||
type: number
|
||||
previous:
|
||||
type: object
|
||||
properties:
|
||||
avg_first_response_time:
|
||||
type: string
|
||||
avg_resolution_time:
|
||||
type: string
|
||||
conversations_count:
|
||||
type: number
|
||||
incoming_messages_count:
|
||||
type: number
|
||||
outgoing_messages_count:
|
||||
type: number
|
||||
resolutions_count:
|
||||
type: number
|
||||
@@ -0,0 +1,39 @@
|
||||
type: array
|
||||
description: Team summary report containing conversation statistics grouped by team.
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
description: The team ID
|
||||
conversations_count:
|
||||
type: number
|
||||
description: Number of conversations assigned to the team during the date range
|
||||
resolved_conversations_count:
|
||||
type: number
|
||||
description: Number of conversations resolved by the team during the date range
|
||||
avg_resolution_time:
|
||||
type: number
|
||||
nullable: true
|
||||
description: Average time (in seconds) to resolve conversations. Null if no data available.
|
||||
avg_first_response_time:
|
||||
type: number
|
||||
nullable: true
|
||||
description: Average time (in seconds) for the first response. Null if no data available.
|
||||
avg_reply_time:
|
||||
type: number
|
||||
nullable: true
|
||||
description: Average time (in seconds) between replies. Null if no data available.
|
||||
example:
|
||||
- id: 1
|
||||
conversations_count: 250
|
||||
resolved_conversations_count: 200
|
||||
avg_resolution_time: 2800
|
||||
avg_first_response_time: 240
|
||||
avg_reply_time: 500
|
||||
- id: 2
|
||||
conversations_count: 180
|
||||
resolved_conversations_count: 150
|
||||
avg_resolution_time: 2400
|
||||
avg_first_response_time: 200
|
||||
avg_reply_time: 450
|
||||
Reference in New Issue
Block a user