Dimension Values

The dimension values resource.

Basehttps://rest.carbon.ms/dimensionValues

GET/dimensionValues

List dimension valuess

Retrieve a paginated list of dimension valuess. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/dimensionValues

curl --request GET \
  --url 'https://rest.carbon.ms/dimensionValues?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "dimensionId": "xyz789",
    "valueId": "xyz789",
    "dimensionName": "string",
    "entityType": "string",
    "companyGroupId": "xyz789",
    "valueName": "string"
  }
]

GET/dimensionValues

Retrieve a dimension values

Fetch a single dimension values by filtering on `dimensionId`.

Query parameters

dimensionIdstring

Match on the dimension values's `dimensionId`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/dimensionValues

curl --request GET \
  --url 'https://rest.carbon.ms/dimensionValues?dimensionId=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "dimensionId": "xyz789",
  "valueId": "xyz789",
  "dimensionName": "string",
  "entityType": "string",
  "companyGroupId": "xyz789",
  "valueName": "string"
}