Chatwoot Reports API
Analytics and reporting APIs
Chatwoot Reports API is one of 40 APIs that Chatwoot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 14 operations across 14 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://app.chatwoot.com/, https://app.chatwoot.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
Chatwoot Reports API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as api_access_token (userApiKey).
An API key is passed in the header as api_access_token (agentBotApiKey).
An API key is passed in the header as api_access_token (platformAppApiKey).
userApiKey— 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…agentBotApiKey— This token should be provided by system admin or obtained via rails console. This token can be used to build bot integrations and can only access limited apis.platformAppApiKey— This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.
Paths & Operations 14
Across 14 paths, the API surfaces 14 operations — 14 GET. Each is listed below with its method, path, parameters, and response codes.
Analytics and reporting APIs
Schemas 14
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are reporting_event (12 properties), account_summary (7 properties), agent_conversation_metrics (6 properties), reporting_event_meta (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Chatwoot 12
Other APIs Chatwoot publishes across the network.
This is an independent, third-party profile of Chatwoot Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.