buildnote

Appearance

v1.0

Buildnote Data API​

Download OpenAPI Document

OpenApi specification for the Buildnote Data API

Servers​

https://data.buildnote.io

Get builds​

GET
/v1/data/builds

Returns a list of all builds within the module.

Authorizations​

Buildnote-Api-Key
TypeAPI Key (header: Buildnote-Api-Key)

Parameters​

Query Parameters

fromTs

Unix timestamp (in milliseconds) defining beginning of time range.

Typeinteger
Format"int64"
toTs

Unix timestamp (in milliseconds) defining end of time range.

Typeinteger
Format"int64"
org*

Organisation name

Typestring
Required
project*

Project name

Typestring
Required
module*

Module name

Typestring
Required

Responses​

OK

application/json
JSON
{
"builds": [
[
"example-build-id"
]
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Get jobs​

GET
/v1/data/jobs

Returns a list of all jobs for a given module and pipeline.

Authorizations​

Buildnote-Api-Key
TypeAPI Key (header: Buildnote-Api-Key)

Parameters​

Query Parameters

fromTs

Unix timestamp (in milliseconds) defining beginning of time range.

Typeinteger
Format"int64"
toTs

Unix timestamp (in milliseconds) defining end of time range.

Typeinteger
Format"int64"
org*

Organisation name

Typestring
Required
project*

Project name

Typestring
Required
module*

Module name

Typestring
Required
pipeline*

Pipeline name

Typestring
Required

Responses​

OK

application/json
JSON
{
"jobs": [
{
"id": "00000000-0000-0000-0000-000000000000",
"timestamp": 1733220930000,
"build": "example-build-id",
"ref": "refs/heads/main",
"submitter": "user:example-user",
"name": "Run tests",
"duration": 22300,
"status": "successful",
"runner": {
"labels": [
[
"ubuntu-latest"
]
]
}
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Get modules​

GET
/v1/data/modules

Returns a list of all modules within the project.

Authorizations​

Buildnote-Api-Key
TypeAPI Key (header: Buildnote-Api-Key)

Parameters​

Query Parameters

fromTs

Unix timestamp (in milliseconds) defining beginning of time range.

Typeinteger
Format"int64"
toTs

Unix timestamp (in milliseconds) defining end of time range.

Typeinteger
Format"int64"
org*

Organisation name

Typestring
Required
project*

Project name

Typestring
Required

Responses​

OK

application/json
JSON
{
"modules": [
[
"example-module-id"
]
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Get organisations​

GET
/v1/data/orgs

Returns a list of all organisations for the associated team.

Authorizations​

Buildnote-Api-Key
TypeAPI Key (header: Buildnote-Api-Key)

Parameters​

Query Parameters

fromTs

Unix timestamp (in milliseconds) defining beginning of time range.

Typeinteger
Format"int64"
toTs

Unix timestamp (in milliseconds) defining end of time range.

Typeinteger
Format"int64"

Responses​

OK

application/json
JSON
{
"orgs": [
[
"example-org-id"
]
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Get pipelines​

GET
/v1/data/pipelines

Returns a list of all pipelines for a given module.

Authorizations​

Buildnote-Api-Key
TypeAPI Key (header: Buildnote-Api-Key)

Parameters​

Query Parameters

fromTs

Unix timestamp (in milliseconds) defining beginning of time range.

Typeinteger
Format"int64"
toTs

Unix timestamp (in milliseconds) defining end of time range.

Typeinteger
Format"int64"
org*

Organisation name

Typestring
Required
project*

Project name

Typestring
Required
module*

Module name

Typestring
Required

Responses​

OK

application/json
JSON
{
"pipelines": [
{
"id": "00000000-0000-0000-0000-000000000000",
"timestamp": 1733220930000,
"build": "example-build-id",
"ref": "refs/heads/main",
"submitter": "user:example-user",
"name": "Build",
"duration": 22300,
"status": "successful"
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Get projects​

GET
/v1/data/projects

Returns a list of all projects within the organisations for the associated team.

Authorizations​

Buildnote-Api-Key
TypeAPI Key (header: Buildnote-Api-Key)

Parameters​

Query Parameters

fromTs

Unix timestamp (in milliseconds) defining beginning of time range.

Typeinteger
Format"int64"
toTs

Unix timestamp (in milliseconds) defining end of time range.

Typeinteger
Format"int64"
org*

Organisation name

Typestring
Required

Responses​

OK

application/json
JSON
{
"projects": [
[
"example-project-id"
]
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Get properties​

GET
/v1/data/properties

Returns a list of property values for a given project.

Authorizations​

Buildnote-Api-Key
TypeAPI Key (header: Buildnote-Api-Key)

Parameters​

Query Parameters

fromTs

Unix timestamp (in milliseconds) defining beginning of time range.

Typeinteger
Format"int64"
toTs

Unix timestamp (in milliseconds) defining end of time range.

Typeinteger
Format"int64"
org*

Organisation name

Typestring
Required
project*

Project name

Typestring
Required
module

Module name

Typestring
ref

Git ref

Typestring

Responses​

OK

application/json
JSON
{
"properties": [
{
"id": "00000000-0000-0000-0000-000000000000",
"timestamp": 1733220930000,
"build": "example-build-id",
"ref": "refs/heads/main",
"name": "Code Coverage",
"submitter": "user:example-user",
"value": "87.76",
"type": "number"
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Get test statistics​

GET
/v1/data/tests

Returns a list of overall test statistics by build for a given module.

Authorizations​

Buildnote-Api-Key
TypeAPI Key (header: Buildnote-Api-Key)

Parameters​

Query Parameters

fromTs

Unix timestamp (in milliseconds) defining beginning of time range.

Typeinteger
Format"int64"
toTs

Unix timestamp (in milliseconds) defining end of time range.

Typeinteger
Format"int64"
org*

Organisation name

Typestring
Required
project*

Project name

Typestring
Required
module*

Module name

Typestring
Required

Responses​

OK

application/json
JSON
{
"tests": [
{
"timestamp": 1733220930000,
"build": "example-build-id",
"ref": "refs/heads/main",
"successfulCount": 123,
"successfulDuration": 2355,
"failedCount": 1,
"failedDuration": 345,
"skippedCount": 0,
"skippedDuration": 0,
"totalCount": 124,
"totalDuration": 2700
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python