Export the filtered log as CSV

GET

/api/v1/workspaces/{workspace}/transactional/messages/export

curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/transactional/messages/export?status=all&range=1h&limit=25' \
  --header 'Authorization: Bearer <token>'

• Your ReputeCast public URL

Permission: transactional:content (sensitive)

Holds recipient addresses, so it needs transactional:content. Up to 50,000 rows; every export is audited.

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Query Parameters

status

string

default: all

Allowed values: all queued sent delivered deferred bounced complained rejected failed test

template

A template’s ID, or raw for mail that arrived by SMTP

string

<= 64 characters

A template’s ID, or raw for mail that arrived by SMTP

provider

A sending provider’s ID

string

<= 36 characters

A sending provider’s ID

key

An API key’s ID

string

<= 36 characters

An API key’s ID

range

string

default: 24h

Allowed values: 1h 24h 7d 30d custom

from

First day of a custom range (YYYY-MM-DD, the workspace’s time zone), within the last 90 days

string

<= 10 characters

First day of a custom range (YYYY-MM-DD, the workspace’s time zone), within the last 90 days

to

Last day of a custom range

string

<= 10 characters

Last day of a custom range

q

Recipient, message ID, idempotency key, tag or metadata value

string

<= 254 characters

Recipient, message ID, idempotency key, tag or metadata value

before

Next of the previous page: older messages

string

<= 200 characters

Next of the previous page: older messages

after

Newest of a page: only newer messages (live updates)

string

<= 200 characters

Newest of a page: only newer messages (live updates)

limit

integer format: int64

default: 25 >= 1 <= 100

Responses

200

OK

Media typeapplication/json

string

Example ^generated

example

Headers

Cache-Control

string

Content-Disposition

string

default

Error

Media typeapplication/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}