The Analytics Reports API gives you programmatic access to 140+ report types: App Downloads, App Sessions, Commerce, App Store Engagement, Framework Usage, and more. Data is split into segments with downloadable URLs (gzip TSV).
Role required: Admin, Finance, or Sales and Reports. New report requests may take 24–48 hours before data is available.
Flow Overview
1. List/Create report request for your app
2. List reports for the request (e.g. "App Downloads Standard")
3. List instances for a report (daily, weekly, monthly granularity)
4. List segments for an instance
5. Download segment URL (gzip TSV with actual data)
List Report Requests
GET /v1/connect/apps/:appId/analytics/report-requests
Query Parameters
| Name | Type | Description |
|---|
| accessType | string | Filter: ONGOING or ONE_TIME_SNAPSHOT |
| limit | integer | Max results (default 50) |
Response
{
"data": {
"data": [
{
"type": "analyticsReportRequests",
"id": "7e9b84a2-b441-49ce-a723-649fa483029c",
"attributes": {
"accessType": "ONGOING",
"stoppedDueToInactivity": false
}
}
]
}
}
Create Report Request
POST /v1/connect/apps/:appId/analytics/report-requests
Request Body
{
"accessType": "ONGOING"
}
| Field | Type | Description |
|---|
| accessType | string | ONGOING (daily reports) or ONE_TIME_SNAPSHOT (historical) |
List Reports for Request
GET /v1/connect/analytics/report-requests/:requestId/reports
Query Parameters
| Name | Type | Description |
|---|
| category | string | APP_USAGE, COMMERCE, APP_STORE_ENGAGEMENT, FRAMEWORK_USAGE, PERFORMANCE |
| limit | integer | Max results (default 50) |
Example Report Types
| Category | Examples |
|---|
| COMMERCE | App Downloads Standard, App Store Purchases, Pre-Orders |
| APP_USAGE | App Sessions, Installation and Deletion |
| APP_STORE_ENGAGEMENT | Discovery and Engagement |
| FRAMEWORK_USAGE | Home Screen Widgets, Spatial Audio, etc. |
| PERFORMANCE | App Install Performance |
List Report Instances
GET /v1/connect/analytics/reports/:reportId/instances
Path Parameters
| Name | Type | Description |
|---|
| reportId | string | Report ID (e.g. r3-7e9b84a2-b441-49ce-a723-649fa483029c) |
List Segments
GET /v1/connect/analytics/report-instances/:instanceId/segments
Response
{
"data": {
"data": [
{
"type": "analyticsReportSegments",
"id": "...",
"attributes": {
"url": "https://...",
"checksum": "...",
"sizeInBytes": 1234
}
}
]
}
}
Download Report Data
- Take the
url from a segment
- Fetch with your JWT (or the segment URL may be pre-signed by Apple)
- Decompress the gzip response
- Parse the TSV (tab-separated values)
Get Segment Details
GET /v1/connect/analytics/report-segments/:segmentId
Code Example
# 1. Create report request (if none exists)
curl -X POST "https://api.appeeky.com/v1/connect/apps/6759740679/analytics/report-requests" \
-H "X-API-Key: YOUR_APEEKY_KEY" \
-H "X-ASC-Issuer-Id: YOUR_ISSUER_ID" \
-H "X-ASC-Key-Id: YOUR_KEY_ID" \
-H "X-ASC-Private-Key: YOUR_PRIVATE_KEY" \
-H "Content-Type: application/json" \
-d '{"accessType":"ONGOING"}'
# 2. List reports (e.g. filter by COMMERCE)
curl -X GET "https://api.appeeky.com/v1/connect/analytics/report-requests/7e9b84a2.../reports?category=COMMERCE" \
-H "X-API-Key: YOUR_APEEKY_KEY" \
-H "X-ASC-Issuer-Id: YOUR_ISSUER_ID" \
-H "X-ASC-Key-Id: YOUR_KEY_ID" \
-H "X-ASC-Private-Key: YOUR_PRIVATE_KEY"
Credits
| Endpoint | Credits |
|---|
| GET report-requests | 2 |
| POST report-requests | 3 |
| GET reports | 2 |
| GET instances | 2 |
| GET segments | 2 |
| GET segment | 1 |
