Monitoring
List reports
PreviewPeriodic monitoring reports for a facility, each with a signed PDF link.
get/v1/facilities/{facility_id}/reports
monitor:readPath parameters
- facility_idSynpute IDrequired
- Facility ID e.g. SYN-FC-5D20
Query parameters
- limitinteger
- Results per page, 1 to 100 e.g. 20
- cursorstring
- Cursor from the previous page's next_cursor
Response 200 · object
- dataarray of Reportrequired
- Results, newest first
+Show propertiesHide properties
- covenantsarray of Covenant
- Covenant states at period end
+Show propertiesHide properties
- facilitySynpute ID
- Facility
- idstring
- Covenant ID
- metricstring
- What's measured
uptime_pctutilization_pctpayment_days_latecontract_coverage_months- objectstring
- Object type
- statusstring
- Current state
in_compliancebreachedcured- thresholdobject
- Breach rule
+Show propertiesHide properties
- operatorstring
- Comparison
ltltegtgte- valuenumber
- Threshold
- windowstring
- Measured over
weekmonthquarter
- facilitySynpute ID
- Facility
- idstring
- Report ID
- objectstring
- Object type
- pdf_urlstring
- Signed URL, valid 1 hour
- performancePerformancePeriod
- Performance over one period, computed from telemetry and payments
+Show propertiesHide properties
- paymentsobject
- Payments in the period
+Show propertiesHide properties
- dueinteger
- Invoices due
- lateinteger
- Paid after due date
- received_on_timeinteger
- Paid on time
- periodstring
- Period label
- uptime_pctnumber
- Share of unit-hours available
- utilization_pctnumber
- Share of available unit-hours in use
- periodstring
- Period
- has_morebooleanrequired
- More results after this page
- next_cursorstring | nullrequired
- Pass as `cursor` for the next page
- objectstringrequired
- Object type
Errors
403404return the standard error shape.