Namespace Reference

Reports and dashboards

Curated JQL namespaces and examples for reports and dashboards.

Reports namespaces cover dashboards, dashlets, chart dashlets, report definitions, report history, chart generation controllers, and report execution.

Key namespaces and models

  • reports.Dashboard
  • reports.Dashlet
  • reports.TileDashlet
  • reports.PieChartDashlet
  • reports.LineChartDashlet
  • reports.BarChartDashlet
  • reports.WorkflowOptimaDashlet
  • reports.Report
  • reports.ReportHistory

Common controller intents

  • reports.Dashlet.createTileDashlet
  • reports.Dashlet.createPieChartDashlet
  • reports.Report.makeReport
  • reports.Chart.makePieChart
  • reports.Chart.makeTimeSeriesChart
  • reports.Chart.makeFunnelChart
  • reports.Chart.makeHeatmapChart

Common model intents

Most listed model namespaces support retrieve, retrieveOne, retrieveV2, create, update/patch, deleteOne, metadata, and aggregate subject to model permissions. Use consequence only for models that implement an on_<consequence> hook.

Retrieve example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "reports.Report", 5 "intent": "retrieve", 6 "authenticationClass": "jwt", 7 "ordering": "-created", 8 "limit": 20 9 }, 10 "id": null, 11 "created": null 12}

Create example

json
1{ 2 "__meta__": { 3 "schema": "model", 4 "namespace": "reports.Dashboard", 5 "intent": "create", 6 "authenticationClass": "jwt", 7 "return": { 8 "id": null, 9 "name": null, 10 "alias": null 11 } 12 }, 13 "name": "Executive dashboard", 14 "alias": "executive-dashboard" 15}

For examples that include foreign keys, numeric ids must refer to records in the same tenant and visible to the authenticated user.