DAdatadog
Experiments

List experiment protocols

List draft, published, and archived experiment protocols. Omit filter[status] to return all statuses. Only published protocols can be used to create experiments.

get/api/v2/experiments/protocols

Request

Query parameters

filter[status]ExperimentsPublicProtocolResponseDataAttributesStatus[]

Filter by protocol status. Repeat this parameter to select more than one status.

[
  "PUBLISHED"
]
filter[primary_metric_id]string uuid

Filter by the UUID of the primary metric in the protocol template.

filter[query]string

Find protocols whose names contain the search text, regardless of case. Leading and trailing spaces are ignored. Blank values apply no filter. The maximum length is 1024 UTF-8 bytes.

filter[subject_type_id]string uuid

Filter by the UUID of the subject type in the protocol template.

page[limit]integer

Number of results per page. The default is 25. Values above 50 are reduced to 50.

page[offset]integer

Number of results to skip before returning this page.

sortstring

Sort by name, subject_type_name, primary_metric_name, or updated_at. Prefix with - for descending order. The default is -updated_at.

Response

OK

Example response

{
  "data": []
}

Changes

Changes to this operation have not been checked yet.