Run report view

POST/api/reports/run-view

Runs one report insight and returns tabular rows plus execution metadata.

Request Body

application/json

Request payload for Run report view.

dashboardKey*string

Dashboard or report handle used for cache scoping.

Length1 <= length

reportData*unknown

report data.

viewId*string

Report view identifier within the report definition.

Length1 <= length

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/reports/run-view" \  -H "Content-Type: application/json" \  -d '{    "dashboardKey": "sales",    "reportData": null,    "viewId": "recent-orders"  }'

{
  "source": "sql",
  "viewId": "recent-orders",
  "sql": "select id, number from orders limit 25",
  "compiledSql": "select id, number from orders limit 25",
  "params": {},
  "table": {
    "columns": [
      "customer_name"
    ],
    "rows": [
      [
        "Acme"
      ]
    ]
  },
  "rows": [
    {}
  ],
  "rowCount": 0,
  "executionTimeMs": 0,
  "cached": true,
  "truncated": false,
  "warnings": [
    "Result truncated to maxRows."
  ]
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Run report view

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`