Filtering and sorting

Filtering

The filter parameter limits results to matching resources. This request filters incidents by status:

GET /api/incidents?filter[status]=1

Supported filter fields vary by endpoint. Each endpoint reference lists its supported fields.

The include parameter embeds related resources in the response. Its value is a comma-separated list of relationships:

GET /api/incidents?include=components,updates

Supported relationships vary by endpoint. Each endpoint reference lists its supported relationships.

For resources with metadata, filter[meta][key] filters by a metadata value:

GET /api/incidents?filter[meta][region]=us-east-1

The sort parameter accepts a comma-separated list of field names. Fields sort in ascending order by default:

GET /api/incidents?sort=id

A hyphen before a field name selects descending order:

GET /api/incidents?sort=-id

Supported sort fields vary by endpoint. Each endpoint reference lists its supported fields.