Generate Delivery Report
Create CSV delivery reports for SMS/messages in a date range
downloadUrl from the response to download the CSV file directly. There is no separate download endpoint—reports are available for 30 days after generation.CSV content
The downloaded CSV includes these columns:Authorizations
Project API key (sk_live… or sk_dev…). Send it as Authorization: Bearer <api_key>.
Body
Report generation parameters. startDate and endDate are required.
Start of the date range (ISO 8601, e.g. 2026-01-01T00:00:00.000Z)
"2026-01-01T00:00:00.000Z"
End of the date range (ISO 8601). Must be on or after startDate.
"2026-01-31T23:59:59.999Z"
If provided, only messages to these phone numbers are included
^\+?[0-9]+$If provided, only messages with these delivery statuses are included
pending, sent, delivered, read, failed Response
Delivery report generated successfully. Use downloadUrl to fetch the CSV file.
MongoDB ObjectId of the report
"65a1b2c3d4e5f6789012345"
Same as _id; convenience for API consumers
Use this URL to download the CSV. No separate download endpoint.
Number of message rows in the report
Reports valid for 30 days
available, expired, deleted Success message
"Delivery report generated successfully"
Project ObjectId
Storage filename
Storage provider file identifier