App Events
Read in-app event information
Read app event information as a flat JSON object.
GET
/events/{eventId}Proposed · Extended 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/events/event_123" \
-H "Authorization: Bearer $ASC_FACADE_KEY"const base = "https://asc.example.com/v1/connections/conn_example";
const response = await fetch(`${base}/events/event_123`, {
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}/events/event_123",
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 |
|---|---|---|
| eventId | 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.ValuesreferenceName, badge, eventState, deepLink, purchaseRequirement, primaryLocale, priority, purpose, territorySchedules, archivedTerritorySchedules |
Response
One flat object for the selected resource.
{
"id": "app_event_123",
"referenceName": "Example subscription",
"badge": "LIVE_EVENT",
"eventState": "DRAFT",
"deepLink": "https://example.com/asset",
"purchaseRequirement": "purchase_requirement_example"
}Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.
Response fields
| Name | Type | Description |
|---|---|---|
| id | string | Apple’s resource ID. Keep this string unchanged when addressing a resource. |
| referenceName | string | The internal reference name configured for this resource. |
| badge | string | The badge value reported by Apple for this resource.ValuesLIVE_EVENT, PREMIERE, CHALLENGE, COMPETITION, NEW_SEASON, MAJOR_UPDATE, SPECIAL_EVENT |
| eventState | string | The event state value reported by Apple for this resource.ValuesDRAFT, READY_FOR_REVIEW, WAITING_FOR_REVIEW, IN_REVIEW, REJECTED, ACCEPTED, APPROVED, PUBLISHED, PAST, ARCHIVED |
| deepLink | string · uri | The deep link URL reported by Apple. |
| purchaseRequirement | string | The purchase requirement value reported by Apple for this resource. |
| primaryLocale | string | The app’s primary locale. It does not cause automatic locale fallback. |
| priority | string | The priority value reported by Apple for this resource.ValuesHIGH, NORMAL |
| purpose | string | The purpose value reported by Apple for this resource.ValuesAPPROPRIATE_FOR_ALL_USERS, ATTRACT_NEW_USERS, KEEP_ACTIVE_USERS_INFORMED, BRING_BACK_LAPSED_USERS |
| territorySchedules | object[] | The territory schedules value reported by Apple for this resource. |
| archivedTerritorySchedules | object[] | The archived territory schedules value reported by Apple for this resource. |
territorySchedules fields
| Name | Type | Description |
|---|---|---|
| territories | string[] | The territories value reported by Apple for this resource. |
| publishStart | string · date-time | Publish start, as an RFC 3339 timestamp. |
| eventStart | string · date-time | Event start, as an RFC 3339 timestamp. |
| eventEnd | string · date-time | Event end, as an RFC 3339 timestamp. |
archivedTerritorySchedules fields
| Name | Type | Description |
|---|---|---|
| territories | string[] | The territories value reported by Apple for this resource. |
| publishStart | string · date-time | Publish start, as an RFC 3339 timestamp. |
| eventStart | string · date-time | Event start, as an RFC 3339 timestamp. |
| eventEnd | string · date-time | Event end, as an RFC 3339 timestamp. |
Behavior
- A nested resource must belong to the selected parent and the configured connection. The adapter validates ownership before returning data.
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/appEvents/{id}. 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[appEvents] |
Reviewed 2026-10-14 · OpenAPI 4.5.1