Report View

The report view resource.

Basehttps://rest.carbon.ms/reportView

GET/reportView

List report views

Retrieve a paginated list of report views. 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/reportView

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "reportKey": "string",
    "name": "Example",
    "config": "string",
    "visibility": "string",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z"
  }
]

GET/reportView

Retrieve a report view

Fetch a single report view by filtering on `id`.

Query parameters

idstring

Match on the report view's `id`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/reportView

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "reportKey": "string",
  "name": "Example",
  "config": "string",
  "visibility": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

POST/reportView

Create a report view

Create a new report view.

Body parameters

reportKeystringrequired

namestringrequired

configobjectrequired

visibilityreportViewVisibilityrequired

POSThttps://rest.carbon.ms/reportView

curl --request POST \
  --url https://rest.carbon.ms/reportView \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"reportKey":"string","name":"Example","config":"string","visibility":"string"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "reportKey": "string",
  "name": "Example",
  "config": "string",
  "visibility": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

PATCH/reportView

Update a report view

Update an existing report view, matched on `id`.

Body parameters

reportKeystringrequired

namestringrequired

configobjectrequired

visibilityreportViewVisibilityrequired

PATCHhttps://rest.carbon.ms/reportView

curl --request PATCH \
  --url 'https://rest.carbon.ms/reportView?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"reportKey":"string"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "reportKey": "string",
  "name": "Example",
  "config": "string",
  "visibility": "string",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z"
}

DELETE/reportView

Delete a report view

Delete a report view, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the report view to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/reportView

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

204 No Content