ListSavedSearches

GET

/api/v1/saved_searches

Query Parameters

`pageSize`integer

The maximum number of saved searches to return. The service may return fewer than this value. If unspecified, at most 50 saved searches will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.

Format: "int64"

`pageToken`string

A page token, received from a previous ListSavedSearches call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListSavedSearches must match the call that provided the page token. Optional.

`filter`string

A Common Expression Language (CEL) filter string. Available fields to filter by are 'name' and 'saved_search_id'. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

`organizationId`string

This field is only required if your user belongs to multiple organizations.

curl -X GET "<API_URL>/api/v1/saved_searches?pageSize=0&pageToken=string&filter=string&organizationId=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "savedSearches": [
    {
      "savedSearchId": "string",
      "organizationId": "string",
      "name": "string",
      "properties": {
        "overviewMode": "string",
        "searchTerm": "string",
        "fromDateTime": "2019-08-24T14:15:22Z",
        "toDateTime": "2019-08-24T14:15:22Z",
        "assetItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "userItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "tagItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "annotationItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "runItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "reportTemplateItems": [
          {
            "id": "string",
            "name": "string"
          }
        ],
        "showAdvancedFilters": true
      },
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "nextPageToken": "string"
}

Query Parameters

pageSizeinteger

pageTokenstring

filterstring

organizationIdstring

Response

`pageSize`integer

`pageToken`string

`filter`string

`organizationId`string