App Store version experiments
List all treatments for an App Store experiment v1
Read a page of app store version experiment treatment resources as flat JSON objects.
/legacy/experiments/{experimentId}/treatmentsProposed · Legacy read design · Adapter not implemented
Request
Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.
BASE='https://asc.example.com/v1/connections/conn_example'
curl --fail-with-body "$BASE/legacy/experiments/experiment_123/treatments" \
-H "Authorization: Bearer $ASC_FACADE_KEY"const base = "https://asc.example.com/v1/connections/conn_example";
const response = await fetch(`${base}/legacy/experiments/experiment_123/treatments`, {
headers: { Authorization: `Bearer ${process.env.ASC_FACADE_KEY}` }
});
const body = await response.json();
if (!response.ok) {
throw new Error(body.error?.message ?? `HTTP ${response.status}`);
}
console.log(body);import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError
base = "https://asc.example.com/v1/connections/conn_example"
request = Request(
f"{base}/legacy/experiments/experiment_123/treatments",
headers={"Authorization": f"Bearer {os.environ['ASC_FACADE_KEY']}"},
)
try:
with urlopen(request) as response:
print(json.load(response))
except HTTPError as error:
detail = json.load(error)
raise RuntimeError(detail["error"]["message"]) from errorasc.example.com is a placeholder for your deployment. Examples use fictional IDs.
Path parameters
| Name | Type | Description |
|---|---|---|
| experimentId | string | The selected resource’s ID. |
Query parameters
| Name | Type | Description |
|---|---|---|
| fields | string | Comma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.Valuesname, appIcon, appIconName, promotedDate |
| limit | integer | Number of items per page, from 1 to 200. |
| cursor | string | Opaque nextCursor from a previous response. Keep the route, connection, filters, and ordering unchanged. |
Response
A page of flat objects, with an opaque continuation cursor.
{
"items": [
{
"id": "app_store_version_experiment_treatment_123",
"name": "Example Notes",
"appIcon": {
"templateUrl": "template_url_example",
"width": 1290,
"height": 2796
},
"appIconName": "app_icon_name_example",
"promotedDate": "2026-10-14T12:00:00Z",
"appStoreVersionExperimentId": "app_store_version_experiment_123"
}
],
"nextCursor": null
}Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.
Response fields
| Name | Type | Description |
|---|---|---|
| items | object[] | The current page of plain resource objects. An empty collection returns []. |
| nextCursor | string | null | Opaque continuation token, or null when the collection is complete. Pass it back as cursor. |
Each item
| Name | Type | Description |
|---|---|---|
| id | string | Apple’s resource ID. Keep this string unchanged when addressing a resource. |
| name | string | The resource’s name. An app’s localized name is read from its app-info localization. |
| appIcon | object | The app icon value reported by Apple for this resource. |
| appIconName | string | The app icon name value reported by Apple for this resource. |
| promotedDate | string · date-time | Promoted date, as an RFC 3339 timestamp. |
| appStoreVersionExperimentId | string | null | ID of the related app store version experiment. Present only when Apple supplies linkage; related objects are not loaded automatically. |
appIcon fields
| Name | Type | Description |
|---|---|---|
| templateUrl | string | The template url value reported by Apple for this resource. |
| width | integer | The width value reported by Apple for this resource. |
| height | integer | The height value reported by Apple for this resource. |
Behavior
- This documents an older Apple resource contract. Its /legacy route keeps that shape separate from the current resource design; do not use it as an automatic fallback after a failed request.
Pagination
Pass nextCursor back as cursor with the same filters and ordering. Stop when it is null. Each request returns one bounded page; the service never reports a capped or incomplete traversal as a complete collection.
Errors
| HTTP | Type | Description |
|---|---|---|
| 400 | invalid_query | Unsupported filter, sort, limit, or cursor. |
| 401 | unauthorized | Missing or invalid facade API key. |
| 403 | forbidden / upstream_forbidden | The caller or configured Apple key cannot read this resource. |
| 404 | resource_not_found | The requested resource, parent, or exact locale is absent or outside the caller’s scope. |
| 429 | rate_limited | A facade or Apple rate limit was reached. Respect Retry-After when returned. |
| 502–504 | upstream error | Apple authentication, response parsing, availability, or timeout failure; this is not an empty result. |
Apple mapping
Upstream route and translation
The adapter calls GET /v1/appStoreVersionExperiments/{id}/appStoreVersionExperimentTreatments. Read Apple’s original endpoint ↗
Flatten Apple’s attributes into each resource object. Expose supplied singleton linkage as IDs, with no automatic relationship traversal. Read access does not make these fields writable.
| Facade parameter | Type | Description |
|---|---|---|
| fields | query | fields[appStoreVersionExperimentTreatments] |
| limit | query | limit |
| cursor | query | Facade-owned pagination |
Reviewed 2026-10-14 · OpenAPI 4.5.1