List Saved Searches

View as MarkdownEdit this pageReport an issueSet up docs MCP

GET/api/v2/saved-searches

Retrieves saved searches for the authenticated team (paginated). Results are capped at limit (default and maximum 1000). When more records exist than are returned, meta.total exceeds data.length; clients with large collections must page with limit/offset to retrieve them all.

Authorizations

AuthorizationBearer API Keyheaderrequired
`Authorization: Bearer <token>`

Query parameters

limitoptionalinteger
Maximum number of saved searches to return.

maximum: 1000, minimum: 1
Default: 1000
offsetoptionalinteger
Number of saved searches to skip before returning results.

minimum: 0
Default: 0

Response

JSON

200

Successfully retrieved saved searches

JSON

dataarray ofobjectrequired
List of saved search objects.
12 properties
- idstringrequired
  Unique saved search ID. Server-generated.
  
  Example: "507f1f77bcf86cd799439011"
- namestringrequired
  Display name for the saved search.
  
  Example: "Production Errors"
- sourceIdstringrequired
  ID of the source this saved search queries.
  
  Example: "507f1f77bcf86cd799439012"
- selectoptionalstring
  Comma-separated list of column expressions to display. Empty uses the source default.
  
  Example: "Timestamp, ServiceName, Body"
- whereoptionalstring
  Row filter expression. The language is controlled by whereLanguage.
  
  Example: "SeverityText:ERROR"
- whereLanguageoptionalluceneorsql
  Language used for the where filter.
  
  Example: "lucene"
- orderByoptionalstring
  ORDER BY expression. Empty uses the source default.
  
  Example: "Timestamp DESC"
- tagsoptionalarray ofstring
  Tags used to organize saved searches.
  
  maxLength: 32
  Example: ["production","errors"]
- filtersoptionalarray ofobject
  Structured pinned filters applied to the search.
  
  Example: [{"type":"sql","condition":"ServiceName IN ('checkout', 'payments')"}]
  2 properties
  conditionstringrequired
  SQL predicate applied to the search, in <column> IN (...) form.
  
  maxLength: 8192
  Example: "ServiceName IN ('checkout', 'payments')"
  typeoptionalsql
  Always sql. Only SQL predicate filters render in the sidebar.
  
  Default: "sql" · Example: "sql"
- teamIdoptionalstring
  ID of the team that owns the saved search.
  
  Example: "507f1f77bcf86cd799439013"
- createdAtoptionalstring
  Creation timestamp.
  
  format: date-time
  Example: "2025-01-01T00:00:00.000Z"
- updatedAtoptionalstring
  Last update timestamp.
  
  format: date-time
  Example: "2025-06-15T10:30:00.000Z"
metaobjectrequired
Pagination metadata for this result page.
3 properties
- totalintegerrequired
  Total number of items matching the query, ignoring pagination.
  
  Example: 142
- limitintegerrequired
  Maximum number of items returned in this page.
  
  Example: 50
- offsetintegerrequired
  Number of items skipped before this page.
  
  Example: 100

List Saved Searches

curl --request GET \
  --url /api/v2/saved-searches \
  --header 'Authorization: Bearer <token>'

const url = '/api/v2/saved-searches';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Response example

{
  "data": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Production Errors",
      "sourceId": "507f1f77bcf86cd799439012",
      "select": "Timestamp, ServiceName, Body",
      "where": "SeverityText:ERROR",
      "whereLanguage": "lucene",
      "orderBy": "Timestamp DESC",
      "tags": [
        "production",
        "errors"
      ],
      "filters": [
        {
          "type": "sql",
          "condition": "ServiceName IN ('checkout', 'payments')"
        }
      ],
      "teamId": "507f1f77bcf86cd799439013",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-06-15T10:30:00.000Z"
    }
  ],
  "meta": {
    "total": 142,
    "limit": 50,
    "offset": 100
  }
}

{
  "message": "NOT_FOUND: Alert not found"
}

{
  "message": "NOT_FOUND: Alert not found"
}