Skip to main content
POST
Record a measured build

Authorizations

Authorization
string
header
required

A project token (apsio_pt_v0...), which reads exactly one project, or an OAuth access token issued for the API, which reads what its user can. Access tokens issued for Apsio's MCP server are accepted only from the MCP server itself.

Path Parameters

projectId
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"0192f3a4-0000-7000-8000-00000000a101"

Body

application/json
app_id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
format
enum<string>
required

The artefact measured. Only runs of one format are compared: an .ipa or .aab is not what a user downloads, as the store cuts each device's copy from it, so its sizes say how a build changed, not what a user gets.

Available options:
ipa,
apk,
aab
release
string
required
Required string length: 1 - 128
binary_bytes
integer
required
Required range: x <= 9007199254740991
install_bytes
integer
required
Required range: x <= 9007199254740991
build
string
Required string length: 1 - 128
commit_sha
string
Pattern: ^[0-9a-f]{7,64}$
Example:

"9b311d2"

branch
string
Required string length: 1 - 255
warn_percent
number

The rise that warns, in percent; 5 unless set.

Required range: x <= 1000
base_branch
string
Required string length: 1 - 255
baseline_release
string
Required string length: 1 - 128
baseline_build
string
Required string length: 1 - 128

Response

Recorded, with its comparison.

The earlier run of the same format it is compared with; null when there is none.

id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
release
string
required

service.version

Example:

"4.12.0"

build
string | null
required
commit_sha
string | null
required
branch
string | null
required
binary_bytes
integer
required

The artefact on disk, in bytes.

install_bytes
integer
required

The artefact's contents unpacked, in bytes.

created_at
string
required

RFC 3339 time in UTC.

app_id
string
required
Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
format
enum<string>
required

The artefact measured. Only runs of one format are compared: an .ipa or .aab is not what a user downloads, as the store cuts each device's copy from it, so its sizes say how a build changed, not what a user gets.

Available options:
ipa,
apk,
aab
warn_percent
number
required

The rise this run warns at, in percent.

baseline
object | null
required

The earlier run of the same format it is compared with; null when there is none.

change
object | null
required