GET /search
Search for entities in your account by text string
Servers
- https://api.optimizely.com/v2
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
project_id[] |
Array | No |
Filters search results by Project ID. Specifying multiple Project IDs will search across all specified projects. |
type_expand[] |
Array | No |
Filters search results by experiment, rule or campaign types. Specifying multiple types will search across all types specified. |
archived |
Boolean | No |
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 value: false |
sort[] |
Array | No |
The property to sort by. |
expand[] |
Array | No |
Include the project name with the search result |
fullsearch |
Boolean | No |
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 value: false |
status[] |
Array | No |
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. |
page |
Integer | No |
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 value: 1 |
query |
String | Yes |
The text to search for. |
order[] |
Array | No |
The property to sort by. |
per_page |
Integer | No |
Optional pagination argument that specifies the maximum number of objects to return per request Default value: 25 |
environment_key |
String | No |
Filters search result by environment_key when applicable |
type[] |
Array | No |
Filters search results by entity type. Specifying multiple types will search across all types specified. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.