Skip to main content
GET
Get a report

Authorizations

Authorization
string
header
required

The id_token from POST /auth/v1/signin, sent as Authorization: Bearer <id_token>. Not the access_token — that one does not carry the identity Cloud Chat authorizes on.

Headers

cloudchat-instance
integer
required

Your Cloud Chat instance ID — an integer, fixed for your company, told at onboarding. The API overview explains how instances work, how to find yours, and the errors a wrong or missing value produces.

Example:

1

Path Parameters

accountId
integer
required

Your Cloud Chat account. It has to be an account your token grants membership on, and it has to live on the instance in the cloudchat-instance header — the two travel together. Account numbers are only unique within an instance, so the same number is a different company on another instance. Usually a mismatched pair fails closed with a 401, because your user does not exist on the other instance — but if your identity happens to exist on both, the call succeeds against the other company's data, silently. Read it and you are looking at the wrong help center; write it and you have stored into the wrong account. Send the two values that were given to you together, and never try a number to see what answers.

Example:

1

reportKey
string
required

The report to read, as key in list reports.

Example:

"claudia_general_info"

Query Parameters

metrics
string

Comma-separated metric keys from list reports. Leave it out for the report's default_metrics. Asking for more than a call allows answers 422, and error.details gives the maximum.

Example:

"retention,volume"

from
string

First day of the period, YYYY-MM-DD, included. Send it together with to.

Example:

"2026-09-21"

to
string

Last day of the period, YYYY-MM-DD, included. Send it together with from.

Example:

"2026-10-11"

group_by
string

Break every metric into one row per period, replacing the tile's own grain; single-number metrics then come as a series without value. One of the report's group_by values.

Example:

"week"

project
string

Comma-separated Claudia project names to restrict to. Leave it out for every project you can access. A project you cannot access answers 422, and error.details lists the ones you can.

Example:

"<PROJECT_NAME>"

closing
string

Comma-separated values of the dashboard's Fechamento filter, in Portuguese exactly as stored: Dentro do horário or Fora do horário.

Example:

"Dentro do horário"

resolution_reason
string

Comma-separated resolution reasons, exactly as stored. This API does not list them.

Example:

"<REASON>"

tag
string

Comma-separated conversation tags, exactly as stored. This API does not list them.

Example:

"<TAG>"

ab_test
string

Comma-separated A/B test keys, exactly as stored.

Example:

"<AB_TEST_KEY>"

Response

The numbers of the report.

The numbers of one report.

report
object
required

Which report answered.

period
object
required

The period the numbers cover.

filters
object
required

The filters applied, by parameter, each with the values you sent. Empty when you sent none.

metrics
object[]
required

The metrics you asked for, in the report order.

data_through_approximate
boolean
required

Always true; see data_through.

group_by
string | null

The period the series were split by, or null for the dashboard default.

data_through
string | null

Newest conversation matching the filters, regardless of the period, in local time without offset (Brasília for most accounts). null when nothing matches or when this lookup did not finish in time. Not a refresh time: an account without recent conversations shows an old date even when its data is current.

warnings
string[]

Present only when something limited the answer. no_claudia_projects: you can access no Claudia project on this account, so no metric was computed. partial_results: some metrics did not finish in time and have timed_out set to true.