Reports

Permanently delete a saved report definition. If it was shared, it disappears for the whole account. The underlying data is untouched — only the saved definition is removed — but this cannot be undone. Only the report's creator or an account admin can delete one.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/reports.delete_saved \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool reports_delete_saved at https://app.chirply.io/api/mcp, same bearer token, same input.

List the report catalog: every dataset the report builder can query, with its available dimensions, metrics, and filters. Read this first to build a valid reports.run call.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/reports.describe_catalog \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool reports_describe_catalog at https://app.chirply.io/api/mcp, same bearer token, same input.

List the saved report definitions this caller can see: reports shared with the account plus their own. Account admins (and API keys) see every saved report in the organization.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/reports.list_saved \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool reports_list_saved at https://app.chirply.io/api/mcp, same bearer token, same input.

List the standing email schedules for saved reports: which saved report, its daily/weekly/monthly cadence, the recipient emails, whether it's on, when it last sent, and any delivery error. Members see the schedules they created; account admins (and API keys) see every schedule. Read-only.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/reports.list_schedules \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Over MCP the same operation is the tool reports_list_schedules at https://app.chirply.io/api/mcp, same bearer token, same input.

Run a custom report over one of the curated datasets — contacts (Contacts), deals (Deals), calls (Calls), messages (Messages), appointments (Appointments), revenue (Revenue) — bucketed by day/week/month or as totals, optionally split by one dimension, with 1–3 metrics and the dataset's filters. Returns table rows and a chart-ready series. Read-only; money figures are integer cents.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/reports.run \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "dataset": "contacts",
    "metrics": [
      "example"
    ]
  }'

Over MCP the same operation is the tool reports_run at https://app.chirply.io/api/mcp, same bearer token, same input.

Save a report definition so it can be re-run later, or update an existing saved report when an id is given. Setting shared=true makes it visible to every member of the account. The definition is validated against the report catalog before it is stored. Only the report's creator or an account admin can update one.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/reports.save \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Example",
    "dataset": "contacts",
    "metrics": [
      "example"
    ]
  }'

Over MCP the same operation is the tool reports_save at https://app.chirply.io/api/mcp, same bearer token, same input.

Immediately runs one saved report and emails its current results — a REAL email to the given addresses, sent through the workspace's own connected email account (Mailgun/Resend, on the org's bill). Up to 20 addresses per send. Only works on a saved report the caller can see: one shared with the workspace, one they saved themselves, or any of them for a workspace admin. Omit recipients to use the ones saved on the report's email schedule. Does not move the schedule's clock: the next scheduled send still happens on time.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/reports.send_scheduled_now \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "saved_report_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Over MCP the same operation is the tool reports_send_scheduled_now at https://app.chirply.io/api/mcp, same bearer token, same input.

Create or update the ONE standing email schedule for a saved report: cadence ('daily' sends every day (UTC); 'weekly' sends every Monday (UTC); 'monthly' sends on the 1st of each month (UTC) — all UTC), the addresses it goes to, and whether it's on. Enabling it means the report's CURRENT results are emailed to those addresses automatically — real email through the workspace's own connected email account (Mailgun/Resend, on the org's bill) — until it is paused. No email is sent by this call itself. Only the schedule's creator or a workspace admin can change an existing one.

Parameters

Example

curl -X POST https://app.chirply.io/api/v1/actions/reports.set_schedule \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "saved_report_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "recipients": [
      "example"
    ]
  }'

Over MCP the same operation is the tool reports_set_schedule at https://app.chirply.io/api/mcp, same bearer token, same input.