The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.
Dev GuideAPI ReferenceUser Guide
Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference
GitHubDev CommunityOptimizely AcademySubmit a ticket

Search

get
https://api.optimizely.com/v2/search

Search for entities in your account by text string

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≤ 100
Defaults to 25

Optional pagination argument that specifies the maximum number of objects to return per request

integer
Defaults to 1

Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.

string
required

The text to search for.

project_id
array of int64s

Filters search results by Project ID. Specifying multiple Project IDs will search across all specified projects.

project_id
type
array of strings

Filters search results by entity type. Specifying multiple types will search across all types specified.

type
type_expand
array of strings

Filters search results by experiment, rule or campaign types. Specifying multiple types will search across all types specified.

type_expand
project_type
array of strings

Filters search results by project type. Specifying multiple types will search across all types specified.

project_type
expand
array of strings

Include the project name with the search result

expand
boolean
Defaults to false

Whether or not to include archived entities in the search results. If this parameter is not provided it will default to false and no archived entities will be included.

boolean
Defaults to false

Whether or not to perform full document search for the given search keyword. If this parameter is not provided it will default to false.

status
array of strings

Filters search results by the current status of the entity if it has one. Works for Experiments and Campaigns, and it may work for others. Specifying multiple statuses will search for entities with ANY of those statuses.

status
string of strings

The property to sort by.

string of strings

The property to sort by.

string

Filters search result by environment_key when applicable

audience_id
array of int64s

Filters search result by audience_id when applicable

audience_id
Responses

Updated 8 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago