Analytics
Get Analytics Summary [GET]
get
/analytic/summary
Request
GET
/analytic/summaryParameters
fromstringrequired
Type: query
Description:
tostringrequired
Type: query
Description:
sandboxbooleanoptional
Type: query
Description:
sandboxSubAccountIdintegeroptional
Type: query
Description:
Parameters
GET
/analytic/summary?from=string&to=string&sandbox=true&sandboxSubAccountId=1Response
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties bounceRatenumber bouncedinteger clickRatenumber clickedinteger deliveredinteger deliveryRatenumber namestring Description: openRatenumber openedinteger periodobject Object Properties fromstring tostring sentinteger unsubscribeRatenumber unsubscribedinteger | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Get Analytics Summary Breakdown [GET]
get
/analytic/summary/breakdown
Request
GET
/analytic/summary/breakdownParameters
fromstringrequired
Type: query
Description:
tostringrequired
Type: query
Description:
groupBystringoptional
Type: query
Description:
sandboxbooleanoptional
Type: query
Description:
sandboxSubAccountIdintegeroptional
Type: query
Description:
Parameters
GET
/analytic/summary/breakdown?from=string&to=string&groupBy=string&sandbox=true&sandboxSubAccountId=1Response
| Code | Description | Type |
|---|---|---|
| 200 | array | |
array of object Object Properties bounceRatenumber bouncedinteger clickRatenumber clickedinteger deliveredinteger deliveryRatenumber namestring Description: openRatenumber openedinteger periodobject Object Properties fromstring tostring sentinteger unsubscribeRatenumber unsubscribedinteger | ||
| 400 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
400
401
500
Get Email Transmission Status [GET]
get
/analytic/transmission/{id}
Request
GET
/analytic/transmission/{id}Parameters
idstringrequired
Type: path
Description:
Parameters
GET
/analytic/transmission/stringResponse
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties createdAtinteger fromobject Object Properties emailstring namestring recipientCountinteger statsobject Object Properties bouncedinteger clickedinteger deliveredinteger openedinteger unsubscribedinteger statusstring subjectstring transmissionIdstring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
401
500
Get List Transmission Events [GET]
get
/analytic/transmission/{id}/events
Request
GET
/analytic/transmission/{id}/eventsParameters
idstringrequired
Type: path
Description:
Parameters
GET
/analytic/transmission/string/eventsResponse
| Code | Description | Type |
|---|---|---|
| 200 | object | |
Object Properties eventsarray of object Object Properties friendlyFromstring reasonstring recipientstring subjectstring timestampinteger typestring urlstring userAgentstring | ||
| 401 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
| 500 | object | |
Object Properties dataobject Object Properties Empty Object errorstring messagestring | ||
Response
200
401
500