AppSkyline API reference

Apple App Store engagement rows

Downloads/sessions engagement rows for your organization, optionally filtered by appId and a days cutoff. Requires the stats:read scope.

List apps

Lists the apps of your organization. Requires the apps:read scope.

Create an app

Requires the apps:write scope.

Get an app by id

Requires the apps:read scope.

Update an app

Requires the apps:write scope.

Read multiple collections in one request

Executes an array of authenticated read operations and returns an object keyed by each operation alias. Only the allowlisted app, keyword, preference, role and metadata collections can be read.

List keywords

Lists the tracked keywords of your organization, optionally filtered by appId. Requires the keywords:read scope. For stable traversal, set pagination=cursor; the response becomes {items, nextCursor} and is ordered by _id. Pass nextCursor back as cursor until it is null. The default array response and offset pagination remain unchanged when cursor pagination is not requested.

Create a keyword

Requires the keywords:write scope.

Get a keyword by id

Requires the keywords:read scope.

Update a keyword

Requires the keywords:write scope.

Delete a keyword

Requires the keywords:write scope.

Read sandbox keyword ranks without authentication

Returns a fixed set of demonstration keyword-rank rows in the same {searchTerms, store, country, rank} shape as authenticated keyword reads. No account, credential, or key is required, so agents can evaluate the API before onboarding. Responses carry the standard RateLimit response headers and the anonymous pacing limit applies.

Start a demonstration asynchronous rank check

Demonstrates the API's asynchronous-job pattern without authentication. The response is 202 Accepted with a Location header pointing at the job resource and a body carrying the job _id and status. Poll the Location URL until the status is succeeded, then read the ranks from the job body. The job is deterministic fixture work that completes about two seconds after creation.

Poll a demonstration rank check

Reads the status of a demonstration job started at POST /api/sandbox/rankchecks. While the job runs the status is running; afterwards it is succeeded and the body carries the checked term's rank in every store carrying it. No authentication is required.

List webhook subscriptions

Webhook subscriptions deliver app.created, app.updated, keyword.created, keyword.updated and keyword.deleted events to your server as signed POST requests (X-Appskyline-Signature: t=<timestamp>,v1=<hex HMAC-SHA256 of "timestamp.body">). An endpoint failing 20 times in a row is disabled automatically. Subscriptions are managed with an operator access token; the secret is only returned once, on create.

Create a webhook subscription

The response includes the signing secret exactly once — store it; it cannot be retrieved again.

Update a webhook subscription

url, events and active are editable; the secret and organization are immutable. Re-enabling an auto-disabled endpoint is done by setting active back to true.

Delete a webhook subscription