v51

OpenAPI 3.0.0raw.githubusercontent.com2026-07-1000256.1 KB

Saved Searches

Update Saved Search

Updates an existing saved search. This is a full replace: send the full object. Every optional field (select, where, whereLanguage, orderBy, tags, filters) is always written and falls back to its default when omitted, so omitting a field resets it rather than preserving the stored value.

put/api/v2/saved-searches/{id}

Path parameters

idstring required

Saved search ID

Request body

namestring required

Display name for the saved search.

sourceIdstring required

ID of the source to query. Must belong to the team.

selectstring

Comma-separated list of column expressions to display. Empty uses the source default.

wherestring

Row filter expression. The language is controlled by whereLanguage.

whereLanguage'lucene' | 'sql'

Language used for the where filter.

orderBystring

ORDER BY expression. Empty uses the source default.

tagsstring[]

Tags used to organize saved searches.

Example request

{
  "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')"
    }
  ]
}

Response

Successfully updated saved search

Example response

{
  "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"
  }
}