Skip to main content
POST
Preview 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
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.

Response

OK

data
object

The payload.

error
null
meta
object