Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Report Run Statuses
Search the full API reference Esc to close

Get Report Run Statuses

Reports · REST API reference

Get support
GET/v1/report-runs/status
Status and file states of up to `STATUS_IDS_MAX` runs, in the order asked, for the page's poll while a run is in flight (framework 15). A run the caller may not list is left out. No figures.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request 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
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/report-runs/status?ids=<IDS>' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

GET requests only. Your key’s permissions and facility scope still apply.

Response
Your response will appear here.

Parameters

idsquery · stringrequired

Up 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
JSON · generated example
{
  "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[]required
Show data schema
completed_atstring | null

When the run completed or failed.

Format: date-time

Show completed_at schema
string | null

When the run completed or failed.

Variant 1: string
string
Variant 2: null
null
error_codestring | null

Why a failed run failed, as a code.

Show error_code schema
string | null

Why a failed run failed, as a code.

Variant 1: string
string
Variant 2: null
null
error_messagestring | null

Why a failed run failed, for the reader. It holds no value.

Show error_message schema
string | null

Why a failed run failed, for the reader. It holds no value.

Variant 1: string
string
Variant 2: null
null
expiredbooleanrequired

True once the run's files are no longer offered.

filesReportRunFileResponse[]

The run's files.

Show files schema
detail_omittedbooleanrequired

True when the file prints the summary without its detail rows.

display_namestring | null

The name the file is saved under, once it is ready.

Show display_name schema
string | null

The name the file is saved under, once it is ready.

Variant 1: string
string
Variant 2: null
null
formatstringrequired

The file's format.

Values: "csv", "xlsx", "pdf", "zip"

messagestring | null

Why a file is unavailable, failed, or prints totals only, for the reader.

Show message schema
string | null

Why a file is unavailable, failed, or prints totals only, for the reader.

Variant 1: string
string
Variant 2: null
null
reasonstring | null

Why a file failed or is unavailable, as a code.

Show reason schema
string | null

Why a file failed or is unavailable, as a code.

Variant 1: string
string
Variant 2: null
null
size_bytesinteger | null

The file's size, once it is ready.

Show size_bytes schema
integer | null

The file's size, once it is ready.

Variant 1: integer
integer
Variant 2: null
null
statusstringrequired

`queued` while it is prepared, `ready` to download, `failed` or `unavailable` when it cannot be.

Values: "queued", "ready", "failed", "unavailable"

has_notesbooleanrequired

True when the run carries notes for the reader.

idstringrequired

The run's id.

Format: uuid

row_countinteger | null

Detail rows the run holds, once completed.

Show row_count schema
integer | null

Detail rows the run holds, once completed.

Variant 1: integer
integer
Variant 2: null
null
statusstringrequired

`queued`, `running`, `completed` or `failed`.

Values: "queued", "running", "completed", "failed"

weakest_verdictstring | null

The least certain history mark, once completed.

Values: "observed", "rebuilt", "approximate", "shallow"

Show weakest_verdict schema
string | null

The least certain history mark, once completed.

Variant 1: string
string

Values: "observed", "rebuilt", "approximate", "shallow"

Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll reports operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Get Report Run Statuses | Facily Developers