--- title: "Read a report with its sections and widgets" method: POST path: "/reports/get" tags: ["Reports"] --- # Read a report with its sections and widgets `POST /reports/get` ## Request - Base URL: `https://api.reportingninja.com/v1` - URL: `https://api.reportingninja.com/v1/reports/get` - Auth: HTTP bearer Returns the header of the report and, section by section, its widgets: what each one is, where it reads from, and either its definition in the widget DSL or the named reason it has none. A widget that carries no data -- a text block, an image, a page break -- is never editable, and neither is one whose definition uses something the DSL cannot say. The answer is bounded at 500 widgets and is cut on a section boundary when the report has more, with truncated: true. The sections of a template_based report are its template's. It also carries `settings`, the settings window of the report -- brand template, front cover, PDF options, localization, language file, substitution variables, what the widgets show, the snapshot switch and the AI brief -- in the same shape /v1/reports/update takes it, with the names of the brand template and of the language file resolved. The uploaded file of the cover is published by name only: its content never travels here. The listings do not carry the block. ## Request body - ReportsGetRequest: Which report to read. - `report_key` string, required: The report to read, from /v1/reports/list or /v1/templates/list. ## Response `200` The call succeeded. This endpoint reports its errors with a real HTTP status, so a 200 always carries status=ok. - ReportsGetResponse - `status` 'ok', required - `data` ReportsGetData, required: The header of the report plus its sections and widgets. - `report_key` string, required: The key that addresses this report in every other endpoint. - `name` string, nullable, required: Title of the report: the name the cover paints, and the one every write takes as `name`. At most 60 characters. - `internal_name` string, nullable, required: The OTHER name of the report: the one the list of the application shows. A report has two and both are writable. At most 100 characters. - `type` 'report' | 'template' | 'template_based', required: `report` is a normal report, `template` one of the account's own templates, `template_based` a report whose sections are its template's. - `based_on_template_key` string, nullable, required: The template a template_based report follows. Null for the other two types. - `catalog` object, nullable, required: The catalog entry this report was materialized from, or null when it was not. - `slug` string, required - `version` integer, nullable, required - `created_via` 'api' | 'ui', required: Whether the report was created through this API or in the app. - `version` integer, required: Version of the sections structure. It is what if_version compares against, and it moves only when the list of sections changes. - `created_at` string, nullable, required: When the report was created, in UTC. - `report_level_data_sources` boolean, required: True when every widget reads from the bindings of data_sources; false when each widget carries its own connection, which is a report the API cannot extend. - `data_sources` ReportDataSource[], required: The report level bindings, ordered by integration. A binding without an account is not published. - `integration_id` string, nullable, required: Public id of the integration, or null when this source has no public id and cannot be addressed through the API. - `integration` string: Internal name of the source. Present only when integration_id is null. - `connection_key` string, nullable, required: The connection this report reads that integration from. - `account_id` string, nullable, required: The account inside that connection. - `entity` 'campaign' | 'list': mailchimp only: which of its two levels this binding is for. - `share_link_enabled` boolean, required: Whether the public share link of the report is on. - `share_link_id` string, nullable, required: The id in the public /share URL, or null when the report has never been shared. - `share_url` string, nullable, required: The public URL of the report, built on the account's own portal domain when it has one. Null when the report has no link. - `app_url` string, nullable, required: The link that opens this report in the Reporting Ninja application. Opening it requires a signed-in user of the account, so it is not the public link: `share_url` is the one anybody holding it reads. Null for a report in the trash, which the application does not open. - `share_link_password_set` boolean, required: Whether the link asks for a password. The password itself is never published. - `share_link_allow_date_range` boolean, required: Whether whoever opens the link may change the period. - `settings` ReportSettings, required: The settings window of the report, in the same shape /v1/reports/update takes it: what a read answers here is what a write sends back, whole, with no key removed and no value rewritten. Three of its keys -- `brand_template_name`, `language_file_name` and `front_cover.file` -- are published here and written by nothing: that call accepts them, ignores them, and names each one in a READ_ONLY_FIELD_IGNORED warning. Everywhere else a null means the column has no value and a write that carries it back leaves that column exactly as it is. - `brand_template` string, required: The brand template the report is printed with: a key of a brand template of the account, or an empty string for the system one. - `brand_template_name` string, nullable, required: The name of that brand template, so naming one does not need a second call. Null when the report points at a brand template that no longer exists. - `front_cover` ReportFrontCover, required: The front cover of the report as a read publishes it, which is the object /v1/reports/update takes back: `file` is published and not written, and it is accepted and ignored so the object can be replayed as it is. - `type` 'none' | 'report' | 'pdf' | 'pdf_and_report' | 'custom' | 'pdf_and_custom', required: What the front cover of the PDF is. `none` prints none, `report` draws the generated cover, `pdf` prints the uploaded file and `pdf_and_report` draws the generated text block over it. The `custom` pair is the legacy cover with texts of its own, kept and not offered: only a report already printed with one of them can be written with it again. The type commands the file: one that prints an uploaded PDF is refused on a report that carries none, and one that prints none removes the file the report carried, which the answer reports as a COVER_FILE_REMOVED warning. - `title` string, nullable, required: The title the generated cover prints. An empty string is a title the report does not have; null is a column that was never written. - `subtitle` string, nullable, required: The line under it. An empty string is a subtitle the report does not have; null is a column that was never written. - `date_line` 'none' | 'generation_date' | 'current_period' | 'current_and_past_period', required: The date line of the cover, of the hero of the public link and of the header of the client portal. - `file` ReportCoverFile, required: The PDF file the front cover prints, by name. Its content is never published. - `name` string, required: The name of the uploaded file. - `pdf` ReportPdfOptions, required: What the generated PDF carries besides the report itself. - `table_of_contents` boolean: Whether the PDF opens with a table of contents. - `page_numbers` boolean: Whether its pages are numbered. - `title_in_pdf` boolean: Whether the title of the report is printed on each page. - `localization` ReportLocalization, required: The localization of the report as a read publishes it. The six settings travel only when `use` is `report`: with `account` the report is printed with the account's, and they are the body that would put it back. - `use` 'account' | 'report', required: Whether the report follows the localization of the account or carries its own. - `date_format` 'DDMMYYYY' | 'MMDDYYYY' | 'YYYYMMDD', nullable: How dates are printed. - `week_starts_on` 'monday' | 'sunday', nullable: The first day of a week. - `decimal_separator` '.' | ',', nullable: The separator of every figure. - `currency` string, nullable: The currency symbol printed beside monetary figures. - `currency_symbol_position` 'left' | 'right', nullable: Which side of the figure the symbol is printed on. - `pdf_page_size` 'A4' | 'Letter', nullable: The page size of the generated PDF. - `language_file` string, required: The language file the report is printed with: an empty string for the system default, one of the sixteen system files (`language_file_en`, `language_file_es`, ...) or the key of a language file of the account. - `language_file_name` string, nullable, required: The name of that language file; a report that names none is printed with the English system file and that is the name answered here. Null when the report points at a language file of the account that no longer exists. - `substitution_variables` string[], required: The five substitution variables of the report, positional. An unused one is an empty string. - `widgets_show` ReportWidgetsShow, required: What the header of every widget of the report shows. - `data_source_name` boolean: Whether the name of the data source is shown. - `data_source_icon` boolean: Whether its icon is shown. - `date_range` boolean: Whether the period of the widget is shown. - `snapshots_with_scheduled_executions` boolean, required: Whether a snapshot of the report is stored every time it is delivered by a schedule. - `ai_brief` string, nullable, required: What the AI summaries of this report know about the client, or null when the report carries no brief. It is the middle of the three levels a summary reads: account, report and widget. - `sections` ReportSection[], required - `section_key` string, required - `name` string, nullable, required - `show_previous_period` boolean, required: True when the header of the section names the period it is compared against, under its date range. The same key a section of /v1/reports/create takes. - `add_summary` union, required: The AI summary OF THIS SECTION, said the way `add_summary` asks for one: `null` when the section carries none, `{"position":"first"}` or `{"position":"last"}` when it is in the first or the last row of the section, and `true` when it carries one placed by hand somewhere in between, which no position of the composition describes (writing that report back with `true` puts it in the first row). A summary of the WHOLE report hosted by this section is NOT answered here: it shows up as one more widget of type `ai_summary`, and the `add_summary` at the root of a composition is what asks for it. - boolean - object - `position` 'first' | 'last', required - `widgets` ReportWidget[], required - `widget_key` string, required - `name` string, nullable, required - `row` integer, nullable, required: 1-based row of the widget inside its section. - `column` integer, nullable, required: 1-based column of the widget inside its row. - `type` 'text' | 'ai_summary' | 'image' | 'page_break' | 'kpi' | 'metrics_summary' | 'trend' | 'chart' | 'table' | 'comparator' | 'other', required: The shape of the widget. The six data shapes and `text` are the ones the DSL can express; `ai_summary`, `image` and `page_break` carry no definition, and `other` is a shape this version does not name. A summary written by the platform used to be reported as `text`, which is the shape of the block it is stored as; it has its own value since 19 September 2026, so `text` now means a block of prose somebody wrote and nothing else. - `integration_id` string, nullable, required: Public id of the integration, or null when this source has no public id and cannot be addressed through the API. - `integration` string: Internal name of the source. Present only when integration_id is null. - `data_view` string, nullable, required: The level the widget reads at, in the vocabulary /v1/capabilities publishes for that integration, or null when the widget has none. - `connection_key` string, nullable: Present only when the report does NOT use report level data sources. - `account_id` string, nullable: Present only when the report does NOT use report level data sources. - `editable` boolean, required: Whether this widget can be expressed as a DSL definition. - `dsl` WidgetDsl - `name` string, required: Title of the widget, in the requested output language. Plain text, no markup. At most 80 characters. - `visualization` 'kpi' | 'graph_basic' | 'graph_pie' | 'graph_trend' | 'table_metrics_summary' | 'table_dimensions_metrics' | 'text', required: How the widget is drawn. The first six read data; text is a block of prose with no data behind it, and it is the only one that carries content. - `chart_type` 'area' | 'line' | 'column' | 'bar', nullable, required: Which chart a graph_basic (area, line, column or bar) or a graph_trend (area, line or column; a trend draws no bars) is drawn as. Null takes the default of the shape, which is a column chart for a graph_basic and an area chart for a graph_trend, and is the usual answer. A chart drawn along a single time dimension is built as a trend and takes the charts of a trend, so it never carries bar. The four shapes that draw no chart always carry null. - `full_width` boolean, nullable, required: True when the widget takes a row of its own; null, like false, pairs it up. The layout of a section is yours: the widgets you do not mark are laid out two to a row in the order you write them, and the KPIs go four to a row before them. A widget marked true closes the row being filled and the next widget opens a new one. Ignored in a kpi, which is always part of a strip of four. - `content` string, nullable, required: The prose of a text block, and null in every other shape. Markdown of a reduced set and nothing else: blank line between paragraphs, **bold**, lines starting with '- ' for a bullet list and with '1. ' for a numbered one. No headings, no links, no italics, no images, no HTML and no emoji; anything else is printed as the characters it is made of. At most 2000 characters. A text block carries no figures: it is written before the widgets of the report are run, so any number in it would be one nobody measured. - `data_view` string, required: Public id of the data view the widget reads, exactly as listed in the catalogue. Empty string when the integration has no data views, and empty string in a text block, which reads none. - `metrics` union[], required: Public field ids of the metrics, in the order they are shown. At least one in the six shapes that read data; empty in a text block. A column of a table_metrics_summary may also be written as the object {id, filter_key}, which reads that one column through a saved filter of the account. Set by API and MCP clients; a definition being generated always writes the field id on its own. - union - … - `dimensions` string[], required: Public field ids of the dimensions, in the order they are shown. Empty when the widget has none. - `filter_key` string, nullable, required: Key of a saved filter of the account the whole widget is read through, or null when the widget reads no such filter. It excludes filters: a widget either points at a filter of the account or carries conditions of its own, never both. The filter has to belong to the integration of the widget and, where the filters of that integration are read in a data view, to the data view of the widget. Set by API and MCP clients; a definition being generated always writes it as null. - `compare` object, nullable, required: What the widget is drawn several times over, or null when it compares nothing, which is the usual answer. accounts draws one series per connected account and takes at least two of them; filters draws one per saved filter of the account; breakdown splits one page metric of facebook_insights into a series per value -- the metric itself says what it is broken down by -- and only a graph_trend takes it. A comparator is only written when the widget is created: neither the class of comparator, nor whether it is broken down over time, nor the fact of being one is changed later. Which classes an integration offers depends on the entity level of its data view too. Set by API and MCP clients; a definition being generated always writes it as null. - `by` 'accounts' | 'filters' | 'breakdown', required: What the widget compares. - `items` union, required: What is compared, in the order it is drawn: one object per connected account for accounts, one per saved filter for filters, and null for a breakdown, which compares no list. - … - `over_time` 'none' | 'hour_of_day' | 'day_of_week' | 'date' | 'week' | 'month' | 'year', nullable, required: The axis a table_metrics_summary comparator is broken down along, which is what makes it an over time table. Null, like none, draws one column per compared element and is the usual answer. Only a table_metrics_summary takes it, and which axes a source offers depends on the integration and on the entity level of its data view. Switching the axis on or off is a change of subtype and is not done by an update. - `show_past_serie` boolean, nullable, required: True when a breakdown draws the period before as a second series. Null, like false, draws only the current period, and it is null in the other two comparators. - `filters` object, nullable, required: Filter applied to the widget, or null for no filter. - `combination` 'and' | 'or', required: How the conditions are joined. Only a combination the catalogue declares for this integration. - `conditions` object[], required - … - `sort_by` object, nullable, required: Ordering of the rows, or null to leave the default. - `field` string, required: Public field id, present in metrics or dimensions. - `direction` 'asc' | 'desc', required - `limit` integer, nullable, required: Maximum number of rows, or null for the default. - `date_range` object, nullable, required: Date range of the widget, or null to inherit the range of the report section. - `preset` string, required: One of the preset ids listed in the instructions, or custom when start and end are given. - `x` integer, nullable, required: Number of days, weeks or months of a preset that takes one; null otherwise. - `start` string, nullable, required: First day of a custom range as yyyy-MM-dd; null otherwise. - `end` string, nullable, required: Last day of a custom range as yyyy-MM-dd; null otherwise. - `previous_period` boolean, nullable, required: The comparison with the period immediately before, and each shape draws it its own way: a graph_trend draws it as an extra series, a table_dimensions_metrics as a column with the percentage of change of each metric, and a kpi and a table_metrics_summary as the figure of that period beside the current one. A few sources and views do not offer it and say so in a warning. In the two shapes that draw the figure, null means yes, which is what those widgets show by default; in the other two, null is the usual answer and asks for nothing. - `show_change` boolean, nullable, required: The PERCENTAGE OF CHANGE against the period before, drawn only by a kpi and by a table_metrics_summary, where it is the other half of the comparison: previous_period is the figure of that period and this one is the percentage beside it. The two are independent and neither governs the other. Null means yes, which is what those widgets show by default. The other five shapes carry null: the change asked for in one of them is ignored with a warning. - `settings` object[], nullable, required: Integration settings the catalogue declares, or null when none applies. - `id` string, required: Setting id of the catalogue. - `value` string, required: One of the values the catalogue lists for that setting. - `unfulfilled` string[], required: What was asked for and cannot be expressed with this integration, one short sentence each. Empty when everything asked for is in the widget. - `reason` string, nullable: Why the widget has no definition, as a stable token. Present only when editable is false. - `message` string, nullable: The same reason in words. Present only when editable is false. - `ai_summary` WidgetAiSummary: An AI summary as the body of a write says it, and as a read publishes it: the reach of the summary, what that reach reads, the settings it is generated with and the brief of this summary. The settings and the brief are a partial write: what a body does not name is left exactly as it is, a setting sent with the value the summary already uses is not written either, and a creation that names none of them is generated with the defaults /v1/capabilities publishes. It is not a visualization of the DSL, and it could not be: what a summary is made of is a selection of widgets or of sections, which is said with keys of this account's report, while a definition is portable and knows no keys. A TEMPLATE takes none: what a template holds is copied into every report built on it, and a summary reads the widgets and the sections of ONE report by key, so each copy would be a summary of nothing; it is refused with APPEND_NOT_ALLOWED and reason template_report. - `scope` 'widget' | 'section' | 'report', required: What the summary reads. `widget` reads the widgets of its own section it names, `section` reads the data widgets of its own section and `report` reads the sections it names. The scope of a summary that exists is never changed: a summary of another scope is placed and counted differently, so it is deleted and written again. - `widget_keys` string[]: Scopes `widget` and `section`: the data widgets of THIS section the summary reads. THREE STATES. Left out (or null) does not touch it: a creation falls back to what the editor preselects -- the first data widgets of the section -- and an update leaves the summary reading exactly what it reads. An EMPTY list is a value and means the summary reads nothing, which is the state the application saves a summary in with nothing ticked: it is accepted and the answer carries a SELECTION_EMPTY warning, because it generates nothing until something is selected. A list of keys replaces the selection. It is required on a CREATION of scope `widget`, which is made of them, and not on an update of one. /v1/capabilities publishes how many each scope may read. - `section_keys` string[]: Scope `report`: the sections of this report the summary reads. The same three states as widget_keys: left out (or null) does not touch it -- a creation reads the first sections of the report, an update keeps what the summary has -- an EMPTY list means it reads nothing and answers a SELECTION_EMPTY warning, and a list of keys replaces the selection. - `position` 'first' | 'last': Scopes `section` and `report`, and only when the summary is being CREATED: where it goes inside the section, alone in its row. `first`, the default, puts it above everything the section carries and moves the rest down; `last` opens a new row after the last one. A summary of scope `widget` is one more widget of its row and takes `placement` instead. - `ai_prompt` string, nullable: The instruction this summary is written with. A read answers the text or null, and never an empty string: an emptied box is stored as nothing, so a text that was emptied and one nobody ever wrote come back the same way. In a body, leaving the property out or sending null keeps what the summary has, an empty string empties it and a text replaces it. - `ai_include_comparison` boolean: Whether the summary is given the period before to compare against. True unless it was turned off. - `ai_auto_refresh` boolean: Whether the summary is written again on its own when the period or the data behind it changes. True unless it was turned off. - `ai_fallback_policy` 'omit' | 'default_text' | 'last_cached': What the end client is shown when the summary could not be produced: `omit` prints nothing, `default_text` prints ai_fallback_text and `last_cached` prints the last summary that worked, labelled with the period it belongs to. `omit` unless it was changed. - `ai_quota_fallback_policy` 'omit' | 'default_text' | 'last_cached': The same choice for the case where the monthly AI allowance of the account is used up, which is a different question: the data is healthy there. `omit` unless it was changed. - `ai_fallback_text` string, nullable: The text both policies print when they are set to `default_text`. It is never required: a policy of `default_text` with no text prints nothing, exactly as the settings window of the application saves it. A read answers the text or null and never an empty string; in a body, null keeps what the summary has and an empty string empties it. - `ai_show_disclaimer` boolean: Whether the summary carries the line saying it was written by AI. True unless it was turned off. - `ai_brief` string, nullable: What the summaries of THIS widget should know about the client. It is the narrowest of three levels and they are added together, not replaced: the level of the account is written in the application, the level of the report travels on /v1/reports/update, and this one belongs to the summary. Three states: leaving the property out -- or sending null, which is what a read answers when there is none -- keeps the brief the summary has, an empty string removes it, and a text replaces it. It is stored apart from the widget: it is not covered by widget_hash, /v1/widgets/restore does not bring it back, and a brief that could not be written comes back as an AI_BRIEF_NOT_SAVED warning of a 200. - `credits_per_generation` integer: What ONE generation of this summary costs the account, in credits. It is spent when the report is opened, viewed or delivered by a schedule, and never when the summary is written. - `credits_note` string: When those credits are spent. - `image` WidgetImage: What the picture of an image widget measures. The bytes themselves are never published by a read: they leave this surface drawn, inside the report. - `width` integer, nullable, required - `height` integer, nullable, required - `bytes` integer, nullable, required: How much the stored file weighs. - `show_date_range` boolean, required: Whether the header of the section shows the period it covers. - `page_orientation` 'portrait' | 'landscape', nullable, required: How the pages of this section are laid out in the PDF, or null when the section holds no value for it. - `page_break` boolean, required: Whether the PDF starts a new page at this section. - `widget_count` integer, required: Widgets in the answer. - `editable_count` integer, required: How many of them carry a DSL definition. - `truncated` boolean, required: True when the report holds more than 500 widgets and the answer was cut on a section boundary. - `unreadable_section_keys` string[], required: Sections that could not be read. A broken section never takes the whole report down. - `meta` Meta, required - `request_id` string, required: Id of this request, useful when reporting an incident. - `timestamp` string, date-time, required: When the answer was built, in UTC. ## Other responses - `400`: The request was refused before anything was written. INVALID_REQUEST covers the framework refusals of every endpoint (the Content-Type is not application/json, the body could not be read, the body is not valid JSON). The report endpoints add their own: VALIDATION_FAILED with details.problems, UNKNOWN_PARAM with the path of the field the endpoint does not read, and the single-field refusals MISSING_REQUIRED_FIELD, INVALID_VALUE and APPEND_NOT_ALLOWED. The description of each operation lists the ones it emits. Everything else a body can get wrong arrives as an entry of details.problems rather than as the code of the envelope. - `401`: Invalid or missing Bearer token. - `404`: A key of the request does not name anything this account owns. NOT_FOUND covers reports, sections, widgets, schedules, portal views, brand templates, email templates and language files; TEMPLATE_NOT_FOUND covers a catalog slug, version or section position that stopped being published between the validation and the write. An entity of another account is reported the same way as one that does not exist. - `413`: The request body is over 1 MB. The cap is applied before authentication, so this answer is refused without the key being read, and it carries the usual error envelope. - `429`: A budget was spent. RATE_LIMITED is the per-key read budget (300/minute, 5000/day) or the per-account write budget (60/minute, 1000/day). EMAIL_QUOTA_REACHED is the separate budget of 50 calls per account per day that send email, and its Retry-After points at the next UTC midnight. The Retry-After header gives the seconds until the more restrictive window resets. The X-RateLimit-* headers report the read budget, except on the 429 of a write, where they report the write budget. - `500`: Internal server error. --- [API](https://skmtc.dev/reportingninja/apis/reporting-ninja-api.md) · [All operations](https://skmtc.dev/reportingninja/apis/reporting-ninja-api/llms.txt) · [OpenAPI document](https://skmtc.dev/reportingninja/apis/reporting-ninja-api/revisions/13876c71be34?raw)