Replace a saved report's name and definition wholesale

PUT /reports/{reportId}

Replace a saved report's name and definition wholesale, validated exactly as the save is (400 ReportDefinitionRefused / 403 ReportFieldsForbidden); 404 ReportNotFound when the id was never saved.

Appends reporting.report-saved with the report as it reads afterwards. Idempotent by content: a retry saying what the library already says appends nothing. Requires the analyse, account or admin job.

Access

Requires reports:write.

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

Retries

Idempotent by content: a retry saying what the library already says appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

reporting.report-saved

What a fact is: Facts and the journal.

AI agent tool

Agents call this as reporting_replace_report (Reporting: Replace report), in the reporting toolset.

Connecting an agent: AI agents.

Example

curl

curl -X PUT 'https://reporting.getmanifold.io/reports/rpt_01a1586d-1d4c-7444-8444-444444444444' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Units by SKU, last 30 days",
  "definition": {
    "entity": "stockMovement",
    "hops": [
      "sku"
    ],
    "groupBy": [
      {
        "field": "sku"
      }
    ],
    "measures": [
      "quantity"
    ],
    "period": {
      "_tag": "preset",
      "preset": "30d"
    }
  }
}'

JavaScript (fetch)

const response = await fetch("https://reporting.getmanifold.io/reports/rpt_01a1586d-1d4c-7444-8444-444444444444", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "name": "Units by SKU, last 30 days",
    "definition": {
      "entity": "stockMovement",
      "hops": [
        "sku"
      ],
      "groupBy": [
        {
          "field": "sku"
        }
      ],
      "measures": [
        "quantity"
      ],
      "period": {
        "_tag": "preset",
        "preset": "30d"
      }
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "name": "Units by SKU, last 30 days",
  "definition": {
    "entity": "stockMovement",
    "hops": [
      "sku"
    ],
    "groupBy": [
      {
        "field": "sku"
      }
    ],
    "measures": [
      "quantity"
    ],
    "period": {
      "_tag": "preset",
      "preset": "30d"
    }
  }
}

Response · 200 · application/json

{
  "reportId": "rpt_01a1586d-1d4c-7444-8444-444444444444",
  "name": "Units by SKU, last 30 days",
  "definition": {
    "entity": "stockMovement",
    "hops": [
      "sku"
    ],
    "groupBy": [
      {
        "field": "sku"
      }
    ],
    "measures": [
      "quantity"
    ],
    "period": {
      "_tag": "preset",
      "preset": "30d"
    },
    "filters": [],
    "derived": [],
    "limit": 100
  }
}

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`

Refusal	What it means	What to do
`ReportDefinitionRefused` refusals	The report definition is not valid. `refusals` lists each problem.	Fix each one and send it again.

`401`

Refusal	What it means	What 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`

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

`403`

Refusal	What it means	What 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`

Refusal	What it means	What to do
`ReportNotFound` reportId	The id was never saved.	Check the id in the path or the body.

`409`

Refusal	What it means	What 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`

Refusal	What it means	What 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

Build, save and run a report, step 4: Rename it