Skip to content

filtering.mdx

Latest commit

 

History

History
34 lines (24 loc) · 986 Bytes

filtering.mdx

File metadata and controls

34 lines (24 loc) · 986 Bytes
title Filtering & Sorting
description Learn how to filter and sort data in the Cachet API.

Filtering

Several endpoints support filtering to allow you to retrieve only the data you need. For example, you can filter incidents by status:

GET /api/incidents?filter[status]=1
Each endpoint may support different fields for filtering. Check the documentation for the specific endpoint you are working with.

Sorting

You can sort the results of an endpoint by passing the sort parameter. The sort parameter should be a comma-separated list of fields to sort by. You can also specify the sort order by appending asc or desc to the field name.

GET /api/incidents?sort=id

To reverse the sort order, you can prefix the field name with a hyphen.

GET /api/incidents?sort=-id
Each endpoint may support different fields for sorting. Check the documentation for the specific endpoint you are working with.