GET https://restapi.actonsoftware.com/api/1/message/report?period={yymm}
This endpoint allows you to return a report for a message in a specified time period.
Parameters
| Name | Parameter Type |
Allow Multiple |
Required/ Optional |
Data Type | Description |
|---|---|---|---|---|---|
| Authorization: | Header | False | Required | String | Insert your generated access token. ("Bearer {access token}") |
| Period: | Query | False | Optional | String | Specify the time period for the report. (Format: YYMM, eg. "1401") |
Response
{
"month": "October 2019",
"counts": [
{
"optedOut": 0,
"dayOfWeek": 3,
"dayOfMonth": 1,
"hardBounced": 0,
"softBounced": 0,
"opened": 0,
"bounced": 0,
"clicked": 0,
"sent": 0
},
{
"optedOut": 0,
"dayOfWeek": 4,
"dayOfMonth": 2,
"hardBounced": 0,
"softBounced": 0,
"opened": 0,
"bounced": 0,
"clicked": 0,
"sent": 0
},
{
"optedOut": 0,
"dayOfWeek": 5,
"dayOfMonth": 3,
"hardBounced": 0,
"softBounced": 0,
"opened": 0,
"bounced": 0,
"clicked": 0,
"sent": 0
},
{
"optedOut": 0,
"dayOfWeek": 6,
"dayOfMonth": 4,
"hardBounced": 0,
"softBounced": 0,
"opened": 0,
"bounced": 0,
"clicked": 0,
"sent": 0
},
{
"optedOut": 0,
"dayOfWeek": 7,
"dayOfMonth": 5,
"hardBounced": 0,
"softBounced": 0,
"opened": 0,
"bounced": 0,
"clicked": 0,
"sent": 0
},
{
"optedOut": 0,
"dayOfWeek": 1,
"dayOfMonth": 6,
"hardBounced": 0,
"softBounced": 0,
"opened": 0,
"bounced": 0,
"clicked": 0,
"sent": 0
}
]
}
Code Examples
cURL
curl -X GET https://restapi.actonsoftware.com/api/1/message/report?period=1910 -H "Authorization: Bearer 12345678-9abc-defg-hijk-lmnopqrs"