Get reporter report runs

GET

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

Path parameters

id
string
required
format: uuid

Returns

200

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- reportingIntentId
  string
  required
  maxLength: 120 · minLength: 1 · pattern: ^[a-z0-9][a-z0-9_-]*$
- accountingConnectionId
  string
  required
  format: uuid
- status
  queued
  or
  running
  or
  overdue
  or
  succeeded
  or
  failed
  required
- reportingPeriodStart
  string
  required
  minLength: 1
- reportingPeriodEnd
  string
  required
  minLength: 1
- generatedAt
  string
  or null
  required
  format: date-time
- dataFreshnessAt
  string
  or null
  required
  format: date-time
- outputUri
  string
  or null
  required
  minLength: 1
- error
  string
  or null
  required
  minLength: 1
- failureCode
  string
  or null
  required
  minLength: 1
- executionDetail
  map of
  unknown
  required
- attemptCount
  integer
  required
  minimum: 0
- maxAttempts
  integer
  required
  minimum: 0
- claimedAt
  string
  or null
  required
  format: date-time
- leaseExpiresAt
  string
  or null
  required
  format: date-time
- deadlineAt
  string
  required
  format: date-time
- nextRetryAt
  string
  or null
  required
  format: date-time
- completedAt
  string
  or null
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
- updatedAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

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
}

{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5", "reportingIntentId": "string", "accountingConnectionId": "15a34c5a-2153-4717-b80d-7b1b9ec1ead9", "status": "queued", "reportingPeriodStart": "string", "reportingPeriodEnd": "string", "generatedAt": "2019-08-24T14:15:22Z", "dataFreshnessAt": "2019-08-24T14:15:22Z", "outputUri": "string", "error": "string", "failureCode": "string", "executionDetail": { "property1": null, "property2": null }, "attemptCount": 0, "maxAttempts": 0, "claimedAt": "2019-08-24T14:15:22Z", "leaseExpiresAt": "2019-08-24T14:15:22Z", "deadlineAt": "2019-08-24T14:15:22Z", "nextRetryAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }, "meta": { "timestamp": "2019-08-24T14:15:22Z" } }