Skip to main content

​
Introduction

Courier’s /messages endpoint is designed to retrieve logs related to your message activity. This feature allows developers to track and analyze events, such as message deliveries or errors, across multiple notification channels.

​
Key Features

  1. Filter Options: You can filter logs by event type (e.g., delivery status), channel (email, SMS, etc.), or specific recipient.
  2. Pagination: Results are paginated, enabling you to retrieve logs in manageable chunks.
  3. Event Metadata: Logs include timestamps, event IDs, and detailed information about the status of each notification.

​
Usage Example

To query logs, send a GET request to the /messages endpoint with optional query parameters like event, messageId, recipient, or status. An example of a query might include: 
https://api.courier.com/messages?event=7SM32JEF1QMDN2N6D3YYMN5T79A2&status=OPENED&status=SENT&cursor=MTcwNTAxMTg2MDg2NiwxLTY1YTA2YTk1LTQ5YTA0MWY0YzNmOTExZmZmNDU2NGFkYw==

​
Message Response

The response from the API will return a paging object if there are more than 10 results. Users can use the cursor in subsequent query calls to paginate over the results. Only 10 can be fetched at a time.

​
Message History Retention

Dependant on your workspace tier, Courier customers have the following retention policies for their logs: Free and Pro
  • 30 day log retention
  • 30 day /messages/history retention
  • 30 day /messages/output retention
Business
  • 1 year log retention
  • 90 day /messages/history retention
  • 90 day /messages/output retention
Courier’s message UI logs share the same data that can be found in the /messages/history response. This includes steps like queued, sent, delivered, opened, etc. After the retention period has passed, this information will no longer be available.

​
Message Latency

The latency for retreiving message queries can range between a few seconds to a couple minutes in some exceptional cases. We recommend you implement message query fetching with a delay to avoid retreiving empty content.
{
	"paging": {
		"cursor": "MTY5MjgxMjc2NzUyOCwxLTY0ZTY0NWUwLTUwMjZlNTZiNjQ0ZTE0MmFkOWNjYWI5ZQ==",
		"more": true
	},
	"results": [
		{
			"enqueued": 1699560266998,
			"event": "<string>",
			"id": "<string>",
			"notification": "<string>",
			"opened": 1699733991001,
			"recipient": "rodrigo@courier.com",
			"recipientId": "email_2be96bfd56e7ea829bcab86862086406",
			"sent": 1699560269425,
			"status": "OPENED"
		},
		{
			"enqueued": 1699560266998,
			"event": "<string>",
			"id": "<string>",
			"notification": "<string>",
			"opened": 1699733991001,
			"recipient": "rodrigo@courier.com",
			"recipientId": "email_2be96bfd56e7ea829bcab86862086406",
			"sent": 1699560269425,
			"status": "OPENED"
		},
		{
			"enqueued": 1699560266998,
			"event": "<string>",
			"id": "<string>",
			"notification": "<string>",
			"opened": 1699733991001,
			"recipient": "rodrigo@courier.com",
			"recipientId": "email_2be96bfd56e7ea829bcab86862086406",
			"sent": 1699560269425,
			"status": "OPENED"
		},
		{
			"enqueued": 1699560266998,
			"event": "<string>",
			"id": "<string>",
			"notification": "<string>",
			"opened": 1699733991001,
			"recipient": "rodrigo@courier.com",
			"recipientId": "email_2be96bfd56e7ea829bcab86862086406",
			"sent": 1699560269425,
			"status": "OPENED"
		},
		{
			"enqueued": 1699560266998,
			"event": "<string>",
			"id": "<string>",
			"notification": "<string>",
			"opened": 1699733991001,
			"recipient": "rodrigo@courier.com",
			"recipientId": "email_2be96bfd56e7ea829bcab86862086406",
			"sent": 1699560269425,
			"status": "OPENED"
		},
		{
			"enqueued": 1694035495519,
			"event": "<string>",
			"id": "<string>",
			"listId": "<string>",
			"listMessageId": "<string>",
			"notification": "<string>",
			"recipient": "rodrigo@courier.com",
			"recipientId": "<string>",
			"sent": 1694035497475,
			"status": "SENT",
			"tags": [
				"opt-out"
			]
		},
		{
			"enqueued": 1699560266998,
			"event": "<string>",
			"id": "<string>",
			"notification": "<string>",
			"opened": 1699733991001,
			"recipient": "rodrigo@courier.com",
			"recipientId": "email_2be96bfd56e7ea829bcab86862086406",
			"sent": 1699560269425,
			"status": "OPENED"
		},
		{
			"enqueued": 1699560266998,
			"event": "<string>",
			"id": "<string>",
			"notification": "<string>",
			"opened": 1699733991001,
			"recipient": "rodrigo@courier.com",
			"recipientId": "email_2be96bfd56e7ea829bcab86862086406",
			"sent": 1699560269425,
			"status": "OPENED"
		},
		{
			"enqueued": 1699560266998,
			"event": "<string>",
			"id": "<string>",
			"notification": "<string>",
			"opened": 1699733991001,
			"recipient": "rodrigo@courier.com",
			"recipientId": "email_2be96bfd56e7ea829bcab86862086406",
			"sent": 1699560269425,
			"status": "OPENED"
		},
		{
			"enqueued": 1699560266998,
			"event": "<string>",
			"id": "<string>",
			"notification": "<string>",
			"opened": 1699733991001,
			"recipient": "rodrigo@courier.com",
			"recipientId": "email_2be96bfd56e7ea829bcab86862086406",
			"sent": 1699560269425,
			"status": "OPENED"
		}
	]
}