Get outgoing messages count grouped by entity

GET

api

accounts

{account_id}

reports

outgoing_messages_count

Get outgoing messages count grouped by entity

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

import requests

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

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/outgoing_messages_count', 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/outgoing_messages_count",
  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/outgoing_messages_count"

	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/outgoing_messages_count")

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

[
  {
    "id": 1,
    "name": "Agent One",
    "outgoing_messages_count": 42
  },
  {
    "id": 2,
    "name": "Agent Two",
    "outgoing_messages_count": 18
  }
]

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

group_by

enum<string>

required

The entity to group outgoing message counts by.

Available options:

agent,

team,

inbox,

label

since

string

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

until

string

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

Response

Success

number

The ID of the grouped entity (agent, team, inbox, or label).

name

string

The name of the grouped entity.

outgoing_messages_count

number

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

Get outgoing messages count grouped by entity

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

import requests

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

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/outgoing_messages_count', 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/outgoing_messages_count",
  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/outgoing_messages_count"

	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/outgoing_messages_count")

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

[
  {
    "id": 1,
    "name": "Agent One",
    "outgoing_messages_count": 42
  },
  {
    "id": 2,
    "name": "Agent Two",
    "outgoing_messages_count": 18
  }
]

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

Getting Started

Application APIs

Platform APIs

Client APIs

Other APIs

Get outgoing messages count grouped by entity

Authorizations

Path Parameters

Query Parameters

Response