Create a request for SMS campaign performance metrics
Note: The Asynchronous API is generally available for all Responsys customers.
Service URL:
/rest/asyncApi/v1.3/performanceAnalytics/campaigns/sms
Request Method:
POST
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
sendFromDate – Start date from which data is required. In the format YYYY-MM-DD.
sendToDate – End date to which data is required. In the format YYYY-MM-DD.
Request Body - Optional Properties:
campaignName – Name of the campaign.
programName – Name of the program.
folderName – Name of the folder where the campaign is located.
Sample Request Body:
{
"sendFromDate":"2018-09-10",
"sendToDate":"2018-09-12",
"campaignName":"Test Campaign",
"programName":"Test Program",
"folderName":"Test Folder"
}
Response Notes:
- A successful response for the asynchronous API returns an HTTPS status code of 202 Accepted.
- A successful response returns a requestId, to be used in the Polling API endpoint to retrieve the status of your request.
- See Common error responses for the Asynchronous API for details about the error responses.
Sample Response - Successful
{
"requestId": "dWt2ZU9zOjoxNTUxNzI4OTA0",
"apiName": "asyncPerformanceAnalyticsSms",
"status": "REQUEST_ACCEPTED",
"links": [
{
"rel": "self",
"href": "/rest/asyncApi/v1.3/performanceAnalytics/campaigns/sms",
"method": "POST"
},
{
"rel": "asyncResponse",
"href": "/rest/asyncApi/v1.3/performanceAnalytics/requests/dWt2ZU9zOjoxNTUxNzI4OTA0",
"method": "GET"
}
]
}