Reporting Manager API · runs

Execute a report — a saved one by reportId

POST /report-runs

Execute a report — a saved one by reportId, or an inline definition validated exactly as a save is — with the reference interpreter over the reporting star schema, and answer the grouped result plus asOf, the fold's per-source watermarks at the moment of the read.

The caller's jobs gate every referenced field at run time, so a saved report outlives a revoked grant only as a 403 ReportFieldsForbidden. Appends nothing: a run is a pure query over the derived read model — the facts behind every number were journalled by the services that own them, and the request row is acknowledged rather than committed. No idempotency key: nothing is written, and the same definition over the same read model answers the same. Requires the analyse, account or admin job.

Access

Requires reports:read.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

No idempotency key: nothing is written, and the same definition over the same read model answers the same.

Why every write carries a key: Idempotency and retries.

Facts appended

None. This call records nothing in a journal.

What a fact is: Facts and the journal.

AI agent tool

Agents call this as reporting_run_report (Reporting: Run report), in the reporting toolset.

Connecting an agent: AI agents.

Example

curl
curl -X POST 'https://reporting.getmanifold.io/report-runs' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "reportId": "rpt_01a1586d-1d4c-7444-8444-444444444444"
}'
JavaScript (fetch)
const response = await fetch("https://reporting.getmanifold.io/report-runs", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "reportId": "rpt_01a1586d-1d4c-7444-8444-444444444444"
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "reportId": "rpt_01a1586d-1d4c-7444-8444-444444444444"
}
Response · 200 · application/json
{
  "result": {
    "groupBy": [
      "sku"
    ],
    "measures": [
      "quantity"
    ],
    "derived": [],
    "period": {
      "firstDay": "2026-09-21",
      "lastDay": "2026-10-20"
    },
    "rows": [
      {
        "level": 1,
        "key": [
          "WIDGET-BLUE"
        ],
        "measures": {
          "quantity": 40
        },
        "derived": {},
        "present": true
      },
      {
        "level": 1,
        "key": [
          "WIDGET-RED"
        ],
        "measures": {
          "quantity": 30
        },
        "derived": {},
        "present": true
      },
      {
        "level": 0,
        "key": [],
        "measures": {
          "quantity": 70
        },
        "derived": {},
        "present": true
      }
    ],
    "meta": {
      "leafRows": 2,
      "emittedLeafRows": 2,
      "truncated": false,
      "cells": 4
    }
  },
  "asOf": [
    {
      "source": "inventory",
      "tenants": 1,
      "maxFoldedSequence": 128,
      "lastRun": {
        "at": "2026-10-20T08:59:58.000Z",
        "outcome": "folded",
        "folded": 3,
        "skipped": 0,
        "durationMs": 41
      }
    },
    {
      "source": "fulfillment",
      "tenants": 1,
      "maxFoldedSequence": 77,
      "lastRun": {
        "at": "2026-10-20T08:59:58.000Z",
        "outcome": "empty",
        "folded": 0,
        "skipped": 0,
        "durationMs": 6
      }
    }
  ],
  "includesHistory": false
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: reporting-manager.openapi.json. Base URL https://reporting.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

400

RefusalWhat it meansWhat to do
ReportDefinitionRefused refusals The report definition is not valid. refusals lists each problem.Fix each one and send it again.

401

RefusalWhat it meansWhat to do
Unauthorized reason The token is missing, expired or not one Manifold issued.Get a fresh token and send the call again.
TokenAlreadyUsed tokenId A single-use app token was already spent.Mint a new token for this call.

402

RefusalWhat it meansWhat to do
SubscriptionRequired status The organization's subscription has lapsed, so writes are refused.An owner settles billing. Reads still work meanwhile.

403

RefusalWhat it meansWhat to do
ReportFieldsForbidden refusals The report reads fields your roles may not see. refusals names them.Leave those fields out, or ask for a role that sees them.
TenantRequired userId The token names no organization.Choose the organization, then get a new token.
ScopeRequired required The token's roles do not grant the scope this call needs.Ask an owner or admin for a role that grants it.

404

RefusalWhat it meansWhat to do
ReportNotFound reportId No such record in this organization.Check the id in the path or the body.

409

RefusalWhat it meansWhat to do
MirroredFromSource source This area is fed by your source system until the organization goes live.Make the change in the source system, or go live first.

503

RefusalWhat it meansWhat to do
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Send the same request again shortly.

How refusals work everywhere: Errors.

Used in