Create Saved Search

Creates a new saved search.

POST /api/v2/saved-searches

Error

A valid request URL is required to generate request examples

200

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

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

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

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

التفويضات

Authorization · string · header · مطلوب

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

الجسم

application/json

name · string · مطلوب

Display name for the saved search.

Maximum string length: 1024

مثال:

"Production Errors"

sourceId · string · مطلوب

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

مثال:

"507f1f77bcf86cd799439012"

select · string

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

Maximum string length: 4096

مثال:

"Timestamp, ServiceName, Body"

where · string

Row filter expression. The language is controlled by whereLanguage.

Maximum string length: 8192

مثال:

"SeverityText:ERROR"

whereLanguage · enum<string> · افتراضي: lucene

Language used for the where filter.

الخيارات المتاحة: lucene, sql

مثال:

"lucene"

orderBy · string

ORDER BY expression. Empty uses the source default.

Maximum string length: 1024

مثال:

"Timestamp DESC"

tags · string[]

Tags used to organize saved searches.

Maximum array length: 50

Maximum string length: 32

مثال:

["production", "errors"]

filters · object[]

Structured pinned filters applied to the search.

Maximum array length: 100

Show child attributes

مثال:

[
  {
    "type": "sql",
    "condition": "ServiceName IN ('checkout', 'payments')"
  }
]

الاستجابة

200

application/json

Successfully created saved search

data · object

The saved search object.

Show child attributes