Skip to main content
GET
List report query fields

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

Query Parameters

topic
string

The topic to list, as key in the answer. Leave it out for claudia_conversations, currently the only one.

Example:

"claudia_conversations"

Response

The fields of the topic.

The fields a query can ask for on one topic.

key
string
required

The topic key, to send as topic.

name
string
required

The topic name.

date_axis
string
required

Which date from and to filter on. conversation_created: the day the conversation started.

max_days
integer
required

The longest period one query may span, in days.

fields
object[]
required

The fields a query can ask for.