Skip to main content
Saves a report on the project’s live calls. Simulations are never included. Targets are analytics measures held to a bar: a threshold metric is read as its pass rate (value is a percentage, 0-100, held AT_LEAST by default); a numeric metric as its average (held AT_MOST by default). Every target is read for the period and the period before it, so the report says whether each was met and how it moved. Scheduled reports are written deliveryHour hours into the day after each period ends in timezone (a week runs Monday to Sunday), then emailed and posted per notifications. With generateNow (the default) the report for the latest closed period is written right away and not sent.
Calls POST /v1/live-report

​
Options

​
string
required
​
string
​
string
​
array
​
array
​
string
​
string
One of DAILY, WEEKLY, MONTHLY
​
string
​
integer
​
string
One of ACTIVE, PAUSED
​
object
​
object
required
​
array
required
​
switch
​
switch
Write the report for the latest closed period right away. Default true.

​
Example

Every command also takes the global options and sets one of the exit codes.