The entity graph as THIS caller may see it

GET /model

The entity graph as THIS caller may see it: the reportable entities with their labelled dimensions and measures (each measure carrying its kind, flow or balance, and its aggregation), and the declared edges between the entities that survived — filtered server-side to the fields the caller's jobs may reference, so a report builder driven by this answer can only offer what a save or a run would accept.

This is the sanctioned introspection surface: pure declared data with no engine and no SQL behind it — the underlying engine's own metadata endpoints must never be proxied in its place. 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.

AI agent tool

Agents call this as reporting_describe_model (Reporting: Describe model), in the reporting toolset. It only reads.

Connecting an agent: AI agents.

Example

Trimmed to the two entities a units-by-SKU report walks; the full model lists every reportable entity.

curl

curl -X GET 'https://reporting.getmanifold.io/model' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"

JavaScript (fetch)

const response = await fetch("https://reporting.getmanifold.io/model", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Response · 200 · application/json

{
  "entities": [
    {
      "name": "sku",
      "label": "SKU",
      "dimensions": [
        {
          "name": "sku",
          "label": "SKU",
          "type": "string",
          "scopes": [
            "stock:read",
            "receiving:read",
            "purchasing:read",
            "products:read",
            "reports:read",
            "financials:read"
          ]
        },
        {
          "name": "name",
          "label": "Item name",
          "type": "string",
          "scopes": [
            "stock:read",
            "receiving:read",
            "purchasing:read",
            "products:read",
            "reports:read",
            "financials:read"
          ]
        }
      ],
      "measures": []
    },
    {
      "name": "stockMovement",
      "label": "Stock movement",
      "dimensions": [
        {
          "name": "day",
          "label": "Day",
          "type": "date",
          "scopes": [
            "stock:read",
            "receiving:read",
            "purchasing:read",
            "products:read",
            "reports:read",
            "financials:read"
          ]
        },
        {
          "name": "currency",
          "label": "Currency",
          "type": "string",
          "scopes": [
            "stock:read",
            "receiving:read",
            "purchasing:read",
            "products:read",
            "reports:read",
            "financials:read"
          ]
        }
      ],
      "measures": [
        {
          "name": "quantity",
          "label": "Units moved",
          "kind": "flow",
          "aggregation": "sum",
          "scopes": [
            "stock:read",
            "receiving:read",
            "purchasing:read",
            "products:read",
            "reports:read",
            "financials:read"
          ]
        }
      ]
    }
  ],
  "edges": [
    {
      "name": "sku",
      "from": "stockMovement",
      "to": "sku",
      "cardinality": "one"
    }
  ]
}

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.

`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
`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.

`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.	Try again shortly.

How refusals work everywhere: Errors.

Used in

Build, save and run a report, step 1: Discover what can be reported on