Skip to main content
PATCH
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

reportId
string<uuid>
required

The live report ID

Body

application/json

Omitted fields keep their current value. Reports already written keep what they covered.

name
string
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>
Available options:
DAILY,
WEEKLY,
MONTHLY
timezone
string
Minimum string length: 1
deliveryHour
integer
Required range: 0 <= x <= 23
status
enum<string>
Available options:
ACTIVE,
PAUSED
notifications
object
includeTranscriptExcerpts
boolean

Response

The report

data
object
required