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.

Run a reportPOST /api/reports/admin:sales-overview/_run

Executes the report (refreshing its data) and returns the report. Pass progress to stream progress updates and params to supply input values.

Request body

{}

Response · 200

{
  "_links": {
    "self": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_run"
    },
    "inf:owner": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/owner"
    },
    "inf:draft": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/draft"
    },
    "inf:user-settings": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/settings"
    },
    "inf:comments": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/comments{?sort,limit}",
      "templated": true
    },
    "inf:report-shares": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/shares"
    },
    "inf:report-datasets": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/dataset-refs"
    },
    "inf:report-template": {
      "href": "https://informer.example.com/api/reports/template"
    },
    "inf:report-templates": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/templates"
    },
    "inf:input-templates": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/input-templates"
    },
    "inf:visual-templates": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/visual-templates"
    },
    "inf:input-filter-templates": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/input-filter-templates"
    },
    "inf:report-tags": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_run/tags"
    },
    "inf:favorite": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_run/favorite"
    },
    "inf:report-tag": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_run/tags/{tagId}",
      "templated": true
    },
    "inf:export-bundle": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_run/_export"
    },
    "view": {
      "href": "https://informer.example.com/v/report.html?id=00000000-0000-4000-8000-000000000001"
    },
    "inf:cloud-publish": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_run/_cloud-publish"
    },
    "inf:cloud-unpublish": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_run/_cloud-unpublish"
    },
    "inf:copy": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_run/_copy"
    },
    "edit": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_edit"
    },
    "inf:report-share": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_run/shares/{principalId}",
      "templated": true
    },
    "inf:report-run": {
      "href": "https://informer.example.com/api/reports/admin%3Asales-overview/_run{?progress}",
      "templated": true
    }
  },
  "naturalId": "admin:sales-overview",
  "permissions": {
    "assignTags": true,
    "changeOwner": true,
    "cloudPublish": false,
    "copy": true,
    "dataset": true,
    "delete": true,
    "edit": true,
    "filter": true,
    "license": true,
    "rename": true,
    "run": true,
    "share": true,
    "variable": true,
    "visual": true,
    "write": true
  },
  "id": "00000000-0000-4000-8000-000000000001",
  "type": "dashboard",
  "name": "Sales Overview",
  "tenant": "acme",
  "ownerId": "admin",
  "slug": "sales-overview",
  "description": null,
  "defn": {
    "layout": {},
    "visuals": [],
    "layoutOptions": {
      "showVisualOptions": true
    }
  },
  "settings": {
    "overallFilter": {}
  },
  "source": null,
  "sourceId": null,
  "shared": false,
  "defnUpdatedAt": null,
  "enableFilter": false,
  "libraryId": null,
  "createdAt": "2026-01-15T16:20:00.000Z",
  "updatedAt": "2026-01-15T16:20:00.000Z",
  "editingId": null,
  "datasourceId": null,
  "queryId": null,
  "templateId": null,
  "folderId": null,
  "datasource": null,
  "datasets": [
    {
      "id": "00000000-0000-4000-8000-000000000002",
      "filter": {},
      "chips": [],
      "alias": "orders",
      "label": "Orders",
      "tenant": "acme",
      "createdAt": "2026-01-15T16:20:00.000Z",
      "updatedAt": "2026-01-15T16:20:00.000Z",
      "reportId": "00000000-0000-4000-8000-000000000001",
      "datasetId": "00000000-0000-4000-8000-000000000003",
      "snapshots": null
    }
  ],
  "template": null,
  "templates": [],
  "_embedded": {
    "inf:report-type": {
      "_links": {
        "self": {
          "href": "https://informer.example.com/api/report-types/dashboard"
        }
      },
      "id": "dashboard",
      "name": "common:dashboard",
      "description": "reports:dashboard.description",
      "image": "/assets/reports/images/dashboard.svg",
      "color": "teal",
      "mappingRequired": false,
      "viewComponent": "dashboardView",
      "editComponent": "dashboardEdit",
      "previewComponent": "dashboardPreview",
      "openInNewTab": false,
      "datasets": "none",
      "hasApiWhitelist": false
    }
  }
}

Captured from the API examples test suite; ids and timestamps are normalized.

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