buildnote

Appearance

Jobs (aggregated)​

GET
/v1/data/jobs/aggregated

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

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"
interval

Interval of aggregation bucket (in milliseconds).

Typeinteger
Format"int64"
org*

Organisation name

Typestring
Required
project*

Project name

Typestring
Required
module*

Module name

Typestring
Required
pipeline*

Pipeline name

Typestring
Required
aggregateBy

Job aggregation key (defaults to jobName)

Typestring
Valid values
"jobName""runner"
Example"jobName"

Responses​

OK

application/json
JSON
{
"jobs": [
{
"timestamp": 1733220930000,
"name": "Run tests",
"jobId": "example-statistic-id",
"successfulCount": 0,
"failedCount": 0,
"skippedCount": 0,
"cancelledCount": 0,
"runningCount": 0,
"unknownCount": 0,
"totalCount": 0,
"durationMin": 0,
"durationMax": 0,
"durationAvg": 0,
"durationP25": 0,
"durationP50": 0,
"durationP75": 0,
"durationP95": 0,
"durationP99": 0
}
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python