Skip to main content
POST
Emit report

Authorizations

Authorization
string
header
required

Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID
string
required

Body

application/json
email
string<email>
required

Address the completion e-mail is sent to once the report has been generated and stored.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
groups
enum<string>[]
required

Pre-arranged analytics groups to include in the report, in the order they should print. Some groups are CSV only (today: sessions_detailed and ad_sessions, one row per conversation). A group with a _detailed sibling (today: credits / credits_detailed) is a separate id — send both, detailed second, to print the summary and the long form together.

Minimum array length: 1
Available options:
overview,
sessions,
operators,
quality,
credits,
credits_detailed,
campaigns,
sessions_detailed,
ad_sessions
format
enum<string>
default:pdf

File the report is delivered as: pdf (the printed document) or csv (the same data, one table per indicator, UTF-8 with BOM and ; separators so it opens column-split in Excel). Defaults to pdf.

Available options:
pdf,
csv
query
object

The date range to report on. Omit for the default 30-day trailing window.

Response

Response for status 202.

reportID
string
required

Identifier of the report record created for this request.

status
enum<string>
required

Report generation status — always "pending" immediately after creation.

Available options:
pending