Skip to main content
Deprecated

The Reports API and its guides are deprecated and may be removed in a future release. Contact your Otter representative for migration options.

Report with a notification

Download a report when Otter calls your webhook with the file URL.

Before you begin​

Steps​

Report with a Notification Flow

  1. POST /v1/reports/generate with report type, an inclusive UTC start/end date range, and filters. Retain the returned jobId.
  2. Otter calls your Report generated (reports.report_generated) webhook with a download URL when the report is ready.
  3. If the best-effort webhook is missed, poll GET /v1/reports/{jobId}.
  4. Download the comma-delimited UTF-8 CSV promptly. Otter returns EXPIRED two days after workflow completion.

Verify​

Generate a small date-range report; webhook fires and file downloads successfully.

Next​