Sign in

v1

latestOpenAPI 3.0.0HERE Documentation License2026-07-142162791.8 MB
Reports

Starts report creation

Starts a report creation.

The request body contains a rule ID, and the report start and end time. The report will be created based on the event data generated by the rule and devices associated to it.

The supported rule types are:

  • dwelling
  • detention
  • utilization

Note that both the report start and end timestamps must be earlier than the current time, and no newly ingested data will be automatically added to the report after its creation.

The created report ID will be provided in the response.

The generated report is available for one week, after which it will expire and will need to be recreated. If there is an already existing report matching the request parameters, its reportId will be returned in the response and no new report will be generated.

post/reports/v4

Request body

endstring date-time required

End date of the report period. The end date should be greater than the start date.

ruleIdstring uuid required

Rule ID of a dwelling or detention rule.

startstring date-time required

Start date and time of the report period. When getting reports per interval, this timestamp defines the start of the interval day, week or month.

For example, to make the report week start on Monday midnight 1st March 2021 in timezone UTC+1:00, set the start parameter to be 2021-02-28T23:00:00.000Z (GMT). Now when getting interval reports, the first week would contain data between 2021-02-28T23:00:00.000Z and 2021-03-07T23:00:00.000Z (GMT).

Response

OK

The report already exists or a new report creation has been started successfully. Use the Gets reports endpoint to check the report creation status and to query for actual reports.

reportIdstring required

Report ID