Search

1 min

GET

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

Search for entities in your account by text string

Query Parameters

per_pageinteger
Description
Optional pagination argument that specifies the maximum number of objects to return per request
Default
25
Maximum
100
pageinteger
Description
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.
Default
1
querystringrequired
Description
The text to search for.
project_idinteger[]
Description
Filters search results by Project ID. Specifying multiple Project IDs will search across all specified projects.
typestring[]
Description
Filters search results by entity type. Specifying multiple types will search across all types specified.
type_expandstring[]
Description
Filters search results by experiment, rule or campaign types. Specifying multiple types will search across all types specified.
project_typestring[]
Description
Filters search results by project type. Specifying multiple types will search across all types specified.
expandstring[]
Description
Include the project name with the search result
archivedboolean
Description
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.
Default
false
fullsearchboolean
Description
Whether or not to perform full document search for the given search keyword. If this parameter is not provided it will default to false.
Default
false
statusstring[]
Description
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.
sortstring
Description
The property to sort by. Built-in fields: id, name, status, created, last_modified, experiment_type. Custom fields: custom_field:: where type is text or num. For example, sort=custom_field:num
. Custom field sorts are only supported when the type parameter is limited to campaign and/or experiment, the only types that store custom field values; other types return 400.
orderstring
Description
The property to sort by.
environment_keystring
Description
Filters search result by environment_key when applicable
audience_idinteger[]
Description
Filters search result by audience_id when applicable

Responses

200Return search results

SearchResult[]
- archivedboolean
  Example
  False
  Description
  Whether or not the entity is archived.
- audience_idsinteger[]
  Description
  A list of Audience IDs used in the Experiment
- campaign_typestring
  Example
  personalization
  Description
  Type of campaing.
- createdstring<date-time>
  Description
  The time that the entity was created.
  Format
  date-time
- descriptionstring
  Example
  Test out the hero image on the home page
  Description
  Description for the entity if it has one.
- enabledboolean
  Example
  False
  Description
  Wheter or not the environment is enabled or not
- environment_keystring
  Example
  development
  Description
  The environment key of a given rule
- event_typestring
  Example
  custom
  Description
  Type of event.
- experiment_countinteger
  Example
  123
  Description
  Number of experiments by audience_id
- experiment_typestring
  Example
  a/b
  Description
  The type of experiment
- feature_keystring
  Example
  my_feature_flag
  Description
  The feature flag key
- feature_namestring
  Example
  the user search feature
  Description
  The feature flag name to display in the Optimizely app. Whitespaces and other non-alphanumeric characters allowed. Defaults to feature key if left empty.
- flag_keystring
  Example
  my_flag_key
  Description
  The Flag key
- group_idinteger
  Example
  123
  Description
  The id of the group that the rule belongs to.
- idinteger
  Description
  ID of the entity
- keystring
  Example
  hero_image_test
  Description
  Key of the entity.
- last_modifiedstring<date-time>
  Description
  The time that the entity was last modified.
  Format
  date-time
- namestring
  Example
  Hero Image Test
  Description
  Name of the entity. This value will be the 'key' of the entity if there is no name.
- page_idinteger<int64>
  Description
  The Page ID associated with an Event
  Format
  int64
- project_idinteger
  Description
  ID of the project that contains the entity (if applicable)
- project_namestring
  Description
  Name of the project that contains the entity (if applicable)
- rule_typestring
  Example
  a/b
  Description
  Type of rule.
- ruleset_enabledboolean
  Example
  False
  Description
  Wheter or not the a rule is enabled in a ruleset
- statusstring
  Example
  running
  Description
  The current status for the entity if it has one.
- typestring<experiment | campaign | feature | audience | page | event | flag | rule | extension>
  Example
  experiment
  Description
  Type of the entity.
  Allowed
  experimentcampaignfeatureaudiencepageeventflagruleextension
- updated_timestring<date-time>
  Description
  The time that the flag entity was last modified.
  Format
  date-time
- variation_specificboolean
  Description
  Whether or not an event is variation specific

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to search the specified Account or Project

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request GET \
     --url 'https://api.optimizely.com/v2/search?per_page=25&page=1&query=string&archived=boolean&fullsearch=boolean' \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/search?per_page=25&page=1&query=string&archived=boolean&fullsearch=boolean", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/search?per_page=25&page=1&query=string&archived=boolean&fullsearch=boolean")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/search?per_page=25&page=1&query=string&archived=boolean&fullsearch=boolean"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Return search results
[
  {
    "archived": "False",
    "audience_ids": [
      0
    ],
    "campaign_type": "personalization",
    "created": "",
    "description": "Test out the hero image on the home page",
    "enabled": "False",
    "environment_key": "development",
    "event_type": "custom",
    "experiment_count": 123,
    "experiment_type": "a/b",
    "feature_key": "my_feature_flag",
    "feature_name": "the user search feature",
    "flag_key": "my_flag_key",
    "group_id": 123,
    "id": 0,
    "key": "hero_image_test",
    "last_modified": "",
    "name": "Hero Image Test",
    "page_id": "",
    "project_id": 0,
    "project_name": "",
    "rule_type": "a/b",
    "ruleset_enabled": "False",
    "status": "running",
    "type": "experiment",
    "updated_time": "",
    "variation_specific": false
  }
]

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to search the specified Account or Project
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}