Contents

List all in-app events for an app

Get a list of in-app events for a specific app.

URL

GET https://api.appstoreconnect.apple.com/v1/apps/{id}/appEvents

Path Parameters

NameTypeDescription
id Requiredstring

An opaque resource ID that uniquely identifies the resource. Obtain the app resource ID from the List apps response.

Query Parameters

NameTypeDescription
fields[appEventLocalizations] Optional[string]

Additional fields to include for each app event localization resource returned by the response.

fields[appEvents] Optional[string]

Additional fields to include for each app event resource returned by the response.

filter[eventState] Optional[string]

Filter the returned app events by event state.

filter[id] Optional[string]

Filter the returned app events by ID.

include Optional[string]

The relationship data to include in the response.

limit Optionalinteger

The maximum number of app event resources to return.

limit[localizations] Optionalinteger

The maximum number of related localizations resources to return.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
AppEventsResponse

400Bad Request
Content-Type: application/json
ErrorResponse

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

404Not Found
Content-Type: application/json
ErrorResponse

429
Content-Type: application/json
ErrorResponse

See Also

Getting app event information