GET https://api.actonsoftware.com/api/1/message/{id}/report/{drilldown}
This endpoint allows you to drilldown on a report of a specified message.
Customers wanting to access our API via our gateway in the EU can use this link:
GET https://api-eu.actonsoftware.com/api/1/message/{id}/report/{drilldown}
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. |
| drilldown | Path | False | Required | String | Specify the type to be returned. ("SENT", "SUPPRESSED", "OPENED", "CLICKED", "BOUNCED", "OPT_OUT", "SPAM") |
| count | Query | False | Optional | String | Specify the number of elements to fetch. (Maximum=1000) |
| offset | Query | False | Optional | String | Specify the element offset to begin the fetch. (Default=0) |
| responseformat | Query | False | Optional | String | Specify the desired response format. ("JSON", "CSV") |
| Body | false | optional | File | The file to upload (in CSV format). |
Parameter Notes
responseformat
JSON is limited to 1,000 list members per API call, and the number of fields is limited to 255.
CSV can return the entire list even if it is large and the number of fields is unlimited.
Response
{
"offset": 0,
"count": 1,
"totalCount": 1,
"result": [
{
"listid": "l-0002",
"data": "CLICK",
"os": "OS X",
"ip": "148.163.177.2",
"browser": "Chrome",
"name": "John Doe",
"action": "Clickthrough",
"when": "Oct 7 2019 11:59 AM GMT-12:00",
"recid": "l-0002:0",
"email": "john.doe@act-on.com",
"ts": 1570492750136,
"linkURI": "http://google.com/"
}
]
}
Code Examples
cURL
curl -X GET https://api.actonsoftware.com/api/1/message/s-0001-1910/report/CLICKED -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"
Get in touch