Reports

List reports

get

/api/v1/workspaces/{wsId}/reports

Lists reports in the workspace. Paginated (limit, cursor). Read from platform MongoDB. Reports have title, description, status (e.g. draft), markdown, widgets, evidenceIds.

Authorizations

AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters

wsIdstringRequired

Path parameter: wsId

Example: 123

Query parameters

limitnumber · min: 1 · max: 1000Optional

Page size (1-1000, default 50).

Example: 1

cursorstringOptional

Opaque cursor from a previous response's pagination.cursor.

Example: example

Responses

200

Successful response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

429

Too Many Requests; the response carries Retry-After

application/json

500

Internal Server Error

application/json

get/api/v1/workspaces/{wsId}/reports

GET /api/v1/workspaces/{wsId}/reports HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": null,
      "workspaceId": "text",
      "organisationId": "text",
      "title": "text",
      "markdown": "text",
      "widgets": [
        {
          "id": "text",
          "evidenceId": "text",
          "type": "text",
          "explorerConfig": "[Circular Reference]"
        }
      ],
      "evidenceIds": [
        "text"
      ],
      "createdAt": "text",
      "updatedAt": "text",
      "status": "draft",
      "rev": 1,
      "error": null,
      "prompt": null,
      "publish": {
        "slug": null,
        "publishedAt": null,
        "consumerAccess": "private",
        "resolvedInputs": [
          {
            "datasetId": "text",
            "versionId": null,
            "deltaVersion": 1
          }
        ],
        "widgetSnapshot": [
          {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          }
        ],
        "snapshotAt": null,
        "snapshotStats": {
          "requested": 1,
          "resolved": 1,
          "omitted": 1,
          "timedOut": true,
          "bytes": 1
        }
      }
    }
  ],
  "pagination": {
    "cursor": "text",
    "hasMore": true,
    "total": 1
  }
}

Create report

post

/api/v1/workspaces/{wsId}/reports

Creates a new report. Body: title, optional description. Report is created in draft status with empty markdown, widgets, and evidenceIds. Stored in platform MongoDB; content is written via PATCH or by the agent's report tools.

Authorizations

AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters

wsIdstringRequired

Path parameter: wsId

Example: 123

Body

titlestringRequired

descriptionstring · nullableOptional

Responses

201

Successful response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

429

Too Many Requests; the response carries Retry-After

application/json

500

Internal Server Error

application/json

post/api/v1/workspaces/{wsId}/reports

POST /api/v1/workspaces/{wsId}/reports HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "title": "text",
  "description": null
}

{
  "data": {
    "id": null,
    "workspaceId": "text",
    "organisationId": "text",
    "title": "text",
    "markdown": "text",
    "widgets": [
      {
        "id": "text",
        "evidenceId": "text",
        "type": "text",
        "explorerConfig": {
          "id": "text",
          "dataView": "[Circular Reference]",
          "operations": "[Circular Reference]",
          "additionalSources": [
            {
              "id": "text",
              "type": "text",
              "name": null,
              "conceptIds": [
                "text"
              ],
              "conceptVersions": {
                "ANY_ADDITIONAL_PROPERTY": 1
              },
              "version": {
                "kind": "text"
              }
            }
          ],
          "inlineData": {
            "columns": [
              {
                "name": "text",
                "type": "None"
              }
            ],
            "rows": [
              {
                "ANY_ADDITIONAL_PROPERTY": null
              }
            ],
            "downsampled": true,
            "totalRows": null
          },
          "series": {
            "labels": [
              "text"
            ],
            "datasets": [
              {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            ],
            "meta": {
              "version": 1,
              "xField": null,
              "columns": [
                {
                  "name": "text",
                  "type": "text"
                }
              ],
              "series": [
                {
                  "label": "text",
                  "yField": null,
                  "aggregation": null
                }
              ],
              "categoriesTotal": null,
              "categoriesShown": null,
              "otherFolded": null,
              "sortBy": null,
              "sortType": null,
              "binCount": null,
              "linksTotal": null,
              "linksShown": null,
              "pointsTotal": null,
              "pointsShown": null,
              "rowsScanned": null,
              "rowsWithoutCategory": null,
              "downsampled": null,
              "summary": "",
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "xSelection": "text",
          "traces": [
            {
              "id": "text",
              "name": "text",
              "ySelection": [
                "text"
              ],
              "yAxisPosition": "left",
              "color": null,
              "visible": true,
              "chartType": "text",
              "options": {
                "stacked": false,
                "aggregation": "sum"
              }
            }
          ],
          "config": {
            "responsive": true,
            "chartTitle": null,
            "dataPoints": -1,
            "dataDisplayOrder": "fromStart",
            "sortBy": "none",
            "sortType": "ascending",
            "advancedSettings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        }
      }
    ],
    "evidenceIds": [
      "text"
    ],
    "createdAt": "text",
    "updatedAt": "text",
    "status": "draft",
    "rev": 1,
    "error": null,
    "prompt": null,
    "publish": {
      "slug": null,
      "publishedAt": null,
      "consumerAccess": "private",
      "resolvedInputs": [
        {
          "datasetId": "text",
          "versionId": null,
          "deltaVersion": 1
        }
      ],
      "widgetSnapshot": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "snapshotAt": null,
      "snapshotStats": {
        "requested": 1,
        "resolved": 1,
        "omitted": 1,
        "timedOut": true,
        "bytes": 1
      }
    }
  }
}

Get report

get

/api/v1/workspaces/{wsId}/reports/{id}

Returns the report by id from platform MongoDB. Must belong to the workspace.

Authorizations

AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters

wsIdstringRequired

Path parameter: wsId

Example: 123

idstringRequired

Path parameter: id

Example: 123

Responses

200

Successful response

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests; the response carries Retry-After

application/json

500

Internal Server Error

application/json

get/api/v1/workspaces/{wsId}/reports/{id}

GET /api/v1/workspaces/{wsId}/reports/{id} HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "id": null,
    "workspaceId": "text",
    "organisationId": "text",
    "title": "text",
    "markdown": "text",
    "widgets": [
      {
        "id": "text",
        "evidenceId": "text",
        "type": "text",
        "explorerConfig": {
          "id": "text",
          "dataView": "[Circular Reference]",
          "operations": "[Circular Reference]",
          "additionalSources": [
            {
              "id": "text",
              "type": "text",
              "name": null,
              "conceptIds": [
                "text"
              ],
              "conceptVersions": {
                "ANY_ADDITIONAL_PROPERTY": 1
              },
              "version": {
                "kind": "text"
              }
            }
          ],
          "inlineData": {
            "columns": [
              {
                "name": "text",
                "type": "None"
              }
            ],
            "rows": [
              {
                "ANY_ADDITIONAL_PROPERTY": null
              }
            ],
            "downsampled": true,
            "totalRows": null
          },
          "series": {
            "labels": [
              "text"
            ],
            "datasets": [
              {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            ],
            "meta": {
              "version": 1,
              "xField": null,
              "columns": [
                {
                  "name": "text",
                  "type": "text"
                }
              ],
              "series": [
                {
                  "label": "text",
                  "yField": null,
                  "aggregation": null
                }
              ],
              "categoriesTotal": null,
              "categoriesShown": null,
              "otherFolded": null,
              "sortBy": null,
              "sortType": null,
              "binCount": null,
              "linksTotal": null,
              "linksShown": null,
              "pointsTotal": null,
              "pointsShown": null,
              "rowsScanned": null,
              "rowsWithoutCategory": null,
              "downsampled": null,
              "summary": "",
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "xSelection": "text",
          "traces": [
            {
              "id": "text",
              "name": "text",
              "ySelection": [
                "text"
              ],
              "yAxisPosition": "left",
              "color": null,
              "visible": true,
              "chartType": "text",
              "options": {
                "stacked": false,
                "aggregation": "sum"
              }
            }
          ],
          "config": {
            "responsive": true,
            "chartTitle": null,
            "dataPoints": -1,
            "dataDisplayOrder": "fromStart",
            "sortBy": "none",
            "sortType": "ascending",
            "advancedSettings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        }
      }
    ],
    "evidenceIds": [
      "text"
    ],
    "createdAt": "text",
    "updatedAt": "text",
    "status": "draft",
    "rev": 1,
    "error": null,
    "prompt": null,
    "publish": {
      "slug": null,
      "publishedAt": null,
      "consumerAccess": "private",
      "resolvedInputs": [
        {
          "datasetId": "text",
          "versionId": null,
          "deltaVersion": 1
        }
      ],
      "widgetSnapshot": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "snapshotAt": null,
      "snapshotStats": {
        "requested": 1,
        "resolved": 1,
        "omitted": 1,
        "timedOut": true,
        "bytes": 1
      }
    }
  }
}

Delete report

delete

/api/v1/workspaces/{wsId}/reports/{id}

Deletes the report from platform MongoDB. Requires reports:write and full permission.

Authorizations

AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters

wsIdstringRequired

Path parameter: wsId

Example: 123

idstringRequired

Path parameter: id

Example: 123

Responses

204

No Content

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

429

Too Many Requests; the response carries Retry-After

application/json

500

Internal Server Error

application/json

delete/api/v1/workspaces/{wsId}/reports/{id}

DELETE /api/v1/workspaces/{wsId}/reports/{id} HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update report

patch

/api/v1/workspaces/{wsId}/reports/{id}

Updates title, description, and/or markdown. Only these fields are writable. updatedAt is set automatically. Widgets and evidence are typically managed by the UI or other flows.

Authorizations

AuthorizationstringRequired

An API key (pk_...) created on the Organisation API page, or an OAuth access token. Every operation requires one.

Path parameters

wsIdstringRequired

Path parameter: wsId

Example: 123

idstringRequired

Path parameter: id

Example: 123

Body

titlestringOptional

descriptionstring · nullableOptional

markdownstringOptional

Responses

200

Successful response

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

422

Unprocessable Entity

application/json

429

Too Many Requests; the response carries Retry-After

application/json

500

Internal Server Error

application/json

patch/api/v1/workspaces/{wsId}/reports/{id}

PATCH /api/v1/workspaces/{wsId}/reports/{id} HTTP/1.1
Host: sandbox.rootcause.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "title": "text",
  "description": null,
  "markdown": "text"
}

{
  "data": {
    "id": null,
    "workspaceId": "text",
    "organisationId": "text",
    "title": "text",
    "markdown": "text",
    "widgets": [
      {
        "id": "text",
        "evidenceId": "text",
        "type": "text",
        "explorerConfig": {
          "id": "text",
          "dataView": "[Circular Reference]",
          "operations": "[Circular Reference]",
          "additionalSources": [
            {
              "id": "text",
              "type": "text",
              "name": null,
              "conceptIds": [
                "text"
              ],
              "conceptVersions": {
                "ANY_ADDITIONAL_PROPERTY": 1
              },
              "version": {
                "kind": "text"
              }
            }
          ],
          "inlineData": {
            "columns": [
              {
                "name": "text",
                "type": "None"
              }
            ],
            "rows": [
              {
                "ANY_ADDITIONAL_PROPERTY": null
              }
            ],
            "downsampled": true,
            "totalRows": null
          },
          "series": {
            "labels": [
              "text"
            ],
            "datasets": [
              {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              }
            ],
            "meta": {
              "version": 1,
              "xField": null,
              "columns": [
                {
                  "name": "text",
                  "type": "text"
                }
              ],
              "series": [
                {
                  "label": "text",
                  "yField": null,
                  "aggregation": null
                }
              ],
              "categoriesTotal": null,
              "categoriesShown": null,
              "otherFolded": null,
              "sortBy": null,
              "sortType": null,
              "binCount": null,
              "linksTotal": null,
              "linksShown": null,
              "pointsTotal": null,
              "pointsShown": null,
              "rowsScanned": null,
              "rowsWithoutCategory": null,
              "downsampled": null,
              "summary": "",
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          },
          "xSelection": "text",
          "traces": [
            {
              "id": "text",
              "name": "text",
              "ySelection": [
                "text"
              ],
              "yAxisPosition": "left",
              "color": null,
              "visible": true,
              "chartType": "text",
              "options": {
                "stacked": false,
                "aggregation": "sum"
              }
            }
          ],
          "config": {
            "responsive": true,
            "chartTitle": null,
            "dataPoints": -1,
            "dataDisplayOrder": "fromStart",
            "sortBy": "none",
            "sortType": "ascending",
            "advancedSettings": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          }
        }
      }
    ],
    "evidenceIds": [
      "text"
    ],
    "createdAt": "text",
    "updatedAt": "text",
    "status": "draft",
    "rev": 1,
    "error": null,
    "prompt": null,
    "publish": {
      "slug": null,
      "publishedAt": null,
      "consumerAccess": "private",
      "resolvedInputs": [
        {
          "datasetId": "text",
          "versionId": null,
          "deltaVersion": 1
        }
      ],
      "widgetSnapshot": [
        {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      ],
      "snapshotAt": null,
      "snapshotStats": {
        "requested": 1,
        "resolved": 1,
        "omitted": 1,
        "timedOut": true,
        "bytes": 1
      }
    }
  }
}