List scheduled searches

GET 
/scheduled-searches

Returns a list of scheduled searches.

Request

Query Parameters

offset int32
Default value: 0
Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Example: 0
limit int32
Possible values: <= 250
Default value: 250
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Example: 250
count boolean
If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information.
Example: true
filters string
Filter results using the standard syntax described in V3 API Standard Collection Parameters
Filtering is supported for the following fields and operators:
owner.id: eq
savedSearchId: eq
Example: savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"

Responses

200

The list of requested scheduled searches.

Response Headers

• X-Total-Count

  integer

  Example: 5

  The total result count (returned only if the count parameter is specified as true).

application/json

Schema

Schema

• Array [

id string

The scheduled search ID.

owner

object

The owner of the scheduled search

type stringrequired

Possible values: [IDENTITY]

The type of object being referenced

id stringrequired

The ID of the referenced object

ownerId stringdeprecated

The ID of the scheduled search owner.

Please use the id in the owner object instead.

name stringnullable

The name of the scheduled search.

description stringnullable

The description of the scheduled search.

savedSearchId stringrequired

The ID of the saved search that will be executed.

created date-timenullable

The date the scheduled search was initially created.

modified date-timenullable

The last date the scheduled search was modified.

schedule

object

required

The schedule information.

type ScheduleType (string)required

Possible values: [DAILY, WEEKLY, MONTHLY, CALENDAR, ANNUALLY]

Enum representing the currently supported schedule types.

Additional values may be added in the future without notice.

months

object

nullable

The months to execute the search. This only applies to schedules with a type of ANNUALLY.

type SelectorType (string)required

Possible values: [LIST, RANGE]

Enum representing the currently supported selector types.

LIST - the values array contains one or more distinct values.

RANGE - the values array contains two values: the start and end of the range, inclusive.

Additional values may be added in the future without notice.

values string[]required

The selected values.

interval int32nullable

The selected interval for RANGE selectors.

days

object

nullable

The days to execute the search.

If type is WEEKLY, the values will be MON, TUE, WED, THU, FRI, SAT, and SUN.

If type is MONTHLY or ANNUALLY, the values will be a number in double quotes, like "1", "10", or "28". Optionally, the value "L" can be used to refer to the last day of the month.

type SelectorType (string)required

Possible values: [LIST, RANGE]

Enum representing the currently supported selector types.

LIST - the values array contains one or more distinct values.

RANGE - the values array contains two values: the start and end of the range, inclusive.

Additional values may be added in the future without notice.

values string[]required

The selected values.

interval int32nullable

The selected interval for RANGE selectors.

hours

object

required

The hours selected.

type SelectorType (string)required

Possible values: [LIST, RANGE]

Enum representing the currently supported selector types.

LIST - the values array contains one or more distinct values.

RANGE - the values array contains two values: the start and end of the range, inclusive.

Additional values may be added in the future without notice.

values string[]required

The selected values.

interval int32nullable

The selected interval for RANGE selectors.

expiration date-timenullable

A date-time in ISO-8601 format

timeZoneId stringnullable

The canonical TZ identifier the schedule will run in (ex. America/New_York). If no timezone is specified, the org's default timezone is used.

recipients

object[]

required

A list of identities that should receive the scheduled search report via email.

Array [

type stringrequired

Possible values: [IDENTITY]

The type of object being referenced

id stringrequired

The ID of the referenced object

]

enabled boolean

Indicates if the scheduled search is enabled.

emailEmptyResults boolean

Indicates if email generation should occur when search returns no results.

displayQueryDetails boolean

Indicates if the generated email should include the query and search results preview (which could include PII).

• ]

Example (from schema)

[
  {
    "id": "0de46054-fe90-434a-b84e-c6b3359d0c64",
    "owner": {
      "type": "IDENTITY",
      "id": "2c9180867624cbd7017642d8c8c81f67"
    },
    "name": "Daily disabled accounts",
    "description": "Daily disabled accounts",
    "savedSearchId": "554f1511-f0a1-4744-ab14-599514d3e57c",
    "created": "2018-06-25T20:22:28.104Z",
    "modified": "2018-06-25T20:22:28.104Z",
    "schedule": {
      "type": "WEEKLY",
      "months": {
        "type": "LIST",
        "values": [
          "3",
          "6",
          "9",
          "12"
        ]
      },
      "days": {
        "type": "LIST",
        "values": [
          "MON",
          "WED",
          "FRI"
        ]
      },
      "hours": {
        "type": "RANGE",
        "values": [
          "9",
          "18"
        ],
        "interval": 3
      },
      "expiration": "2018-06-25T20:22:28.104Z",
      "timeZoneId": "America/Chicago"
    },
    "recipients": [
      {
        "type": "IDENTITY",
        "id": "2c9180867624cbd7017642d8c8c81f67"
      }
    ],
    "enabled": false,
    "emailEmptyResults": false,
    "displayQueryDetails": false
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

404

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

404

An example of a 404 response object

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message

A message describing the error

Example (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Loading...