Skip to main content
GET
/
benchmarks
List benchmarks
curl --request GET \
  --url https://app.azalt.co/api/v1/benchmarks \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "indicatorId": "<string>",
    "entityId": "<string>",
    "organizationId": "<string>",
    "sourceName": "<string>",
    "sourceDescription": "<string>",
    "sourceUrl": "<string>",
    "metadata": {},
    "benchmarkEntries": [
      {
        "year": 123,
        "value": 123
      }
    ],
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "entity": {
      "id": "<string>",
      "organizationId": "<string>",
      "name": "<string>",
      "description": "<string>",
      "color": "<string>",
      "url": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

indicatorId
string
year
number

Response

Successful response

id
string
required
indicatorId
string | null
required
entityId
string | null
required
organizationId
string
required
sourceName
string
required
sourceDescription
string | null
required
sourceUrl
string | null
required
metadata
object
required
benchmarkEntries
object[]
required
createdAt
string
required
updatedAt
string
required
entity
object