/v1/report-runs/statusAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest example
Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.
curl --request GET \
--url 'https://api.staging.facily.ai/v1/report-runs/status?ids=<IDS>' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
idsquery · stringrequiredUp to 20 report run ids, separated by commas.
Min length: 1 · Max length: 1000
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"expired": false,
"has_notes": false,
"id": "00000000-0000-4000-8000-000000000001",
"status": "queued",
"completed_at": "2026-10-29T12:00:00Z",
"error_code": "string",
"error_message": "string",
"files": [
{
"detail_omitted": false,
"format": "csv",
"status": "queued",
"display_name": "string",
"message": "string",
"reason": "string",
"size_bytes": 0
}
],
"row_count": 0,
"weakest_verdict": "observed"
}
],
"meta": {
"request_id": "string"
}
}application/json
dataRunStatusResponse[]requiredShow data schema
completed_atstring | nullWhen the run completed or failed.
Format: date-time
Show completed_at schema
string | nullWhen the run completed or failed.
Variant 1: string
stringVariant 2: null
nullerror_codestring | nullWhy a failed run failed, as a code.
Show error_code schema
string | nullWhy a failed run failed, as a code.
Variant 1: string
stringVariant 2: null
nullerror_messagestring | nullWhy a failed run failed, for the reader. It holds no value.
Show error_message schema
string | nullWhy a failed run failed, for the reader. It holds no value.
Variant 1: string
stringVariant 2: null
nullexpiredbooleanrequiredTrue once the run's files are no longer offered.
filesReportRunFileResponse[]The run's files.
Show files schema
detail_omittedbooleanrequiredTrue when the file prints the summary without its detail rows.
display_namestring | nullThe name the file is saved under, once it is ready.
Show display_name schema
string | nullThe name the file is saved under, once it is ready.
Variant 1: string
stringVariant 2: null
nullformatstringrequiredThe file's format.
Values: "csv", "xlsx", "pdf", "zip"
messagestring | nullWhy a file is unavailable, failed, or prints totals only, for the reader.
Show message schema
string | nullWhy a file is unavailable, failed, or prints totals only, for the reader.
Variant 1: string
stringVariant 2: null
nullreasonstring | nullWhy a file failed or is unavailable, as a code.
Show reason schema
string | nullWhy a file failed or is unavailable, as a code.
Variant 1: string
stringVariant 2: null
nullsize_bytesinteger | nullThe file's size, once it is ready.
Show size_bytes schema
integer | nullThe file's size, once it is ready.
Variant 1: integer
integerVariant 2: null
nullstatusstringrequired`queued` while it is prepared, `ready` to download, `failed` or `unavailable` when it cannot be.
Values: "queued", "ready", "failed", "unavailable"
has_notesbooleanrequiredTrue when the run carries notes for the reader.
idstringrequiredThe run's id.
Format: uuid
row_countinteger | nullDetail rows the run holds, once completed.
Show row_count schema
integer | nullDetail rows the run holds, once completed.
Variant 1: integer
integerVariant 2: null
nullstatusstringrequired`queued`, `running`, `completed` or `failed`.
Values: "queued", "running", "completed", "failed"
weakest_verdictstring | nullThe least certain history mark, once completed.
Values: "observed", "rebuilt", "approximate", "shallow"
Show weakest_verdict schema
string | nullThe least certain history mark, once completed.
Variant 1: string
stringValues: "observed", "rebuilt", "approximate", "shallow"
Variant 2: null
nullmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired