GuidesAPI Reference
API Reference
Select productLog inHelp centre

Messages sent report

get
https://{region}-api-freshrelevance.dotdigital.com/api//messages_sent/

Retrieves a report of any messages sent that match the specified filters.

Path Params
string
required

Website ID for the account you are posting data to.

Query Params
string
enum
required

Get data in JSON format.

Allowed:
integer
≥ 1
Defaults to 25

Get this number of records to return in results array (pagination).

integer
Defaults to 1

Which page of results you wish to return; First page is indexed as 1.

date-time

Start date for reporting data in ISO-8601 format, defaults to previous day.

date-time

End date for reporting data in ISO-8601 format, defaults to today.

string

The record id to get records from.

integer
enum
Defaults to -1

How to sort the messages using thweir id:

  • 1 - Ascending
  • -1 - Descending
Allowed:
string

Filter to messages to this email address.

string

Filter to messages sent by this program trigger key.

string
enum

Filter to messages sent of this type.

Allowed:
Responses

401

Unauthorized

403

Forbidden - Usually you are requesting data for a website you don't have access to.

Updated 11 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago