Skip to main content
POST
/
benchmarks
Create benchmark
curl --request POST \
  --url https://app.azalt.co/api/v1/benchmarks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceName": "<string>",
  "benchmarkEntries": [
    {
      "year": 123,
      "value": 123
    }
  ],
  "indicatorId": "<string>",
  "entityId": "<string>",
  "sourceDescription": "<string>",
  "sourceUrl": "<string>",
  "metadata": {}
}
'
{
  "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.

Body

application/json
sourceName
string
required
Minimum string length: 1
benchmarkEntries
object[]
required
Minimum array length: 1
indicatorId
string
entityId
string
sourceDescription
string
sourceUrl
metadata
object

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