Bitrise Insights API
Public, read-only API for Bitrise Insights build and test metrics.
AuthenticationClick to copy link
Send a Bitrise API token in the Authorization header, either as
Authorization: Bearer <token> or bare as Authorization: <token>. Both forms are
accepted.
Both personal access tokens and workspace API tokens work; the token must have view
access to the workspace in the path and to the project it is queried with.
A missing or malformed header answers 401; a token that is rejected, expired or not
entitled to the workspace or project answers 403.
RequirementsClick to copy link
The Insights API is part of a paid Insights plan. A workspace without one gets 402 on every endpoint.
Rate limitingClick to copy link
Requests are rate limited per token: 60 requests per minute, across every endpoint
and workspace the token is used with. Every response to a request carrying a
well-formed token carries X-RateLimit-Limit, X-RateLimit-Remaining and
X-RateLimit-Reset - the limiter runs once the token is known, so a 401 for a
missing or malformed header has none. Over the limit the API answers 429 with a
Retry-After header.
ConventionsClick to copy link
Every call reports on exactly one project, named by the required project parameter.
Timestamps are RFC3339 in UTC, both in requests and in responses. Durations are
seconds and rates are percentages in 0-100. Filter parameters that accept several
values are repeated rather than comma-separated: branch=main&branch=develop.
The branch filter accepts * as a wildcard matching any run of characters:
branch=release/* matches every release branch.
Responses are long format: one row type per endpoint, and grouping adds a label to
each row instead of changing its shape.
AuthenticationClick to copy link
- API Key: BearerAuth
A Bitrise API token - a personal access token or a workspace API token. Enter it as Bearer <token> or bare as <token>; both are accepted.
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | Authorization |