v1

latestSwagger 2.02026-07-13434569.6 KB
Messages API

Opens for all messages

get/messages/outbound/opens

Query parameters

countinteger required

Number of message opens to return per request. Max 500.

offsetinteger required

Number of messages to skip

recipientstring

Filter by To, Cc, Bcc

tagstring

Filter by tag

client_namestring

Filter by client name, i.e. Outlook, Gmail

client_companystring

Filter by company, i.e. Microsoft, Apple, Google

client_familystring

Filter by client family, i.e. OS X, Chrome

os_namestring

Filter by full OS name and specific version, i.e. OS X 10.9 Mavericks, Windows 7

os_familystring

Filter by kind of OS used without specific version, i.e. OS X, Windows

os_companystring

Filter by company which produced the OS, i.e. Apple Computer, Inc., Microsoft Corporation

platformstring

Filter by platform, i.e. webmail, desktop, mobile

countrystring

Filter by country messages were opened in, i.e. Denmark, Russia

regionstring

Filter by full name of region messages were opened in, i.e. Moscow, New York

citystring

Filter by full name of region messages were opened in, i.e. Moscow, New York

Headers

X-Postmark-Server-Tokenstring required

The token associated with the Server on which this request will operate.

Response

OK

TotalCountinteger