Skip to Content
ModulesReports

Reports (Report Builder)

The Tenant Plane Reports area (OBSERVE → Reports, URL /reports) is the Report Builder: you define reports, pick data sources and output format, optionally set a schedule, run on demand, and review run history. A separate page stores report dashboards (saved layouts) — see Report dashboards.


Open Report Builder

  1. Sign in to the Tenant Plane.
  2. Go to Reports in the sidebar (under OBSERVE).
  3. The header title in the product is Report Builder; subtitle: create, schedule, and generate reports from platform data.

Definitions and runs tabs

TabWhat you see
DefinitionsAll report definitions (name, type, format, schedule summary). Create new definitions and Run them.
RunsAggregated recent runs across definitions (status, format, timestamps). Open the Runs tab after executing reports to confirm completion.

Step-by-step: create a report definition

  1. Click + New Report (top right).

  2. Fill in Name (required), e.g. Weekly Executive Report.

  3. Choose Type: Executive Summary, Compliance, Incident, SLA, or Custom.

  4. Choose Output format: HTML, CSV, or JSON.

  5. Choose Schedule:

    • Off (manual) — no automatic cron; you run from the list when needed.
    • Daily — scheduled at 07:00 UTC every day.
    • Weekly07:00 UTC every Monday.
    • Monthly07:00 UTC on the 1st of each month.

    When you pick a non-empty schedule, the product also registers a schedule on the server for that definition (cron + timezone UTC).

  6. Under Data sources, toggle one or more sources (you need at least one):

    Incidents, Automation, KPIs, Compliance, SLOs, FinOps, Trends, ITSM tickets, ITSM catalog, Runbook executions.

  7. Click Create Report. The form closes and the new definition appears in Definitions.


Run a report on demand

  1. Stay on Definitions.

  2. Find the row and use the Run action.

  3. Behavior by format:

    • HTML — opens a new browser tab with the generated HTML.
    • CSV — triggers a file download (e.g. report-{id}.csv).
    • JSON — opens a new tab with formatted JSON.
  4. Switch to the Runs tab to see the latest run entries when needed.


Report dashboards (saved layouts)

From Report Builder, click Dashboards in the header to open /reports/dashboards. There you create named dashboard records with a stored layout (widgets are expanded in product iterations). See Report dashboards.


API and integrations (reference)

  • Definitions: GET/POST /api/reports
  • Run history per definition: GET /api/reports/{id}/run
  • Trigger run: POST /api/reports/{id}/run
  • Server schedule: POST /api/reports/{id}/schedule (used when you set Daily / Weekly / Monthly in the UI)

Report subscriptions (email distribution lists) may be managed via API where enabled; the main UI flow above focuses on definitions, schedules, and runs.


See also

  • Report dashboards — Create and list saved dashboard layouts
  • Dashboards — Operational Observe dashboards (metrics, logs, incidents), distinct from report dashboards
  • Dashboard design — Widget and layout practices for operational dashboards