v1

latestOpenAPI 3.1.02026-07-24121425.6 KB

PR analysis data

Returns the app size analysis results and any performance test analysis results, as well as PR comments. This endpoint should be used in favor of /comment, as it provides a superset of the data. Further, instead of returning a 4xx response when it's not ready yet (which is what /comment does), it will return a 200 response and indicate within the JSON which jobs are still in progress. Must specify either sha or emergeId.

get/analysis

Query parameters

shastring

The SHA of the new PR commit

emergeIdstring

The Emerge ID of the HEAD build.

baseShastring

The SHA of the merge base for the PR. If not present, the base SHA provided on upload will be used to determine the base build.

baseEmergeIdstring

The Emerge ID of the base build. If not present, the base SHA provided on upload will be used to determine the base build.

platformstring

'ios' or 'android'. If multiple uploads are found for a sha (usually in the case of a monorepo), analysis for the first upload matching the platform will be returned. If not present and multiple uploads are found, an error will be thrown.

appIdstring

Bundle or package id of the app - like com.example.app. If multiple uploads are found for a sha (usually in the case of a monorepo), analysis for the first upload matching the appId will be returned. If not present and multiple uploads are found, an error will be thrown.

Response

Success

All 12 operations