Sign in
experiments

Experiments List

List the existing experiments

get/api/v1/experiments/

Query parameters

pageinteger nullable

The page number from which to start (0-based)

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25

The maximum number of items to return

search_fieldsExperimentProperties[]

String names of fields to search. Correspond by index to search field values

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

order_by'id' | 'name' | 'name_exact' | 'description' | 'status' | 'target_id' | 'agent_id' | 'created_at' | 'updated_at' | 'started_at' | 'stopped_at'

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsExperimentProperties[] nullable

The fields to include in the response

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z

The start datetime for filtering results

end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

The end datetime for filtering results

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "id": 1,
      "name": "Shorter greeting",
      "target_id": 1,
      "variants": [
        {
          "id": 1,
          "name": "b",
          "weight": 50,
          "agent_id": 1,
          "agent_name": "Front desk"
        }
      ],
      "target": {
        "id": 1,
        "target": "+19995551234",
        "channel_id": 1,
        "channel_name": "Main line"
      }
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Changes

Changed in 1 of the 144 revisions of this API.1

Of the 144 revisions, 1 has no diff computed.