Skip to content

Scheduling & Sharing

Send reports to your team on a recurring schedule, share them with external stakeholders via public links, or export data as CSV or PDF for offline use.


Scheduling Reports

You can schedule any saved report for automated delivery. Each report can have one schedule.

Note

A scheduled report is delivered with the data from its own environment. A report created in test mode delivers test data; a report created in live mode delivers live data. The environment follows the report, not the person or job that sends it.

Creating a Schedule

A schedule requires:

SettingDescriptionOptions
FrequencyHow often to senddaily, weekly, monthly
HourTime of day, interpreted in the schedule's timezone0--23
TimezoneTimezone the send hour is interpreted in (default UTC)Any IANA timezone (e.g., UTC, Asia/Singapore)
Day of weekRequired for weekly schedules0 (Monday) -- 6 (Sunday)
Day of monthRequired for monthly schedules1--31 (end-of-month aware)

The send hour is a local wall-clock time in the schedule's timezone. A schedule set to hour 9 in America/New_York sends at 9:00 AM New York time and stays correct across daylight-saving transitions. | Date range type | Which period the report covers | See below | | Recipients | Email addresses to send to | 1--10 recipients |

Date Range Types

The date range type determines what time period the scheduled report covers:

TypeCovers
previous_dayYesterday (midnight to midnight)
previous_7dLast 7 days
previous_30dLast 30 days
previous_monthThe entire previous calendar month
mtdMonth to date (1st of current month to now)

Format Options

Each scheduled delivery can include:

OptionDefaultDescription
chart_imagefalseInclude a chart image in the email
csv_attachmentfalseAttach the report table data as a CSV file
kpi_onlyfalseSend only the KPI summary (no table or chart)
Note

Monthly schedules accept a day of month from 1 to 31. If the chosen day is past the length of a given month, the report runs on that month's last day instead -- so 31 sends on the 30th in a 30-day month, and on the 28th (or 29th in a leap year) in February.


Managing Schedules

Pausing and Resuming

You can pause a schedule without deleting it. A paused schedule retains all its settings but stops sending until resumed. When you resume a schedule, the next send time is recalculated based on the current date and the schedule's frequency.

Updating a Schedule

Any schedule setting can be updated individually -- you don't need to send the full configuration. Only the fields you include in the update request are changed. The next send time is automatically recalculated after every update.

Deleting a Schedule

Deleting a schedule is permanent. The report itself is not affected -- only the schedule is removed.


Sharing Reports

Generate a public link for any report. Anyone with the link can view the report data without logging in.

When you create a share link, you specify how long it should be valid:

SettingDefaultRange
expires_in_days71--90 days

The share link URL looks like: https://synapse-api.pyrx.tech/v1/reports/shared/{token}

The shared view shows the same KPIs, chart data, and table data as the original report, rendered in the report's own environment -- a shared test-mode report shows test data, and a shared live report shows live data. Viewers can optionally pass a date_range query parameter to change the time period (defaults to 30 days).

Revoking a share link immediately invalidates it. Anyone who visits the link after revocation will see a 404 error. You can create a new share link at any time after revoking.

Warning

Shared links expose report data without authentication. Only share reports that contain data appropriate for the audience. The link can be forwarded to anyone.

When a share link passes its expiration date, viewers see a 410 (Gone) response. The share token remains on the report record until you explicitly revoke it or create a new one.


Exporting Reports

CSV Export

Export the report's table data as a CSV file. The CSV includes all columns from the table view with headers matching the column names.

The export respects the date range you specify. If no date range is provided, it uses the report's default.

The file is named after the report: spaces are replaced with underscores and the name is lowercased. For example, "Email Performance Overview" becomes email_performance_overview.csv.

PDF Export

The PDF export generates a print-ready HTML page that opens with the browser's print dialog. It includes:

  • Report name, description, and date range
  • KPI summary cards with trend indicators
  • Data table (limited to 100 rows for readability)
  • Generation timestamp
Tip

For the best PDF output, use your browser's "Save as PDF" option in the print dialog. The page is styled specifically for print media with clean formatting.


Permissions

All report operations require the analytics:read permission. The following roles have this permission:

RoleCan access reports
OwnerYes
AdminYes
DeveloperYes
MarketingYes
OperationsYes
ViewerYes

Reports are workspace-scoped. All members with analytics:read can view workspace-visible reports. Private reports are only visible to the creator.