A/B Testing REST API Reference

Create A/B test

POST /v1/skills/{skillId}/experiments/

Delete A/B test

DELETE /v1/skills/{skillId}/experiments/{experimentId}

Get A/B test

GET /v1/skills/{skillId}/experiments/{experimentId}

Get A/B test state

GET /v1/skills/{skillId}/experiments/{experimentId}/state

Get customer treatment override

GET /v1/skills/{skillId}/experiments/{experimentId}/treatmentOverrides/~current

Get metric snapshot data

GET /v1/skills/{skillId}/experiments/{experimentId}/metricSnapshots/{metricSnapshotId}

List A/B test

GET /v1/skills/{skillId}/experiments&maxResults={maxResults}&nextToken={nextToken}

List metric snapshots

GET /v1/skills/{skillId}/experiments/{experimentId}/metricSnapshots&maxResults={maxResults}&nextToken={nextToken}

Set customer treatment override

PUT /v1/skills/{skillId}/experiments/{experimentId}/treatmentOverrides/~current

Update A/B test

POST /v1/skills/{skillId}/experiments/{experimentId}/properties

Update A/B test state

POST /v1/skills/{skillId}/experiments/{experimentId}/state

Update test exposure

POST /v1/skills/{skillId}/experiments/{experimentId}/exposurePercentage

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

access token

Header

LWA token.

String

Yes

experiment

A/B test settings.

Object

Yes

experiment.name

Unique name for your A/B test.
You can't use an identical name for two tests. However, you can use the same name if you delete one of the tests.
Valid value: 1–255 characters.

String

Yes

experiment.description

Description of the hypothesis you set for your A/B test.
Used for reference purposes and doesn't impact the outcome.

String

Yes

experiment.type

Type of A/B test that you want to run for your skill.
Valid value:

• ENDPOINT_BASED- Sets your test's T1 value to your skill version in the LIVE stage. To separate your control (C) and treatment (T1) behavior, you must add conditional logic in your skill code. For more details, see Set up an Endpoint-based A/B Test.

String

Yes

experiment.plannedDuration

Number of weeks you plan to run your A/B test.
Used for reference purposes and doesn't impact the test length.
Defined in ISO-8601 format, P[n]W.
Valid values:1–4 weeks.

String

Yes

experiment.exposurePercentage

Percentage of unique customers that you plan to include in your A/B test. This number doesn't have to match your total users.

For example, if you have 100 total customers and you set your exposurePercentage to 40 percent, you're including 40 customers in your test. In this case, your test includes 20 customers in C and 20 customers in T1. The remaining 60 customers aren't included in the test and receive the default behavior equivalent to C, meaning they don't contribute to the test metrics.
Valid values: 0–100.

Integer

Yes

experiment.metricConfigurations

List of A/B test metrics that you plan to use in your test.

Array

Yes

experiment.metricConfigurations[].name

Unique name of the test metric.
For valid names, see key and guardrail metrics.
Valid value: 1–125 characters.

String

Yes

experiment.metricConfigurations[].metricTypes

List of metrics used in your A/B test.
Valid values:
  •  KEY – Identifies a metric that provides clear evidence of expected changes caused by the new treatment experience.
  •  GUARDRAIL – Identifies a metric that detects unexpected regressions caused by the new treatment experience.

Array of strings

Yes

experiment.metricConfigurations[].expectedChange

Direction that you expect a metric to trend during the testing.
Used for reference purposes and doesn't impact the actual test outcome.
Valid values:
  •  INCREASE – Upward change in metric value.
  •  DECREASE – Downward change in metric value.

String

Yes

201 Created

A/B test created successfully for the specified skill.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

experimentId

Path

Identifies the A/B test.
Use the experiment ID returned from Create A/B test or List A/B tests.

String

Yes

access token

Header

LWA token.

String

Yes

204 No Content

A/B test deleted successfully.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

experimentId

Path

Identifies the A/B test.
Use the experiment ID returned from Create A/B test or List A/B tests.

String

Yes

access token

Header

LWA token.

String

Yes

experiment

A/B test settings.

Object

experiment.name

Unique name of the A/B test. Valid value: 1–255 characters.

String

experiment.description

Description of the hypothesis you set for your A/B test.
Used for reference purposes and doesn't impact the outcome.

String

experiment.type

Type of A/B test that you want to run for your skill.
Valid value:

• ENDPOINT_BASED- Sets your test's T1 value to your skill version in the LIVE stage. To separate your C and T1 behaviors, you must add conditional logic in your skill code. For more details, see Set up an Endpoint-based A/B Test.

String

experiment.plannedDuration

Number of weeks you plan to run your A/B test.
Used for reference purposes and doesn't impact the test length.
Defined in ISO-8601 format, P[n]W.
Valid values:1–4 weeks.

String

experiment.exposurePercentage

Percentage of unique customers that you plan to include in your A/B test. This number doesn't have to match your total users.

For example, if you have 100 total customers and you set your exposurePercentage to 40 percent, you're including 40 customers in your test. In this case, your test includes 20 customers in C and 20 customers in T1. The remaining 60 customers aren't included in the test and receive the default behavior equivalent to C, meaning they don't contribute to the test metrics.
Valid values: 0–100.

Integer

experiment.metricConfigurations

List of A/B test metrics that you plan to use in your test.

Array

experiment.metricConfigurations[].name

Unique name of the test metric.
For valid names, see key and guardrail metrics.
Valid value: 1–125 characters.

String

experiment.metricConfigurations[].metricTypes

List of metrics used in your A/B test.
Valid values:
  •  KEY – Identifies a metric that provides clear evidence of expected changes caused by the new treatment experience.
  •  GUARDRAIL – Identifies a metric that detects unexpected regressions caused by the new treatment experience.

Array of strings

experiment.metricConfigurations[].expectedChange

Direction that you expect a metric to trend during the testing.
Used for reference purposes and doesn't impact the actual test outcome.
Valid values:
  •  INCREASE – Upward change in metric value.
  •  DECREASE – Downward change in metric value.

String

treatmentOverrideCount

Number of overrides that exist for the test.

Integer

experiment.state

Current state of the test.
Valid values:

• CREATED – Created successfully but not yet enabled or started.
• ENABLING – Initiated the transition to ENABLED.
• ENABLED – Experiment configurations deployed but only customer treatment overrides set to T1 can view the T1 experience of a skill. In this state, no metrics collected.
• RUNNING – Test started and a percentage of skill customers defined in the exposurePercentage enter into the test. Customers are randomly assigned the T1 or C experience. Metric collection begins.
• STOPPING – Initiated the transition to STOPPED.
• STOPPED – Test ended and all customers now experience the C behavior. Metrics collection stopped.
• FAILED – Experiment configurations failed to deploy during the ENABLING state.

String

experiment.history

History of an A/B test.

Object

experiment.history.creationTime

Date and time the test was created or updated.
Defined in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.

String

experiment.history.startTime

Date and time the test started.
Defined in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.

String

experiment.history.stoppedReason

Reason the test stopped.
Valid values: DEVELOPER_REQUEST, EXPERIMENT_SUCCESS, EXPERIMENT_ISSUE.

String

experiment.trigger

Defines the triggers for the test.

Object

experiment.trigger.scheduledEndTime

Expected end date and time of the test.
Defined in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.

String

200 OK

Response body contains the test details.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

experimentId

Path

Identifies the A/B test.
Use the experiment ID returned from Create A/B test or List A/B tests.

String

Yes

access token

Header

LWA token.

String

Yes

state

Current state of the test.
Valid values:

• CREATED – Created successfully but not yet enabled or started.
• ENABLING – Initiated the transition to ENABLED.
• ENABLED – Experiment configurations deployed but only customer treatment overrides set to T1 can view the T1 experience of a skill. In this state, no metrics collected.
• RUNNING – Test started and a percentage of skill customers defined in the exposurePercentage enter into the test. Customers are randomly assigned the T1 or C experience. Metric collection begins.
• STOPPING – Initiated the transition to STOPPED.
• STOPPED – Test ended and all customers now experience the C behavior. Metrics collection stopped.
• FAILED – Experiment configurations failed to deploy during the ENABLING state.

String

200 OK

Response body contains the test state.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

experimentId

Path

Identifies the A/B test.
Use the experiment ID returned from Create A/B test or List A/B tests.

String

Yes

access token

Header

LWA token.

String

Yes

treatmentId

Testing group: control or new treatment.
Valid values: C, T1.

String

treatmentOverrideCount

Number of treatment overrides you set for your A/B test.

Integer

200 OK

Response body contains the treatment override.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

experimentId

Path

Identifies the A/B test.
Use the experiment ID returned from Create A/B test or List A/B tests.

String

Yes

metricSnapshotId

Path

Identifies the metric snapshot.
Use the ID returned from List metric snapshots.
Valid value: 1–255 characters.

String

Yes

access token

Header

LWA token.

String

Yes

status

State of the metric snapshot.
Valid values: RELIABLE, UNRELIABLE.

String

statusReason

Reason why the metric snapshot status is unreliable.

String

metrics

List of metric snapshot values for your skill.

Array of objects

metrics[].name

A unique name that identifies the A/B test metric.

String

metrics[].treatmentId

Testing group assigned to the test that generated these metrics: control or new treatment.
Valid values: C, T1.

String

metrics[].values

Metric result values.

Object

metrics[].values.mean

Mean or average of each sample.
Includes either the T1 or C testing group.

Double

metrics[].values.percentDiff

Relative percent difference between the mean of the T1 group and the mean of the C group.

Double

metrics[].values.confidenceIntervalLower

Lower limit number of the confidence interval range. The confidence interval measures the probability that the mean falls within a range.

Double

metrics[].values.confidenceIntervalUpper

Upper limit number of the confidence interval range. The confidence interval measures the probability that the mean falls within a range.

Double

metrics[].values.pValue

Probability that the difference between the T1 and C means is due to random sampling errors.

Double

metrics[].values.userCount

Number of users in the T1 sample*.

Long

200 OK

Response body contains the metric data for the specified snapsnot.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

maxResults

Query

Maximum number of results to return in the response.
Valid values: 1–50. Default: 10.

Integer

No

nextToken

Query

Token from the previous response. If not included, the Alexa service returns the first page of results.
Include if iterating over a paginated response.

String

No

access token

Header

LWA token.

String

Yes

experiments

List of A/B tests defined for the specified skill

Array of objects

experiments[].experimentId

Unique identifier for the A/B test.

String

experiments[].name

Unique name of the A/B test.

String

experiments[].state

Current state of the test.
Valid values:

• CREATED - Created successfully but not yet enabled or started.
• ENABLING - Initiated the transition to ENABLED.
• ENABLED - Experiment configurations deployed but only customer treatment overrides set to T1 can view the T1 experience of a skill. In this state, no metrics collected.
• RUNNING - Test started and a percentage of skill customers defined in the exposurePercentage enter into the test. Customers are randomly assigned the T1 or C experience. Metric collection begins.
• STOPPING - Initiated the transition to STOPPED.
• STOPPED - Test ended and all customers now experience the C behavior. Metrics collection stopped.
• FAILED - Experiment configurations failed to deploy during the ENABLING state.

String

experiments[].experimentHistory

History of an A/B test.

Object

experiments[].experimentHistory.creationTime

Date and time the test was created or updated.
Defined in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.

String

experiments[].experimentHistory.startTime

Date and time the test started.
Defined in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.

String

experiments[].experimentHistory.stoppedReason

Reason the text stopped.
Valid values: DEVELOPER_REQUEST, EXPERIMENT_SUCCESS, EXPERIMENT_ISSUE.

String

paginationContext

Indicates there are more matching results. If present, the response contains a subset of the results. When there are no more matching results, paginationContext isn't included in the response.

Object

paginationContext.nextToken

Identifies the next set of results to return. The token expires in 24 hours.
Use this value for the nextToken parameter in a subsequent List A/B tests request.

String

200 OK

Response body contains a list of A/B tests defined for the skill.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

experimentId

Path

Identifies the A/B test.
Use the experiment ID returned from Create A/B test or List A/B tests.

String

Yes

maxResults

Query

Maximum number of results to return in the response.
Valid values: 1–50. Default: 10.

Integer

No

nextToken

Query

Token from the previous response. If not included, the Alexa service returns the first page of results.
Include if iterating over a paginated response.

String

No

access token

Header

LWA token.

String

Yes

metricSnapshots

List of metric snapshots for the specified A/B test.

Array of objects

metricSnapshots[].metricSnapshotId

Unique identifier for the metric snapshot of an A/B test.

String

metricSnapshots[].startDate

Date and time the metric snapshot started.
Defined in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.

String

metricSnapshots[].endDate

Date and time the metric snapshot started.
Defined in ISO 8601 format, YYYY-MM-DDThh:mm:ssZ.

String

paginationContext

Indicates there are more matching results. If present, the response contains a subset of the results. When there are no more matching results, paginationContext isn't included in the response.

Object

paginationContext.nextToken

Identifies the next set of results to return. The token expires in 24 hours.
Use this value for the nextToken parameter in a subsequent List metric snapshots request.

String

200 OK

Response body contains a list of metric snapshots for the specified A/B test.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

experimentId

Path

Identifies the A/B test.
Use the experiment ID returned from Create A/B test or List A/B tests.

String

Yes

access token

Header

LWA token.

String

Yes

treatmentId

Testing group: control or new treatment.
Valid values: C, T1.

String

202 Accepted

Override treatment updated successfully.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

experimentId

Path

Identifies the A/B test.
Use the experiment ID returned from Create A/B test or List A/B tests.

String

Yes

access token

Header

LWA token.

String

Yes

experiment

A/B test settings.

Object

Yes

experiment.description

Description of the hypothesis you set for your A/B test.
Used for reference purposes and doesn't impact the outcome.

String

Yes

experiment.plannedDuration

Number of weeks you plan to run your A/B test.
Used for reference purposes and doesn't impact the test length.
Defined in ISO-8601 format, P[n]W.
Valid values:1–4 weeks.

String

Yes

experiment.exposurePercentage

Percentage of unique customers that you plan to include in your A/B test. This number doesn't have to match your total users.

For example, if you have 100 total customers and you set your exposurePercentage to 40 percent, you're including 40 customers in your test. In this case, your test includes 20 customers in C and 20 customers in T1. The remaining 60 customers aren't included in the test and receive the default behavior equivalent to C, meaning they don't contribute to the test metrics.
Valid values: 0–100.

Integer

Yes

experiment.metricConfigurations

List of A/B test metrics that you plan to use in your test.

Array

Yes

experiment.metricConfigurations[].name

Unique name of the test metric.
For valid names, see key and guardrail metrics.
Valid value: 1–125 characters.

String

Yes

experiment.metricConfigurations[].metricTypes

List of metrics used in your A/B test.
Valid values:
  •  KEY – Identifies a metric that provides clear evidence of expected changes caused by the new treatment experience.
  •  GUARDRAIL – Identifies a metric that detects unexpected regressions caused by the new treatment experience.

Array of strings

Yes

experiment.metricConfigurations[].expectedChange

Direction that you expect a metric to trend during the testing.
Used for reference purposes and doesn't impact the actual test outcome.
Valid values:
  •  INCREASE – Upward change in metric value.
  •  DECREASE – Downward change in metric value.

String

Yes

204 No content

A/B test values updated successfully.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

experimentId

Path

Identifies the A/B test.
Use the experiment ID returned from Create A/B test or List A/B tests.

String

Yes

access token

Header

LWA token.

String

Yes

targetState

New state of the test.
For more details about how to use states, see Lifecycle of an A/B test.
Valid values:
- ENABLED – Experiment configurations deployed but only customer treatment overrides set to T1 can view the T1 experience of a skill. In this state, no metrics collected. - RUNNING – Test started and a percentage of skill customers defined in the exposurePercentage enter into the test. Customers are randomly assigned the T1 or C experience. Metric collection begins. - STOPPED – Test ended and all customers now experience the C behavior. Metrics collection stopped.

String

Yes

stoppedReason

Reason the test stopped.
Include when you set the state to STOPPED. Valid values: DEVELOPER_REQUEST, EXPERIMENT_SUCCESS, EXPERIMENT_ISSUE.

String

No

202 Accepted

Test state updated successfully.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.

skillId

Path

Identifies the skill associated with your A/B test.
Valid values: 1 – 255 characters.

String

Yes

experimentId

Path

Identifies the A/B test.
Use the experiment ID returned from Create A/B test or List A/B tests.

String

Yes

access token

Header

LWA token.

String

Yes

exposurePercentage

New percentage of customers to be part of the test. If the test is running, you can increase the exposure percentage value of a running test, but not decrease it.
Valid values: 0–100.

Integer

Yes

204 No content

Test exposure value updated successfully.

400 Bad Request

Indicates that one or more properties in the request body aren't valid.
The following example shows the response body with the error code and message.

{
     "message": "The property is outside the allowed range.",
     "code": "INVALID_STRING_LENGTH"
}

401 Unauthorized

Request didn't include the authorization token, or the included token expired or isn't valid. Or, you don't have access to the resource.

403 Forbidden

Indicates that the authorization token is valid, but the requested operation isn't allowed.

404 Not Found

Requested resource not found.

429 Too Many Requests

Permitted rate limit, specified as number of requests per unit of time, exceeded. Retry the request by using exponential back-off.

500 Server Error

Error occurred on the server. Retry the request by using exponential back-off.

503 Service Unavailable

Server is down for maintenance, overloaded, or otherwise unavailable to handle the incoming request.