Account Reporting Events

GET

api

accounts

{account_id}

reporting_events

Account Reporting Events

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

import requests

url = "https://app.chatwoot.com/api/v1/accounts/{account_id}/reporting_events"

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/v1/accounts/{account_id}/reporting_events', 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/v1/accounts/{account_id}/reporting_events",
  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/v1/accounts/{account_id}/reporting_events"

	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/v1/accounts/{account_id}/reporting_events")

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

{
  "meta": {
    "count": 123,
    "current_page": 123,
    "total_pages": 123
  },
  "payload": [
    {
      "id": 123,
      "name": "<string>",
      "value": 123,
      "value_in_business_hours": 123,
      "event_start_time": "2023-11-07T05:31:56Z",
      "event_end_time": "2023-11-07T05:31:56Z",
      "account_id": 123,
      "conversation_id": 123,
      "inbox_id": 123,
      "user_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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

page

integer

default:1

The page parameter

since

string

The timestamp from where events should start (Unix timestamp in seconds)

until

string

The timestamp from where events should stop (Unix timestamp in seconds)

inbox_id

number

Filter events by inbox ID

user_id

number

Filter events by user/agent ID

name

string

Filter events by event name (e.g., first_response, resolution, reply_time)

Response

Success

meta

object

Show child attributes

payload

object[]

List of reporting events

Show child attributes

Account Reporting Events

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

import requests

url = "https://app.chatwoot.com/api/v1/accounts/{account_id}/reporting_events"

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/v1/accounts/{account_id}/reporting_events', 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/v1/accounts/{account_id}/reporting_events",
  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/v1/accounts/{account_id}/reporting_events"

	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/v1/accounts/{account_id}/reporting_events")

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

{
  "meta": {
    "count": 123,
    "current_page": 123,
    "total_pages": 123
  },
  "payload": [
    {
      "id": 123,
      "name": "<string>",
      "value": 123,
      "value_in_business_hours": 123,
      "event_start_time": "2023-11-07T05:31:56Z",
      "event_end_time": "2023-11-07T05:31:56Z",
      "account_id": 123,
      "conversation_id": 123,
      "inbox_id": 123,
      "user_id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

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