API DocsRESTSaved search service

CreateSavedSearch

Create a saved search.

POST
/api/v1/saved_searches

Request Body

application/jsonRequired

The request for a call to SavedSearchService_CreateSavedSearch to create a saved search.

name
Required
string

properties
Required
object

organizationIdstring

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

curl -X POST "<API_URL>/api/v1/saved_searches" \
  -H "Authorization: Bearer <API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "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
    },
    "organizationId": "string"
  }'

A successful response.

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

Previous

BatchDeleteSavedSearches POST

Next

DeleteSavedSearch DELETE