Get messages
Post /statistics/messages
Parameters:
Name | Description | Type | Mandatory |
---|---|---|---|
page | Page number | Int | No |
pageSize | Number of item returned | Int | No |
dateBegin | Date begin yyyy-MM-ddThh:mm:ssZ | Int | No |
dateEnd | Date end yyyy-MM-ddThh:mm:ssZ | Int | No |
froms | Array of Senders email | Array | No |
apiKeys | Array of api keys | Array | No |
tags | Array of tags | Array | No |
Response:
Name | Description | Type | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | Message Id | String | |||||||||||||||
apiKey | Api key used to send the email | String | |||||||||||||||
createdDate | Date on timestamp | Int | |||||||||||||||
lastStateDate | Last status date on timestamp | Int | |||||||||||||||
msg |
|
Object | |||||||||||||||
tags |
|
Array | |||||||||||||||
lastState | Last status of the email | Int | |||||||||||||||
meta |
|
Object | |||||||||||||||
reason | reason | null | |||||||||||||||
open | Open | INT | |||||||||||||||
click | click | INT | |||||||||||||||
openDetails |
|
Array | |||||||||||||||
ClickDetails |
|
Array |
Programming language:
Request exemple:
1 2 3 4 5 6 | { "dateBegin" : "2019-06-10T12:50:04" , "dateEnd" : "2019-06-12T12:50:04" , "tags" :[ "welcome" ] } |
Response exemple:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 | { "messages" : [ { "id" : "5d00f65e99321602e57d89ae" , "apiKey" : "YOUR_API_KEY" , "createdDate" : "2019-06-12T12:55:54.306+0000" , "lastStateDate" : "2019-06-12T12:55:55.829+0000" , "msg" : { "from" : "tipimail@tipimail.com" , "email" : "recipient@tipimail.com" , "subject" : "email subject" , "size" : 7070 }, "tags" : [ "documentation" , "support" ], "lastState" : "delivered" , "meta" : {}, "reason" : null , "open" : 0, "click" : 0, "openDetails" : [], "clickDetails" : [] }, { "id" : "5d00f4fc9932583ad076d962" , "apiKey" : "YOUR_API_KEY" , "createdDate" : "2019-06-12T12:50:02.345+0000" , "lastStateDate" : "2019-06-12T12:50:04.111+0000" , "msg" : { "from" : "checker@tipimail.com" , "email" : "recipient@tipimail.com" , "subject" : "email subject" , "size" : 435 }, "tags" : null , "lastState" : "delivered" , "meta" : null , "reason" : null , "open" : 0, "click" : 0, "openDetails" : [], "clickDetails" : [] } ], "total" : 2 } |