/

Back to MB Suite

Menu

API reference

Reports

44 operations

Labels

GET/v1/reports/labelsList the labels of report templates or reports

Templates

GET/v1/reports/templatesList report templates GET/v1/reports/templates/{template_id}Get a report template with its pages POST/v1/reports/templatesCreate a report template PATCH/v1/reports/templates/{template_id}Update a report template POST/v1/reports/templates/{template_id}/publishPublish or unpublish a report template POST/v1/reports/templates/{template_id}/duplicateDuplicate a report template DELETE/v1/reports/templates/{template_id}Delete a report template POST/v1/reports/templates/{template_id}/deployCreate an editable report from a template

System templates

system_templates

GET/v1/reports/system-templatesList MB Suite's published system report templates GET/v1/reports/system-templates/{template_id}Get a published system report template POST/v1/reports/system-templates/{template_id}/cloneCopy a system report template into the organization

Reports

GET/v1/reports/reportsList editable reports GET/v1/reports/reports/{report_id}Get an editable report with its pages POST/v1/reports/reportsCreate an editable report from scratch PATCH/v1/reports/reports/{report_id}Update an editable report DELETE/v1/reports/reports/{report_id}Delete an editable report

Report instances

GET/v1/reports/instancesList report instances GET/v1/reports/instances/{instance_id}Get a report instance with its pages POST/v1/reports/instances/generateGenerate a report instance from a template POST/v1/reports/instancesCreate a blank report instance PATCH/v1/reports/instances/{instance_id}Update a draft report instance POST/v1/reports/instances/{instance_id}/finalizeFinalize a report instance without a PDF POST/v1/reports/instances/{instance_id}/duplicateDuplicate a report instance DELETE/v1/reports/instances/{instance_id}Delete a report instance POST/v1/reports/instances/bulk/deleteDelete many report instances POST/v1/reports/instances/{instance_id}/pdfGenerate the PDF of a report instance GET/v1/reports/instances/{instance_id}/pdfGet a download link for the PDF of a report instance POST/v1/reports/instances/{instance_id}/portalPublish a report to the account's client portal POST/v1/reports/instances/{instance_id}/save-as-templateSave a report instance as a template

Ad hoc reports

GET/v1/reports/adhocList ad hoc report PDFs POST/v1/reports/adhoc/{adhoc_report_id}/refresh-urlGet a fresh download link for an ad hoc PDF GET/v1/reports/adhoc/{adhoc_report_id}/pdf-urlGet the download link of an ad hoc report PDF DELETE/v1/reports/adhoc/{adhoc_report_id}Delete an ad hoc report PDF

Data sources

GET/v1/reports/data-sourcesList the data sources a report can read

Themes

GET/v1/reports/themesList report themes GET/v1/reports/themes/{theme_id}Get a report theme POST/v1/reports/themesCreate a report theme PATCH/v1/reports/themes/{theme_id}Update a report theme DELETE/v1/reports/themes/{theme_id}Delete a report theme

Page templates

section_templates

GET/v1/reports/section-templatesList saved report pages GET/v1/reports/section-templates/{section_template_id}Get a saved report page POST/v1/reports/section-templatesSave a report page for reuse DELETE/v1/reports/section-templates/{section_template_id}Delete a saved report page