Skip to main content
GET
List delivery reports

Authorizations

Authorization
string
header
required

Project API key (sk_live… or sk_dev…). Send it as Authorization: Bearer <api_key>.

Query Parameters

limit
integer
default:100

Number of reports to return. Min: 1, max: 500.

Required range: 1 <= x <= 500
Example:

50

status
string

Comma-separated list of report statuses to filter by. Allowed: available, expired, deleted.

Example:

"available,expired"

Response

List of delivery reports. Each report includes downloadUrl for direct CSV download.

_id
string
required

MongoDB ObjectId of the report

Example:

"65a1b2c3d4e5f6789012345"

reportId
string
required

Same as _id; convenience for API consumers

downloadUrl
string<uri>
required

Use this URL to download the CSV. No separate download endpoint.

recordCount
integer
required

Number of message rows in the report

dateRange
object
required
status
enum<string>
required
Available options:
available,
expired,
deleted
project
string

Project ObjectId

filename
string

Storage filename

fileId
string

Storage provider file identifier

filters
object

Applied filters

expiresAt
string<date-time>

Reports valid for 30 days

createdAt
string<date-time>
updatedAt
string<date-time>