RoofKit
Developer docsPartner API
API keys

List reports

Lists active measurement reports for incremental partner sync.

Bearer API key · Scope: reports.read

Endpoint

GET/api/v1/reports
Query parameters6 parameters
  • from
    string:date-time

    Inclusive updated_at lower bound for incremental sync.

  • to
    string:date-time

    Inclusive updated_at upper bound for incremental sync.

  • status
    enum
    • draft
    • needs_review
    • approved
    • failed

  • search
    string

  • cursor
    string

    Opaque cursor returned by list/export responses. Send it back unchanged; malformed cursors return 400.

  • limit
    integer

Responses

200Active reports page.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
application/json
ReportListResponse
400Request payload, query, or required header is invalid.
application/json
ErrorResponse
401Missing, malformed, revoked, deleted, or unknown API key.

Headers

  • WWW-AuthenticateDocumented response header
application/json
ErrorResponse
403API key lacks the required scope or the workspace is not active.
application/json
ErrorResponse
429Rate limit exceeded for this key and endpoint or invalid-auth bucket.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
  • Retry-AfterSeconds until the caller should retry.
application/json
ErrorResponse
500Internal authentication or server error.
application/json
ErrorResponse
Try it out
Query parameters