Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A report on the project's live calls: which calls (one agent or all, plus conversation filters in the analytics vocabulary), the targets the period is held to, how often it is written, and who receives it.

name
string
required
Required string length: 1 - 200
description
string | null
Maximum string length: 2000
agentId
string<uuid> | null
filters
object[]
Maximum array length: 20
targets
object[]
Maximum array length: 10
dashboardId
string<uuid> | null
cadence
enum<string>
default:WEEKLY
Available options:
DAILY,
WEEKLY,
MONTHLY
timezone
string
default:UTC
Minimum string length: 1
deliveryHour
integer
default:9
Required range: 0 <= x <= 23
status
enum<string>
default:ACTIVE
Available options:
ACTIVE,
PAUSED
notifications
object
includeTranscriptExcerpts
boolean
default:true
generateNow
boolean
default:true

Write the report for the latest closed period right away. Default true.

Response

The created report

data
object
required