Skip to main content
Reports let you package Causeloop’s analysis into shareable, time-bound summaries. You can generate a one-off report on demand, schedule recurring reports on a cron schedule, and export the underlying data in CSV, XLSX, JSON, or PDF format.

​
The Reports screen

Navigate to Reports in the left sidebar. The top-bar range control (7D / 30D / 90D) sets the default data window for new reports and for the live preview.

​
Creating a report

1

Open the Reports screen

Click Reports in the left sidebar.
2

Click New report

The report creation dialog opens.
3

Choose a template or type

Select from the available templates (see Report templates below), or choose a blank report and configure sections manually.
4

Set the window

Choose a data window: 7D, 30D, or 90D.
5

Choose a format

Select CSV, XLSX, JSON, or PDF. PDF is recommended for executive sharing; CSV/XLSX for data imports.
6

Generate

Click Generate. The report is created asynchronously. A job appears in the Jobs list — poll it until status is succeeded, then download from the download_url.
Report generation is handled by POST /v1/reports/generate. The response includes a job_id to poll at GET /v1/reports/jobs/{job_id}.

​
Report templates

Use GET /v1/reports/templates to list the available built-in templates. Templates include pre-configured sections tailored to common use cases:

​
Scheduling reports

Scheduled reports run automatically on a cron expression and deliver results to a list of recipients.

​
Creating a schedule

1

Open Schedules

In the Reports screen, click the Schedules tab.
2

Click New schedule

The schedule creation dialog opens.
3

Configure the schedule

Fill in:
  • Name — a label for this schedule
  • Cron expression — e.g. 0 9 * * MON for every Monday at 09:00
  • Timezone — e.g. America/New_York
  • Report type and window — which report to run and over what period
  • Recipients — email addresses or Slack channel IDs to deliver to
  • Format — output format (PDF recommended for email delivery)
4

Save

The schedule is active immediately. The next_run_at timestamp shows when it will first fire.
Schedules are created via POST /v1/reports/schedules. To run a schedule immediately without waiting for the next cron trigger, use POST /v1/reports/schedules/{id}/run-now.

​
Managing schedules

  • List all schedules: GET /v1/reports/schedules
  • Update a schedule: PATCH /v1/reports/schedules/{id} — update the cron, timezone, recipients, or format
  • Delete a schedule: DELETE /v1/reports/schedules/{id}
You can also attach schedules directly to a specific report definition:
  • POST /v1/reports/{id}/schedules — add a per-report schedule
  • PATCH /v1/reports/{id}/schedules/{sched_id} — update it
  • DELETE /v1/reports/{id}/schedules/{sched_id} — remove it

​
Viewing report history

Each saved report definition accumulates a run history. Open a report and switch to the Runs tab to see past executions with their status, duration, and download links.
  • List runs: GET /v1/reports/{id}/runs
  • Get a specific run: GET /v1/reports/{id}/runs/{run_id}
  • Trigger a new run: POST /v1/reports/{id}/run (returns 202 Accepted with a job_id)

​
Exporting data

In addition to structured reports, you can export the raw data behind any Causeloop entity.

​
Creating an export

1

Click Export

The Export button is available in the top bar of the Issues, Patterns, Predictions, and Recommendations list views.
2

Choose a format

Select CSV, XLSX, JSON, or PDF.
3

Apply filters (optional)

Exports respect the same filter parameters as the list endpoints. For example, export only P1 issues resolved in the last 30 days.
4

Download

Exports are asynchronous. A job is created via POST /v1/exports. Poll GET /v1/exports/{id} until status is succeeded, then download from download_url.
Exportable resources:
Exports require the reports:write scope. PDF exports may take longer to generate than CSV/XLSX. Large exports are automatically chunked.

​
API reference

Dashboard

The live dashboard — use reports for point-in-time snapshots.

Recommendations

Include recommendation coverage and attestation in reports.

Notifications & Alerts

Get notified when a scheduled report is ready.