Esc

↑↓ move↵ openIndex · Pagefind
REST reference · Core Tools

Reporting

17 endpoints17 implementedAll modules →
  1. GET /rest/v1.0/projects/{project_id}/dashboardsList dashboards for a project
  2. POST /rest/v1.0/projects/{project_id}/dashboardsCreate a dashboard
  3. GET /rest/v1.0/projects/{project_id}/dashboards/{id}Get a computed dashboard (widget payloads)
  4. POST /rest/v1.0/projects/{project_id}/dashboards/{id}/widgetsAppend a widget to a dashboard
  5. GET /rest/v1.0/projects/{project_id}/project_report_templatesList the canned report-template catalog (Reports Library)
  6. GET /rest/v1.0/projects/{project_id}/project_report_templates/{id}Show one report template (by id or template key)
  7. GET /rest/v1.0/projects/{project_id}/project_reportsList a project's saved library reports
  8. POST /rest/v1.0/projects/{project_id}/project_reportsCreate a project report (from a template or custom)
  9. GET /rest/v1.0/projects/{project_id}/project_reports/{id}Show a saved library report's configuration
  10. PATCH /rest/v1.0/projects/{project_id}/project_reports/{id}Update a saved library report
  11. GET /rest/v1.0/projects/{project_id}/project_reports/{id}/runRun a saved library report, returning computed rows
  12. GET /rest/v1.0/projects/{project_id}/reportsList built-in and saved reports for a project
  13. POST /rest/v1.0/projects/{project_id}/reportsCreate a saved (custom) report
  14. GET /rest/v1.0/projects/{project_id}/reports/{id}Get a computed report (built-in key or saved-<id>)
  15. GET /rest/v1.0/projects/{project_id}/scheduled_reportsList scheduled (delivered) reports
  16. POST /rest/v1.0/projects/{project_id}/scheduled_reportsSchedule a report for recurring delivery
  17. GET /rest/v1.0/projects/{project_id}/widget_dataCompute a single widget's chart data
GET /rest/v1.0/projects/{project_id}/dashboards

List dashboards for a project

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • name
    stringrequired
  • widgets
    any[]required
  • created_by_id
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
POST /rest/v1.0/projects/{project_id}/dashboards

Create a dashboard

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired

Response · 201 · Dashboard

  • id
    integerrequired
  • name
    stringrequired
  • widgets
    any[]required
  • created_by_id
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/dashboards/{id}

Get a computed dashboard (widget payloads)

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · ComputedDashboard

  • id
    integerrequired
  • name
    stringrequired
  • widgets
    ComputedWidget[]required
POST /rest/v1.0/projects/{project_id}/dashboards/{id}/widgets

Append a widget to a dashboard

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 201 · Dashboard

  • id
    integerrequired
  • name
    stringrequired
  • widgets
    any[]required
  • created_by_id
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/project_report_templates

List the canned report-template catalog (Reports Library)

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired

Response · 200 · ReportTemplate[]

  • id
    integerrequired
  • template_key
    stringrequired
  • name
    stringrequired
  • tool_slug
    stringrequired
  • category
    stringrequired
  • data_source
    stringrequired
  • columns
    any[]required
  • filters
    objectrequired
GET /rest/v1.0/projects/{project_id}/project_report_templates/{id}

Show one report template (by id or template key)

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · ReportTemplate

  • id
    integerrequired
  • template_key
    stringrequired
  • name
    stringrequired
  • tool_slug
    stringrequired
  • category
    stringrequired
  • data_source
    stringrequired
  • columns
    any[]required
  • filters
    objectrequired
GET /rest/v1.0/projects/{project_id}/project_reports

List a project's saved library reports

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired

Response · 200 · ProjectReport[]

  • id
    integerrequired
  • name
    stringrequired
  • template_key
    string | null
  • tool_slug
    string | null
  • data_source
    stringrequired
  • columns
    any[]required
  • filters
    objectrequired
  • created_by_id
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
POST /rest/v1.0/projects/{project_id}/project_reports

Create a project report (from a template or custom)

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired

Response · 201 · ProjectReport

  • id
    integerrequired
  • name
    stringrequired
  • template_key
    string | null
  • tool_slug
    string | null
  • data_source
    stringrequired
  • columns
    any[]required
  • filters
    objectrequired
  • created_by_id
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/project_reports/{id}

Show a saved library report's configuration

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · ProjectReport

  • id
    integerrequired
  • name
    stringrequired
  • template_key
    string | null
  • tool_slug
    string | null
  • data_source
    stringrequired
  • columns
    any[]required
  • filters
    objectrequired
  • created_by_id
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
PATCH /rest/v1.0/projects/{project_id}/project_reports/{id}

Update a saved library report

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · ProjectReport

  • id
    integerrequired
  • name
    stringrequired
  • template_key
    string | null
  • tool_slug
    string | null
  • data_source
    stringrequired
  • columns
    any[]required
  • filters
    objectrequired
  • created_by_id
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/project_reports/{id}/run

Run a saved library report, returning computed rows

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · ComputedReport

  • key
    stringrequired
  • name
    stringrequired
  • columns
    object[]required
  • rows
    object[]required
  • summary
    object[]required
  • chart
    object | null
GET /rest/v1.0/projects/{project_id}/reports

List built-in and saved reports for a project

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integer | nullrequired
  • key
    stringrequired
  • name
    stringrequired
  • category
    stringrequired
  • data_source
    stringrequired
  • type
    stringrequired
POST /rest/v1.0/projects/{project_id}/reports

Create a saved (custom) report

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired

Response · 201 · SavedReport

  • id
    integerrequired
  • name
    stringrequired
  • data_source
    stringrequired
  • columns
    any[]required
  • filters
    objectrequired
  • created_by_id
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/reports/{id}

Get a computed report (built-in key or saved-<id>)

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired
  • id
    stringpathrequired

Response · 200 · ComputedReport

  • key
    stringrequired
  • name
    stringrequired
  • columns
    object[]required
  • rows
    object[]required
  • summary
    object[]required
  • chart
    object | null
GET /rest/v1.0/projects/{project_id}/scheduled_reports

List scheduled (delivered) reports

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired

Response · 200 · object[]

  • id
    integerrequired
  • report_key
    stringrequired
  • report_name
    stringrequired
  • frequency
    stringrequired
  • last_run_at
    string | null
  • last_status
    string | null
  • last_row_count
    integer | null
  • last_storage_key
    string | null
  • last_error
    string | null
  • recipient_ids
    integer[]
  • recipients
    object[]
  • created_by_id
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
POST /rest/v1.0/projects/{project_id}/scheduled_reports

Schedule a report for recurring delivery

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired

Response · 201 · ScheduledReport

  • id
    integerrequired
  • report_key
    stringrequired
  • report_name
    stringrequired
  • frequency
    stringrequired
  • last_run_at
    string | null
  • last_status
    string | null
  • last_row_count
    integer | null
  • last_storage_key
    string | null
  • last_error
    string | null
  • recipient_ids
    integer[]
  • recipients
    object[]
  • created_by_id
    integerrequired
  • created_at
    stringrequired
  • updated_at
    stringrequired
GET /rest/v1.0/projects/{project_id}/widget_data

Compute a single widget's chart data

v1.0ImplementedDeprecated: use the Analytics API

Parameters

  • project_id
    stringpathrequired

Response · 200 · ComputedWidget

  • type
    stringrequired
  • title
    stringrequired
  • data_source
    stringrequired
  • config
    objectrequired
  • stat
    object | null
  • series
    array | null
  • table
    objectrequired

Ask the OS

Reading this page

Ask anything about this page. Answers use what you're reading as context.

Suggested

    AI · may be imperfect · sample data where shown

    Open file