Returns a weekly summary report for the given campaign.
Parameters on the following URL are inside braces { }
{base_url}/rest/api/getCampaignWeekReport/{instanceId}/{mimId}/{userName}/{date}/{publicKey}/{signature}
| Parameter Name | Description |
|---|---|
| instanceId | An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login |
| mimId | campaign ID, you can retrieve this information directly from the Campaign Manager |
| userName | The user name of the campaign's owner. This parameter must be Base64 encoded |
| date | The initial week day. A formatted date string: dd-MM-yyyy For more information please review the pattern letters quick reference |
| publicKey | The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login |
| signature | The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example |
The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.
<input>getCampaignWeekReport</input> <status>OK</status> <description>Completed</description> <result> <weekreport> <sunday>0</sunday> <monday>1</monday> <tuesday>1</tuesday> <wednesday>1</wednesday> <thursday>1</thursday> <friday>1</friday> <saturday>1</saturday> <total>6</total> </weekreport> </result>
| Parameter Name | Description | Possible Values |
|---|---|---|
| weekreport.sunday | Number of messages received for the campaign on Sunday | Number |
| weekreport.monday | Number of messages received for the campaign on Monday | Number |
| weekreport.tuesday | Number of messages received for the campaign on Tuesday | Number |
| weekreport.wednesday | Number of messages received for the campaign on Wednesday | Number |
| weekreport.thursday | Number of messages received for the campaign on Thursday | Number |
| weekreport.friday | Number of messages received for the campaign on Friday | Number |
| weekreport.saturday | Number of messages received for the campaign on Saturday | Number |
| weekreport.total | Number of messages received for the campaign the whole week | Number |