const base = "https://asc.example.com/v1/connections/conn_example";
const response = await fetch(`${base}/events/event_123/localizations/en-US/event-video-clips`, {
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);
Python
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}/events/event_123/localizations/en-US/event-video-clips",
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 error
asc.example.com is a placeholder for your deployment. Examples use fictional IDs.
Path parameters
Name
Type
Description
eventIdRequired
string
The selected resource’s ID.
localeRequired
string
The exact locale to read. No fallback to a different locale.
Query parameters
Name
Type
Description
fieldsOptional
string
Comma-separated attribute names to return. This selects read fields and does not expand relationships. Multiple values are comma-separated.ValuesfileSize, fileName, previewFrameTimeCode, videoUrl, previewFrameImage, uploadOperations, videoDeliveryState, appEventAssetType
limitOptional · Default 50
integer
Number of items per page, from 1 to 200.
cursorOptional
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.
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.
fileSize
integer
The file size in bytes.
fileName
string
The uploaded file’s name.
previewFrameTimeCode
string
The preview frame time code value reported by Apple for this resource.
videoUrl
string
The video url value reported by Apple for this resource.
previewFrameImage
object
The preview frame image value reported by Apple for this resource.
uploadOperations
object[]
Apple’s recorded upload-operation metadata. A GET does not perform these operations.
videoDeliveryState
object
The video delivery state value reported by Apple for this resource.
appEventAssetType
string
The app event asset type value reported by Apple for this resource.ValuesEVENT_CARD, EVENT_DETAILS_PAGE
appEventLocalizationIdOptional linkage
string | null
ID of the related app event localization. Present only when Apple supplies linkage; related objects are not loaded automatically.
previewFrameImage fields
Name
Type
Description
imageOptional
object
The image value reported by Apple for this resource.
stateOptional
object
The current state reported by Apple for this resource.
previewFrameImage.image fields
Name
Type
Description
templateUrlOptional
string
The template url value reported by Apple for this resource.
widthOptional
integer
The width value reported by Apple for this resource.
heightOptional
integer
The height value reported by Apple for this resource.
previewFrameImage.state fields
Name
Type
Description
errorsOptional
object[]
The errors value reported by Apple for this resource.
warningsOptional
object[]
The warnings value reported by Apple for this resource.
stateOptional
string
The current state reported by Apple for this resource.ValuesPROCESSING, COMPLETE, FAILED
previewFrameImage.state.errors fields
Name
Type
Description
codeOptional
string
The code value reported by Apple for this resource.
descriptionOptional
string
The localized store description.
previewFrameImage.state.warnings fields
Name
Type
Description
codeOptional
string
The code value reported by Apple for this resource.
descriptionOptional
string
The localized store description.
uploadOperations fields
Name
Type
Description
methodOptional
string
The method value reported by Apple for this resource.
urlOptional
string
The url value reported by Apple for this resource.
lengthOptional
integer
The length value reported by Apple for this resource.
offsetOptional
integer
The offset value reported by Apple for this resource.
requestHeadersOptional
object[]
The request headers value reported by Apple for this resource.
uploadOperations.requestHeaders fields
Name
Type
Description
nameOptional
string
The resource’s name. An app’s localized name is read from its app-info localization.
valueOptional
string
The value value reported by Apple for this resource.
videoDeliveryState fields
Name
Type
Description
errorsOptional
object[]
The errors value reported by Apple for this resource.
warningsOptional
object[]
The warnings value reported by Apple for this resource.
stateOptional
string
The current state reported by Apple for this resource.ValuesAWAITING_UPLOAD, UPLOAD_COMPLETE, PROCESSING, COMPLETE, FAILED
videoDeliveryState.errors fields
Name
Type
Description
codeOptional
string
The code value reported by Apple for this resource.
descriptionOptional
string
The localized store description.
videoDeliveryState.warnings fields
Name
Type
Description
codeOptional
string
The code value reported by Apple for this resource.
descriptionOptional
string
The localized store description.
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
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
localization_not_found
The requested resource, parent, or exact locale is absent or outside the caller’s scope.
409
ambiguous_selection
More than one localization matches the selected parent and locale.
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.
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.