Reports
Every Reports tool, with the scope it needs, its arguments and the API operation it calls.
10 tools
Get report analytics activity
Read onlyatlas_reports_analytics_activity_get
Recent cross-module activity timeline (PDF Studio + connector events). limit clamps 1-100; default 20.
- Scope
reports:read- Calls
- Example prompt
- What happened across PDF Studio and connectors today?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Page size (1-100). Defaults to 20. |
Get report analytics connectors
Read onlyatlas_reports_analytics_connectors_get
Connector detail report (per-provider event volume, failure rate, last sync) over the last N days.
- Scope
reports:read- Calls
- Example prompt
- Which connectors are failing the most this week?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
days | integer | No | Look-back window in days (1-365). Defaults to the server-side default (30). |
Get report analytics overview
Read onlyatlas_reports_analytics_overview_get
Cross-module analytics overview: PDF Studio + connector usage over the last N days. Window clamped server-side; default 30 days.
- Scope
reports:read- Calls
- Example prompt
- Show me the analytics overview for the past 14 days.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
days | integer | No | Look-back window in days (1-365). Defaults to the server-side default (30). |
Get report analytics PDF studio
Read onlyatlas_reports_analytics_pdf_studio_get
PDF Studio detail report (tool mix, success rate, average duration) over the last N days. Window clamped server-side; default 30 days.
- Scope
reports:read- Calls
- Example prompt
- How is PDF Studio performing this month?
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
days | integer | No | Look-back window in days (1-365). Defaults to the server-side default (30). |
List report delivery runs
Read onlyatlas_reports_delivery_runs_list
List recent report delivery runs (newest first). Filter by scheduleId, page size with limit (1-100, default 25), and pass the nextCursor of a page as cursor to read the next one.
- Scope
reports:read- Calls
- Example prompt
- Show the last 10 delivery runs for schedule sch_1.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
scheduleId | string | No | Filter to one schedule. Omit for all schedules in the tenant. |
limit | integer | No | Page size (1-100). Defaults to 25. |
cursor | string | No | The nextCursor of the previous page. Leave it out for the first page. |
sort | "startedAt" | "createdAt" | No | The field to sort on: startedAt (the default) or createdAt. |
order | "asc" | "desc" | No | asc or desc. Newest first (desc) by default. |
Create report delivery schedules
Changes dataatlas_reports_delivery_schedules_create
Create a new scheduled report delivery. Provide exactly one of savedViewId or reportSlug. Idempotent on retry.
- Scope
reports:write- Calls
- Example prompt
- Set up a weekly tasks-snapshot CSV to ops@example.com.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
savedViewId | string | No | Saved-view id to render; mutually exclusive with reportSlug. |
reportSlug | string | No | Built-in report slug; mutually exclusive with savedViewId. |
format | "csv" | "xlsx" | No | Artifact format. Defaults to csv server-side. |
dateRange | object | No | Optional fixed date window. Omit to use the report default window. |
visibleColumns | array of string | No | Optional projection - column keys to include in the artifact. |
frequency | "daily" | "weekly" | "monthly" | Yes | Cadence: daily / weekly / monthly. |
timezone | string | No | IANA timezone used to anchor the cadence. |
recipientEmails | array of string (email) | Yes | 1-20 RFC 5322 email recipients. |
status | "active" | "paused" | No | Initial status. Paused schedules skip the next run. |
Delete report delivery schedules
Destructiveatlas_reports_delivery_schedules_delete
Delete a scheduled delivery. 204 on success. Past run rows are retained for audit; only the future cadence is removed.
- Scope
reports:write- Calls
- Example prompt
- Delete the stale Q1 delivery schedule.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Report delivery schedule id. |
List report delivery schedules
Read onlyatlas_reports_delivery_schedules_list
List every scheduled CSV/XLSX report delivery in the tenant (frequency, timezone, recipients, status, last run summary).
- Scope
reports:read- Calls
- Example prompt
- What scheduled report deliveries do we have?
Arguments
This tool takes no arguments.
Run report delivery schedules
Changes dataatlas_reports_delivery_schedules_run
Trigger an immediate delivery run for one schedule, outside the cadence. Returns the new run row. Idempotent on retry.
- Scope
reports:write- Calls
- Example prompt
- Send the weekly snapshot now - I need it today.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Report delivery schedule id. |
Update report delivery schedules
Changes dataatlas_reports_delivery_schedules_update
Patch one or more mutable fields on a delivery schedule (frequency, timezone, recipients, status). At least one field is required.
- Scope
reports:write- Calls
- Example prompt
- Pause the weekly tasks-snapshot delivery.
Arguments
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Schedule id to patch. |
frequency | "daily" | "weekly" | "monthly" | No | |
timezone | string | No | |
recipientEmails | array of string (email) | No | |
status | "active" | "paused" | No |