Get Message Report

GET https://restapi.actonsoftware.com/api/1/message/{id}/report

This endpoint will return a report of a specified message.

Parameters

Name Parameter
Type
Allow
Multiple
Required/
Optional
Data Type Description
Authorization: Header False Required String Insert your generated access token.
("Bearer {access token}")
id Path False Required String Specify the ID of the message.

Response

{
  "status": "ok",
  "sent": 1,
  "delivered": 0,
  "bounced": 0,
  "hardBounced": 0,
  "softBounced": 0,
  "opened": [
    1,
    2
  ],
  "effectiveopened": [
    0,
    0
  ],
  "clicked": [
    1,
    1
  ],
  "notsent": [
    0,
    0
  ],
  "notopened": 0,
  "optout": 0,
  "spam": 0,
  "lastOpen": "now",
  "lastClick": "now",
  "lastOpenTS": 1570492750125,
  "lastClickTS": 1570492750136,
  "rebroadcast": 0,
  "rebroadcastClick": 0,
  "msgId": "s-0001-1910",
  "subject": "Example Email",
  "title": "Example Email",
  "sentto": [
    "l-0002"
  ],
  "suppressedon": []
}
* Delivered has been deprecated and will not return a value.

Code Examples

curl -X GET https://restapi.actonsoftware.com/api/1/message/s-0001-1910/report -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"