Parsequerade / docs
App Store Version Experiment Treatment Localizations
GET/experiment-treatments/{treatmentId}/localizations/{locale}/preview-sets

Proposed · Extended read design · Adapter not implemented

Request

Routes are relative to your connection. Use a facade API key; the service manages Apple authentication.

cURL
BASE='https://asc.example.com/v1/connections/conn_example'

curl --fail-with-body "$BASE/experiment-treatments/treatment_123/localizations/en-US/preview-sets" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

asc.example.com is a placeholder for your deployment. Examples use fictional IDs.

Path parameters

NameTypeDescription
treatmentIdRequiredstringThe selected resource’s ID.
localeRequiredstringThe exact locale to read. No fallback to a different locale.

Query parameters

NameTypeDescription
previewTypeOptionalstringFilter by preview type. Multiple values are comma-separated.
ValuesIPHONE_67, IPHONE_61, IPHONE_65, IPHONE_58, IPHONE_55, IPHONE_47, IPHONE_40, IPHONE_35, IPAD_PRO_3GEN_129, IPAD_PRO_3GEN_11, IPAD_PRO_129, IPAD_105, IPAD_97, DESKTOP, APPLE_TV, APPLE_VISION_PRO
appStoreVersionLocalizationOptionalstringFilter by app store version localization. Multiple values are comma-separated.
appCustomProductPageLocalizationOptionalstringFilter by app custom product page localization. Multiple values are comma-separated.
fieldsOptionalstringComma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.
ValuespreviewType
limitOptional · Default 50integerNumber of items per page, from 1 to 200.
cursorOptionalstringOpaque nextCursor from a previous response. Keep the route, connection, filters, and ordering unchanged.

Response

A page of flat objects, with an opaque continuation cursor.

200 · application/json
{
  "items": [
    {
      "id": "app_preview_set_123",
      "previewType": "IPHONE_67",
      "appStoreVersionLocalizationId": "app_store_version_localization_123",
      "appCustomProductPageLocalizationId": "app_custom_product_page_localization_123",
      "appStoreVersionExperimentTreatmentLocalizationId": "app_store_version_experiment_treatment_localization_123"
    }
  ],
  "nextCursor": null
}

Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.

Response fields

NameTypeDescription
itemsobject[]The current page of plain resource objects. An empty collection returns [].
nextCursorstring | nullOpaque continuation token, or null when the collection is complete. Pass it back as cursor.

Each item

NameTypeDescription
idstringApple’s resource ID. Keep this string unchanged when addressing a resource.
previewTypestringThe device format used by this preview set.
ValuesIPHONE_67, IPHONE_61, IPHONE_65, IPHONE_58, IPHONE_55, IPHONE_47, IPHONE_40, IPHONE_35, IPAD_PRO_3GEN_129, IPAD_PRO_3GEN_11, IPAD_PRO_129, IPAD_105, IPAD_97, DESKTOP, APPLE_TV, APPLE_VISION_PRO
appStoreVersionLocalizationIdOptional linkagestring | nullID of the related app store version localization. Present only when Apple supplies linkage; related objects are not loaded automatically.
appCustomProductPageLocalizationIdOptional linkagestring | nullID of the related app custom product page localization. Present only when Apple supplies linkage; related objects are not loaded automatically.
appStoreVersionExperimentTreatmentLocalizationIdOptional linkagestring | nullID of the related app store version experiment treatment localization. Present only when Apple supplies linkage; related objects are not loaded automatically.

Behavior

  • Resolve the exact locale within the selected parent, validate ownership, and read the resolved localization. No match returns localization_not_found; multiple matches return ambiguous_selection. GET does not create a locale or substitute another language.

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

HTTPTypeDescription
400invalid_queryUnsupported filter, sort, limit, or cursor.
401unauthorizedMissing or invalid facade API key.
403forbidden / upstream_forbiddenThe caller or configured Apple key cannot read this resource.
404localization_not_foundThe requested resource, parent, or exact locale is absent or outside the caller’s scope.
409ambiguous_selectionMore than one localization matches the selected parent and locale.
429rate_limitedA facade or Apple rate limit was reached. Respect Retry-After when returned.
502–504upstream errorApple authentication, response parsing, availability, or timeout failure; this is not an empty result.

Apple mapping

Upstream route and translation

The adapter calls GET /v1/appStoreVersionExperimentTreatmentLocalizations/{id}/appPreviewSets. Read Apple’s original endpoint ↗

Resolve the parent’s localization collection using the exact locale, validate ownership, and then supply the resolved ID to this Apple 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 parameterTypeDescription
previewTypequeryfilter[previewType]
appStoreVersionLocalizationqueryfilter[appStoreVersionLocalization]
appCustomProductPageLocalizationqueryfilter[appCustomProductPageLocalization]
fieldsqueryfields[appPreviewSets]
limitquerylimit
cursorqueryFacade-owned pagination

Reviewed 2026-10-14 · OpenAPI 4.5.1