Skip to content

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",
"tags": [
[
"example-tag"
]
]
}
]
}

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python