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 without a notification

Poll for report status when you do not use the Report generated (reports.report_generated) webhook.

Before you begin

• Reports overview

Steps

1. POST /v1/reports/generate with type, an inclusive UTC start/end date range, and filters → a new jobId.
2. Poll GET /v1/reports/{jobId} until status is terminal.
3. Status values:

• IN_PROGRESS — keep polling
• READY — download from URL in response
• ERROR — read error details in response
• EXPIRED — generate a new report; the download URL is no longer available

4. Download the comma-delimited UTF-8 CSV promptly when READY. Otter returns EXPIRED two days after workflow completion.

Verify

Generate a test report; polling reaches READY and the URL returns a valid file.

Common failures

Symptom	Likely cause	Fix
Stuck IN_PROGRESS	Large range or backlog	Widen poll interval; narrow date range
ERROR	Invalid filters or type	Check API reference
EXPIRED	Report download window elapsed	Generate a new report

Next

• Report with a notification
• Reports overview