Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Inspection Summary
Search the full API reference Esc to close

Get Inspection Summary

Tasks · REST API reference

Get support
GET/v1/facilities/{facility_id}/inspections/summary
The month figures of a facility's inspections, or with `all`, of every facility's, summed.

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/facilities/<FACILITY_ID>/inspections/summary' \
  --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

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

facility_idpath · string | stringrequired

Format: uuid

monthquery · string | null

The month to count, as YYYY-MM. Omitted, each facility counts its own current month, and the answer's month is null under all or for an id that names no facility, which reads zeros.

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "completed": 0,
    "issues_found": 0,
    "month": "string",
    "open": 0,
    "overdue": 0,
    "pass_rate": "<VALUE_MATCHING_PATTERN>",
    "total": 0
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataInspectionSummaryResponserequired

The month figures: the rounds scheduled in a month, and the rounds overdue in any month.

Show data schema
completedintegerrequired

The month's completed rounds.

issues_foundintegerrequired

The issues found over the month's completed rounds.

monthstring | nullrequired

The month counted, as YYYY-MM. A month asked for is always echoed. With none asked for it is null under all, because each facility then counts its own, and for an id that names no facility.

Show month schema
string | null

The month counted, as YYYY-MM. A month asked for is always echoed. With none asked for it is null under all, because each facility then counts its own, and for an id that names no facility.

Variant 1: string
string
Variant 2: null
null
openintegerrequired

The month's rounds not yet completed: scheduled or in progress.

overdueintegerrequired

Every scheduled or in-progress round past its date at its facility, whatever its month.

pass_ratestring | nullrequired

The share of the month's completed rounds that found no issue, as a decimal string from 0 to 1 to four places, such as 0.8750. Null when none is completed.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show pass_rate schema
string | null

The share of the month's completed rounds that found no issue, as a decimal string from 0 to 1 to four places, such as 0.8750. Null when none is completed.

Variant 1: string
string
Variant 2: null
null
totalintegerrequired

The month's rounds that are not cancelled.

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 tasks operations
Build something that works beautifully.

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

Get Inspection Summary | Facily Developers