POST/v1/reports/preview

Run an unsaved report definition

Answers the numbers for a report definition that has NOT been saved and may never be — the ad-hoc "count these, grouped by that". The body IS the definition, not wrapped in anything: {source, measures, dimensions, filters, limit}, built from get_reports_catalogue. Saves nothing. Use post_reports_views_id_run for a report the workspace already keeps, and post_reports_views to store this definition once it is right.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Request body

application/jsonrequired

bodyoptional

paramsobjectoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "result": {
      "columns": [
        "string"
      ],
      "rows": [
        {
          "count_count": 1.5,
          "funded_rate": 1.5
        }
      ],
      "truncated": true
    }
  }
}

datarequired

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired