Incidents

Count incidents by status

Returns how many incidents there are in each status, with optional filters by project, space, vehicle, item, physical unit or order.

GET
/api/v1/incidents/status-counts

Request examples

curl https://app.filmo.io/api/v1/incidents/status-counts \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "data": {
    "draft": 1,
    "open": 1,
    "waiting": 1,
    "repairing": 1,
    "complete": 1,
    "lost": 1
  }
}

Generated from the schema

The six keys always come out, with 0 if there are none. It is the only way to discover the volume: this resource does not publish a listing.

Authorizations

Bearer API key with the scope below. incidents:read

Headers

If-None-Matchstring

Conditional read: the ETag of the copy you already have. If the resource has not changed, the response is 304 with no body.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Query parameters

projectIdstring

Filter by project.

Limits: min length 1, max length 100

spaceIdstring

Filter by space.

Limits: min length 1, max length 100

vehicleIdstring

Filter by vehicle.

Limits: min length 1, max length 100

itemIdstring

Filter by catalog item.

Limits: min length 1, max length 100

serializedItemIdstring

Filter by physical unit.

Limits: min length 1, max length 100

orderIdstring

Filter by order.

Limits: min length 1, max length 100

Response

application/json

Successful response.

Response schema: IncidentStatusCountsDto

Envelope: IncidentStatusCountsResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag

dataobject

How many incidents there are in each status. All six keys are always returned, with 0 when there are none.

Show child attributes
data.draftinteger

Incidents in draft.

data.openinteger

Open incidents.

data.waitinginteger

Waiting incidents.

data.repairinginteger

Incidents under repair.

data.completeinteger

Resolved incidents.

data.lostinteger

Material declared lost.

metaobject

Additional information about the response.

Show child attributes
meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes
meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

Errors

StatusCodesMeaning
400validation_errorMalformed query or body. errors[] lists every offending field with its stable code.
402addon_requiredThe account plan does not include the add-on this operation needs; requiredAddon names it.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date. Versioning policy