Skip to main content
GET
/
api
/
v2
/
accounts
/
{account_id}
/
reports
/
inbox_label_matrix
Get inbox-label matrix report
curl --request GET \
  --url https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix \
  --header 'api_access_token: <api-key>'
{
  "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
    ]
  ]
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
account_id
integer
required

The numeric ID of the account

Query Parameters

​
since
string

The timestamp from where report should start (Unix timestamp).

​
until
string

The timestamp from where report should stop (Unix timestamp).

​
inbox_ids
integer[]

Filter by specific inbox IDs.

​
label_ids
integer[]

Filter by specific label IDs.

Response

Success

Inbox-label matrix report showing the count of conversations for each inbox-label combination.

​
inboxes
object[]

List of inboxes included in the report

​
labels
object[]

List of labels included in the report

​
matrix
number[][]

2D array where matrix[i][j] represents the count of conversations in inboxes[i] with labels[j]