Get the performance overview for an app

GET/apps/{appId}/performance-overviews

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/apps/1234567890/performance-overviews" \
  -H "Authorization: Bearer $ASC_FACADE_KEY"

const base = "https://asc.example.com/v1/connections/conn_example";
const response = await fetch(`${base}/apps/1234567890/performance-overviews`, {
  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}/apps/1234567890/performance-overviews",
    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 error

asc.example.com is a placeholder for your deployment. Examples use fictional IDs.

Path parameters

Name	Type	Description
appIdRequired	`string`	Apple’s app ID. Returned by List apps.

Query parameters

Name	Type	Description
deviceTypeOptional	`string`	Filter by device type. Multiple values are comma-separated.

Response

Structured metric data, with series and dimension values preserved.

{
  "version": "1.0",
  "appMetadata": {
    "bundleId": "com.example.notes",
    "appId": "1234567890",
    "latestVersion": "latest_version_example",
    "platform": "platform_example"
  },
  "insights": {
    "regressions": [
      {
        "metricCategory": "HANG",
        "latestVersion": "latest_version_example",
        "metric": "metric_example",
        "summaryString": "summary_string_example",
        "referenceVersions": "reference_versions_example",
        "maxLatestVersionValue": 1
      }
    ],
    "trendingUp": [
      {
        "metricCategory": "HANG",
        "latestVersion": "latest_version_example",
        "metric": "metric_example",
        "summaryString": "summary_string_example",
        "referenceVersions": "reference_versions_example",
        "maxLatestVersionValue": 1
      }
    ]
  },
  "categories": [
    {
      "identifier": "com.example.notes",
      "displayName": "display_name_example",
      "sections": [
        {
          "identifier": "com.example.notes",
          "displayName": "display_name_example",
          "relevanceScore": 1,
          "sortOrder": 1,
          "unit": {
            "identifier": "com.example.notes",
            "displayName": "display_name_example"
          },
          "datasets": []
        }
      ]
    }
  ],
  "signatures": {
    "topHangPoint": [
      {
        "signatureId": "signature_123",
        "signature": "signature_example",
        "count": 1,
        "weight": 1,
        "sourceFile": "source_file_example",
        "lineNumber": 1
      }
    ],
    "topLaunchPoint": [
      {
        "signatureId": "signature_123",
        "signature": "signature_example",
        "count": 1,
        "weight": 1,
        "sourceFile": "source_file_example",
        "lineNumber": 1
      }
    ],
    "topDiskWritePoint": [
      {
        "signatureId": "signature_123",
        "signature": "signature_example",
        "count": 1,
        "weight": 1,
        "sourceFile": "source_file_example",
        "lineNumber": 1
      }
    ]
  },
  "telemetryIdentifier": "telemetry_identifier_example"
}

Illustrative response. Optional read fields may be absent or null; unknown enum values are preserved.

Response fields

Name	Type	Description
version	`string`	The format version of this metrics response.
appMetadata	`object`	App and platform metadata associated with the performance overview.
insights	`object`	Apple’s performance findings for this resource.
categories	`object[]`	The performance categories included in this overview.
signatures	`object`	Diagnostic signatures used by the reported performance findings.
telemetryIdentifier	`string`	The identifier associated with this telemetry response.

appMetadata fields

Name	Type	Description
bundleIdOptional	`string`	The app’s bundle identifier, such as com.example.notes.
appIdOptional	`string`	The app that owns this resource.
latestVersionOptional	`string`	The latest version value reported by Apple for this resource.
platformOptional	`string`	Apple’s platform value, preserved without renaming.

insights fields

Name	Type	Description
regressionsOptional	`object[]`	The regressions value reported by Apple for this resource.
trendingUpOptional	`object[]`	The trending up value reported by Apple for this resource.

insights.regressions fields

Name	Type	Description
metricCategoryOptional	`string`	The metric category value reported by Apple for this resource. Values `HANG`, `LAUNCH`, `MEMORY`, `DISK`, `BATTERY`, `TERMINATION`, `ANIMATION`, `STORAGE`
latestVersionOptional	`string`	The latest version value reported by Apple for this resource.
metricOptional	`string`	The metric value reported by Apple for this resource.
summaryStringOptional	`string`	The summary string value reported by Apple for this resource.
referenceVersionsOptional	`string`	The reference versions value reported by Apple for this resource.
maxLatestVersionValueOptional	`number`	The max latest version value value reported by Apple for this resource.
subSystemLabelOptional	`string`	The sub system label value reported by Apple for this resource.
highImpactOptional	`boolean`	Whether Apple marks this resource as high impact.
populationsOptional	`object[]`	The populations value reported by Apple for this resource.

insights.regressions.populations fields

Name	Type	Description
deltaPercentageOptional	`number`	The delta percentage value reported by Apple for this resource.
percentileOptional	`string`	The percentile value reported by Apple for this resource.
summaryStringOptional	`string`	The summary string value reported by Apple for this resource.
referenceAverageValueOptional	`number`	The reference average value value reported by Apple for this resource.
latestVersionValueOptional	`number`	The latest version value value reported by Apple for this resource.
deviceOptional	`string`	The device value reported by Apple for this resource.

insights.trendingUp fields

Name	Type	Description
metricCategoryOptional	`string`	The metric category value reported by Apple for this resource. Values `HANG`, `LAUNCH`, `MEMORY`, `DISK`, `BATTERY`, `TERMINATION`, `ANIMATION`, `STORAGE`
latestVersionOptional	`string`	The latest version value reported by Apple for this resource.
metricOptional	`string`	The metric value reported by Apple for this resource.
summaryStringOptional	`string`	The summary string value reported by Apple for this resource.
referenceVersionsOptional	`string`	The reference versions value reported by Apple for this resource.
maxLatestVersionValueOptional	`number`	The max latest version value value reported by Apple for this resource.
subSystemLabelOptional	`string`	The sub system label value reported by Apple for this resource.
highImpactOptional	`boolean`	Whether Apple marks this resource as high impact.
populationsOptional	`object[]`	The populations value reported by Apple for this resource.

insights.trendingUp.populations fields

Name	Type	Description
deltaPercentageOptional	`number`	The delta percentage value reported by Apple for this resource.
percentileOptional	`string`	The percentile value reported by Apple for this resource.
summaryStringOptional	`string`	The summary string value reported by Apple for this resource.
referenceAverageValueOptional	`number`	The reference average value value reported by Apple for this resource.
latestVersionValueOptional	`number`	The latest version value value reported by Apple for this resource.
deviceOptional	`string`	The device value reported by Apple for this resource.

categories fields

Name	Type	Description
identifierOptional	`string`	The identifier value reported by Apple for this resource.
displayNameOptional	`string`	The display name value reported by Apple for this resource.
sectionsOptional	`object[]`	The sections value reported by Apple for this resource.

categories.sections fields

Name	Type	Description
identifierOptional	`string`	The identifier value reported by Apple for this resource.
displayNameOptional	`string`	The display name value reported by Apple for this resource.
relevanceScoreOptional	`number`	The relevance score value reported by Apple for this resource.
sortOrderOptional	`integer`	The sort order value reported by Apple for this resource.
unitOptional	`object`	The unit value reported by Apple for this resource.
datasetsOptional	`object[]`	The datasets value reported by Apple for this resource.

categories.sections.unit fields

Name	Type	Description
identifierOptional	`string`	The identifier value reported by Apple for this resource.
displayNameOptional	`string`	The display name value reported by Apple for this resource.

categories.sections.datasets fields

Name	Type	Description
filterCriteriaOptional	`object`	The filter criteria value reported by Apple for this resource.
pointsOptional	`object[]`	The points value reported by Apple for this resource.
recommendedMetricGoalOptional	`object`	The recommended metric goal value reported by Apple for this resource.

categories.sections.datasets.filterCriteria fields

Name	Type	Description
percentileOptional	`string`	The percentile value reported by Apple for this resource.
deviceOptional	`string`	The device value reported by Apple for this resource.
deviceMarketingNameOptional	`string`	The device marketing name value reported by Apple for this resource.

categories.sections.datasets.points fields

Name	Type	Description
versionOptional	`string`	The uploaded build’s version string; this is separate from the store versionString.
valueOptional	`number`	The value value reported by Apple for this resource.
errorMarginOptional	`number`	The error margin value reported by Apple for this resource.
percentageBreakdownOptional	`object`	The percentage breakdown value reported by Apple for this resource.

categories.sections.datasets.recommendedMetricGoal fields

Name	Type	Description
valueOptional	`number`	The value value reported by Apple for this resource.
detailOptional	`string`	The detail value reported by Apple for this resource.

signatures fields

Name	Type	Description
topHangPointOptional	`object[]`	The top hang point value reported by Apple for this resource.
topLaunchPointOptional	`object[]`	The top launch point value reported by Apple for this resource.
topDiskWritePointOptional	`object[]`	The top disk write point value reported by Apple for this resource.

signatures.topHangPoint fields

Name	Type	Description
signatureIdOptional	`string`	The ID of the selected signature.
signatureOptional	`string`	The signature value reported by Apple for this resource.
countOptional	`integer`	The count value reported by Apple for this resource.
weightOptional	`number`	The weight value reported by Apple for this resource.
sourceFileOptional	`string`	The source file value reported by Apple for this resource.
lineNumberOptional	`integer`	The line number value reported by Apple for this resource.
trendInfoOptional	`string`	The trend info value reported by Apple for this resource. Values `UP`, `DOWN`, `UNDEFINED`
metricsSummaryOptional	`object`	The metrics summary value reported by Apple for this resource.

signatures.topHangPoint.metricsSummary fields

Name	Type	Description
referenceVersionsOptional	`object[]`	The reference versions value reported by Apple for this resource.

signatures.topHangPoint.metricsSummary.referenceVersions fields

Name	Type	Description
versionOptional	`string`	The uploaded build’s version string; this is separate from the store versionString.
valueOptional	`number`	The value value reported by Apple for this resource.

signatures.topLaunchPoint fields

Name	Type	Description
signatureIdOptional	`string`	The ID of the selected signature.
signatureOptional	`string`	The signature value reported by Apple for this resource.
countOptional	`integer`	The count value reported by Apple for this resource.
weightOptional	`number`	The weight value reported by Apple for this resource.
sourceFileOptional	`string`	The source file value reported by Apple for this resource.
lineNumberOptional	`integer`	The line number value reported by Apple for this resource.
trendInfoOptional	`string`	The trend info value reported by Apple for this resource. Values `UP`, `DOWN`, `UNDEFINED`
metricsSummaryOptional	`object`	The metrics summary value reported by Apple for this resource.

signatures.topLaunchPoint.metricsSummary fields

Name	Type	Description
referenceVersionsOptional	`object[]`	The reference versions value reported by Apple for this resource.

signatures.topLaunchPoint.metricsSummary.referenceVersions fields

Name	Type	Description
versionOptional	`string`	The uploaded build’s version string; this is separate from the store versionString.
valueOptional	`number`	The value value reported by Apple for this resource.

signatures.topDiskWritePoint fields

Name	Type	Description
signatureIdOptional	`string`	The ID of the selected signature.
signatureOptional	`string`	The signature value reported by Apple for this resource.
countOptional	`integer`	The count value reported by Apple for this resource.
weightOptional	`number`	The weight value reported by Apple for this resource.
sourceFileOptional	`string`	The source file value reported by Apple for this resource.
lineNumberOptional	`integer`	The line number value reported by Apple for this resource.
trendInfoOptional	`string`	The trend info value reported by Apple for this resource. Values `UP`, `DOWN`, `UNDEFINED`
metricsSummaryOptional	`object`	The metrics summary value reported by Apple for this resource.

signatures.topDiskWritePoint.metricsSummary fields

Name	Type	Description
referenceVersionsOptional	`object[]`	The reference versions value reported by Apple for this resource.

signatures.topDiskWritePoint.metricsSummary.referenceVersions fields

Name	Type	Description
versionOptional	`string`	The uploaded build’s version string; this is separate from the store versionString.
valueOptional	`number`	The value value reported by Apple for this resource.

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/apps/{id}/performanceOverviews. Read Apple’s original endpoint ↗

Apple returns application/vnd.apple.xcode-overview+json. The adapter retains the metric-series structure, removes transport envelopes where present, and exposes dimension linkage as IDs.

Facade parameter	Type	Description
deviceType	`query`	`filter[deviceType]`

Reviewed 2026-10-14 · OpenAPI 4.5.1