API Reference
SupportAPI Feedback

Schedule Health Report

post
http://{environment}/api/v4/safetycam/health/report/schedule

This API schedules a health report with specified delivery frequency, format, and recipients.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Name of the scheduled report

string
enum
required
Defaults to xlsx

Format of the exported report, must be 'pdf' or 'xlsx'

Allowed:
filters
array of strings

List of filters applied to the report UNASSOCIATED_CAMERAS : 'Unassociated cameras', UNCALIBRATED_CAMERAS : 'Uncalibrated cameras', INACTIVE_CAMERAS : 'Inactive cameras', ALARM_CAMERAS : 'Cameras with alarms', NO_RECORDING_AVAILABILITY_CAMERAS : 'No recording availability', ALL_DATA : 'All data excluding unassociated cameras'

filters
Allowed:
recipientUserIds
array of uuids
required

List of recipient IDs in UUID format

recipientUserIds*
ccEmails
array of strings

List of email addresses to CC the report

ccEmails
string
required

Scheduled delivery time (HH:MM format)

integer
enum
required

Frequency of report delivery. Must be a whole number between 1 and 4. 1: 'daily', 2: 'weekly', 3: 'monthly', 4: 'quarterly'.

Allowed:
Responses

Updated 12 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago

Did this page help you?