create_report - Qobra public API documentation

Create an empty report, or duplicate an existing one, and return it as list_reports lists it. What the tool does depends on what you pass:

To duplicate a report, pass name and source_report_id. Optionally pass description and section_id to replace the source’s. Pass nothing else: the copy lands in the environment the source lives in, so it takes no sandbox_id.
To create a report from scratch, pass name and report_type, plus tracked_data_table_id for a record report. Optionally pass description, section_id and sandbox_id. A record report needs record reporting enabled for the company.

A duplicate is the same as one made from the web app. It keeps the source’s report type, source data table, fields, filters, sorts, aggregates, pivot table and chart. Who the source is shared with is not copied. Duplicate a report to start from one that already works, for example for another region or another period, rather than rebuild it. A report created from scratch has only its base and dimension columns and a Count under its name column: no metric, no data table field, no pivot table or chart. This tool cannot add them. Ask the Analyst (ask_analyst) to fill in the report it just created, or do it from the Qobra web app. A record report tracks the rows of one data table, named through tracked_data_table_id; a statement report tracks payout statements and takes no data table. A record report lists only the records of scopes on which a plan flags a record metric (see get_report_data). Use the returned id directly: list_reports may not show it yet. Every write to the live environment is recorded in the audit trail as the Qobra MCP agent; writes to a sandbox are not audited.

Example

To copy the “Q3 pipeline” report for the EMEA team, pass the id of the source report, as list_reports returns it, and the name of the copy:

{
  "name": "Q3 pipeline - EMEA",
  "source_report_id": "6650f1c2a4b3e9d1f0c2a7b8",
  "description": "Q3 pipeline for the EMEA sales team."
}

Parameters

Body

string

required

Name of the new report, or of the copy.

string

To duplicate a report you can read: its id from list_reports. Pass it with name and, optionally, description and section_id, nothing else. Omit it to create an empty report.

string

Free-text note about what the report is for. With source_report_id it replaces the source’s description; omit it, or pass an empty one, to keep the source’s.

string

Only to create from scratch, where it is required; refused with source_report_id. ‘statement’ (payout statements) or ‘record’ (the rows of the data table tracked_data_table_id, then required). One of: statement, record.

string

Only to create a record report from scratch, where it is required; refused otherwise. Id from list_data_tables.

string

Id of the section to file the report under: the section.section_id of a report in list_reports, from the environment the report lands in; never a name. Omit it to leave a new report unfiled, or a copy in its source’s section.

string

Id of a sandbox from list_sandboxes, to create this in instead of the live environment. Omit it to create in live, the company’s real data. Never a name, never the live id.

Response

Body

object

The report as it now exists, as list_reports lists it.

Show object properties

string

Web app link to this report.

string

statement: built on payout statements; record: built on the rows of tracked_datatable. One of: statement, record.

string

object

Data table a record report is built on; null for a statement report.

Show object properties

string

Data table id. It may be out of your data table access: get_data_table then reads it as not found; do not retry it.

string

string[]

Tiles the report can show on a dashboard: chart and/or pivot_table, as configured on it. Empty when neither.

object

Section the report is filed under; null when unfiled.

Show object properties

string

object

Who can read this report, split into roles and users, each with the level they hold — the same roster shape every saved view speaks. Null when the roster is not yours to see (no write access on reports) or the report was read from a sandbox, sharing being live-only; never an empty roster, which a caller who may see it gets as empty roles and users instead.

Show object properties

object[]

Show object properties

object

Show object properties

string

boolean

string

The level this role holds on the whole resource category, which reaches every view of it without a share — read (view it), write (edit and re-share it) or delete (also remove it), each level including the ones before it. Null when the role only got this view through a share. One of: read, write, delete.

string

The level granted to this role on this view specifically — read (view it), write (edit and re-share it) or delete (also remove it), each level including the ones before it. Null when the role reaches the view through its category access rather than a share. One of: read, write, delete.

object[]

Show object properties

object

Show object properties

string

The level this view is shared with the user at, individually, on top of whatever their role already grants — read (view it), write (edit and re-share it) or delete (also remove it), each level including the ones before it. One of: read, write, delete.

​Example

​Parameters

​Response

Example

Parameters

Response