Restructure omni services and add Chatwoot research snapshot
This commit is contained in:
@@ -0,0 +1,23 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: get-agent-summary-report
|
||||
summary: Get conversation statistics grouped by agent
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: |
|
||||
Get conversation statistics grouped by agent for a given date range.
|
||||
Returns metrics for each agent including conversation counts, resolution counts,
|
||||
average first response time, average resolution time, and average reply time.
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/agent_summary'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,30 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: get-channel-summary-report
|
||||
summary: Get conversation statistics grouped by channel type
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: |
|
||||
Get conversation counts grouped by channel type and status for a given date range.
|
||||
Returns statistics for each channel type including open, resolved, pending, snoozed, and total conversation counts.
|
||||
|
||||
**Note:** This API endpoint is available only in Chatwoot version 4.10.0 and above. The date range is limited to a maximum of 6 months.
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/channel_summary'
|
||||
'400':
|
||||
description: Date range exceeds 6 months limit
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,34 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: get-account-conversation-metrics
|
||||
summary: Account Conversation Metrics
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: Get conversation metrics for Account
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
description: 'Object of account conversation metrics'
|
||||
properties:
|
||||
open:
|
||||
type: number
|
||||
unattended:
|
||||
type: number
|
||||
unassigned:
|
||||
type: number
|
||||
'404':
|
||||
description: reports not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,29 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: get-agent-conversation-metrics
|
||||
summary: Agent Conversation Metrics
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: Get conversation metrics for Agent
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
description: 'Array of agent based conversation metrics'
|
||||
items:
|
||||
$ref: '#/components/schemas/agent_conversation_metrics'
|
||||
'404':
|
||||
description: reports not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,24 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: get-first-response-time-distribution
|
||||
summary: Get first response time distribution by channel
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: |
|
||||
Get the distribution of first response times grouped by channel type.
|
||||
Returns conversation counts in different time buckets (0-1h, 1-4h, 4-8h, 8-24h, 24h+) for each channel type.
|
||||
|
||||
**Note:** This API endpoint is available only in Chatwoot version 4.11.0 and above.
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/first_response_time_distribution'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,25 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: get-inbox-label-matrix
|
||||
summary: Get inbox-label matrix report
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: |
|
||||
Get a matrix showing the count of conversations for each inbox-label combination.
|
||||
Returns a list of inboxes, labels, and a 2D matrix where each cell contains the count of conversations
|
||||
in a specific inbox that have a specific label applied.
|
||||
|
||||
**Note:** This API endpoint is available only in Chatwoot version 4.11.0 and above.
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/inbox_label_matrix'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,23 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: get-inbox-summary-report
|
||||
summary: Get conversation statistics grouped by inbox
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: |
|
||||
Get conversation statistics grouped by inbox for a given date range.
|
||||
Returns metrics for each inbox including conversation counts, resolution counts,
|
||||
average first response time, average resolution time, and average reply time.
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/inbox_summary'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,34 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: list-all-conversation-statistics
|
||||
summary: Get Account reports
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: Get Account reports for a specific type, metric and date range
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
description: 'Array of date based conversation statistics'
|
||||
items:
|
||||
type: object
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
timestamp:
|
||||
type: number
|
||||
'404':
|
||||
description: reports not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,36 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: get-outgoing-messages-count
|
||||
summary: Get outgoing messages count grouped by entity
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: |
|
||||
Get the count of outgoing messages grouped by a specified entity (agent, team, inbox, or label).
|
||||
When grouped by agent, messages sent by bots (AgentBot, Captain::Assistant) are excluded.
|
||||
|
||||
**Note:** This API endpoint is available only in Chatwoot version 4.11.0 and above.
|
||||
parameters:
|
||||
- in: query
|
||||
name: group_by
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
enum:
|
||||
- agent
|
||||
- team
|
||||
- inbox
|
||||
- label
|
||||
description: The entity to group outgoing message counts by.
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/outgoing_messages_count'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,27 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: list-all-conversation-statistics-summary
|
||||
summary: Get Account reports summary
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: Get Account reports summary for a specific type and date range
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
description: 'Object of summary metrics'
|
||||
$ref: '#/components/schemas/account_summary'
|
||||
'404':
|
||||
description: reports not found
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
@@ -0,0 +1,23 @@
|
||||
tags:
|
||||
- Reports
|
||||
operationId: get-team-summary-report
|
||||
summary: Get conversation statistics grouped by team
|
||||
security:
|
||||
- userApiKey: []
|
||||
description: |
|
||||
Get conversation statistics grouped by team for a given date range.
|
||||
Returns metrics for each team including conversation counts, resolution counts,
|
||||
average first response time, average resolution time, and average reply time.
|
||||
responses:
|
||||
'200':
|
||||
description: Success
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/team_summary'
|
||||
'403':
|
||||
description: Access denied
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/bad_request_error'
|
||||
Reference in New Issue
Block a user