Skip to main content
POST
Save a report

Authorizations

API-Key
string
header
required

Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login.

Body

application/json

A saved report. PATCH replaces the whole saved report: request is required there too, and fields left out go back to their defaults.

request
object
required

What a report is asked for. A period is either a relative period (resolved against the company's today when the report runs) or fixed days fromDay/untilDay. With neither, last week is used. The period may not be longer than the report's maxDays.

name
string

Defaults to the report's title.

Maximum string length: 120
formats
enum<string>[]

Defaults to request.format or the report's default format.

Maximum array length: 3
Available options:
pdf,
xlsx,
csv,
json
schedule
object

When a saved report sends itself, in the company's time zone. Missing = none (run by hand).

recipients
object
delivery
enum<string>
default:attach
Available options:
attach,
link,
inbox
status
enum<string>

Default active on create; kept on update when left out.

Available options:
active,
paused

Response

Created

data
object

The payload.

error
null
meta
object