Workspace

App Store Connect engagement for one of your iOS apps (Agency plan)

App Analytics for one of your own iOS apps — same numbers as the Engagement page: impressions → product page views → downloads with conversion rates (page_view_rate, download_rate) and App Store search share, impressions by source, and installs, deletions and sessions by day. Impressions follow App Store Connect's definition and INCLUDE product page views, so totals reconcile with App Store Connect; downloads come from the Sales report. Needs an App Store Connect connection with an Admin-role key. Every response carries status (ready | not_connected | not_ios | app_not_in_account | pending | key_lacks_analytics) and a human-readable message when not ready, instead of an empty series; days Apple hasn't reported have reported: false and null metrics. Requires the Agency plan — 403 on other plans.

get/api/v1/apps/{id}/engagement

Request

  • Base URL: https://api.trysonar.app
  • URL: https://api.trysonar.app/api/v1/apps/{id}/engagement
  • Auth: HTTP bearer

Path parameters

idstring required

Sonar app UUID or store id (bundle id) of one of your own tracked iOS apps

Query parameters

startstring date

First day of the window, YYYY-MM-DD (inclusive). Defaults to days back from end.

endstring date

Last day of the window, YYYY-MM-DD (inclusive). Defaults to yesterday (UTC).

daysinteger

Window length in days when start is omitted (1-366, default 30)

store'ios' | 'android'

Disambiguates a store id tracked in both stores

Response

{ app_id, app_name, store, status, connected, message, apple_app_id, last_synced_at, range: { start, end }, reported_days, totals: { impressions, product_page_views, downloads, installs, deletions, sessions } | null, rates: { page_view_rate, download_rate, search_share } | null, sources: [{ source_type, impressions, product_page_views, share_of_impressions }], days: [{ date, reported, impressions, product_page_views, installs, deletions, sessions, downloads }] }

dataobject required

Result payload — full field reference at https://trysonar.app/docs/api

Changes

No recorded changes to this operation across all 1 revision of this API.