Run Operations

Execute reports with parameters to generate output.

POST /api/reports/{id}/_run

Execute a report with optional parameters.

Authentication: Required

Path Parameters:

Parameter	Type	Description
`id`	string	Report ID

Request Body:

{
  "progress": "progress-monitor-id",
  "params": {
    "startDate": "2024-01-01",
    "endDate": "2024-12-31",
    "region": "West"
  }
}

Fields:

Field	Type	Required	Description
`progress`	string	No	Progress monitor ID for tracking execution
`params`	object	No	Input parameters for the report

Response:

Returns the report object after execution:

{
  "id": "team:sales-dashboard",
  "type": "dashboard",
  "name": "Sales Dashboard",
  "defn": {
    "visuals": []
  },
  "_links": {
    "self": { "href": "/api/reports/team:sales-dashboard" }
  }
}

Behavior:

Executes the report with provided parameters
Sends progress updates to the specified progress monitor
Report drivers determine actual execution behavior (query refresh, visualization rendering, etc.)
May be a long-running operation depending on report complexity and data volume

Use Case:

Run a report to refresh data, generate visualizations, or execute scheduled operations.

HAL Query Template:

The report's HAL representation includes a query template: {?progress}

Notes:

Not all report types support execution (check for inf:report-run link)
Report drivers can implement custom run behavior via the run method
Progress monitoring allows clients to display real-time status updates

POST /api/reports/{id}/_run​

POST /api/reports/{id}/_run