Get inbox-label matrix report

GET

api

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 'Authorization: Bearer <token>'

import requests

url = "https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
    ]
  ]
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Authenticate with Authorization: Bearer <token> using a user API token from Profile Settings. Available in Chatwoot v4.19.0 and later.

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

Show child attributes

labels

object[]

List of labels included in the report

Show child attributes

matrix

number[][]

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

Get inbox-label matrix report

curl --request GET \
  --url https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://app.chatwoot.com/api/v2/accounts/{account_id}/reports/inbox_label_matrix")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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
    ]
  ]
}

{
  "description": "<string>",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>",
      "code": "<string>"
    }
  ]
}

Getting Started

Application APIs

Platform APIs

Client APIs

Other APIs

Authorizations

Path Parameters

Query Parameters

Response