List occurrences

GET

https://api.sureshake.com/v2/reporter/report-schedules/{id}/occurrences

Path parameters

id
string
required
format: uuid

Query parameters

limit
optional
integer
maximum: 100 · minimum: 1 · default: 20

Returns

200

Default Response

JSON

data
array of
object
required
- id
  string
  required
  format: uuid
- scheduleId
  string
  required
  format: uuid
- trigger
  scheduled
  or
  manual
  required
- periodStart
  string
  required
  pattern: ^\d{4}-\d{2}-\d{2}$
- periodEnd
  string
  required
  pattern: ^\d{4}-\d{2}-\d{2}$
- scheduledFor
  string
  required
  format: date-time
- reportRunId
  string
  or null
  required
  format: uuid
- reportRunStatus
  queued
  or
  running
  or
  overdue
  or
  succeeded
  or
  failed
  or null
  required
- status
  queued
  or
  running
  or
  succeeded
  or
  failed
  required
- outputUri
  string
  or null
  required
- publishedReportId
  string
  or null
  required
  format: uuid
- error
  string
  or null
  required
- distributionStatus
  not_requested
  or
  pending
  or
  sent
  or
  partial
  or
  failed
  required
- deliveries
  array of
  object
  required
  channel
  viewer_group
  or
  email
  required
  target
  string
  required
  minLength: 1
  status
  sent
  or
  failed
  required
  detail
  string
  or null
  required
  recordedAt
  string
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
meta
object
required
- total
  number
  required
  Total number of items available
- limit
  number
  required
  Number of items per page
- offset
  number
  required
  Number of items skipped
- hasMore
  boolean
  required
  Whether more items are available
- page
  optional
  number
  Current page number
- totalPages
  optional
  number
  Total number of pages
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}