Skip to main content
POST
Generate an older 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
type
enum<string>
required
Available options:
jobs,
dayroute,
places,
alerts,
checkins,
timesheet,
members,
mileage,
placeonsite,
memberonsite,
stopsreport,
gpx,
activities,
timeline,
worksheet,
timeallocation,
statistics,
formsubmissions
format
string

One of the type's availableFormats; defaults to csv when offered, else the first.

date
string<date>

One day, YYYY-MM-DD. Use either date or from+until.

from
string<date>

First day, YYYY-MM-DD; needs until.

until
string<date>

Last day, YYYY-MM-DD, inclusive; at most maxDays after from.

memberIds
string[]

Members, for types with canSelectMembers. At least one member or place is required for those types.

placeIds
string[]

Places, for types with canSelectPlaces.

columns
object[]
options
object

Only the type's option keys (checkins: mode = stops, both, manual).

formTemplateId
string

Required for formsubmissions.

title
string
async
boolean
default:false

true = queue a report job and answer 202 instead of the file.

Response

The report file (when async is false).

The response is of type string.