Get Recipient Events
Endpoint: https://rest.virtualincentives.com/{version}/{format}/recipients/{id}/events
Method: GET
Definitions
Field | Type | Description |
---|---|---|
id | integer | The eventid for this recipient event.. |
date | datetime | Event date for this event. Format: MM/dd/yyyy HH:mm. |
name | string(50) | The type of event that occurred. Note: See Appendix C for definitions. |
note | string(500) | Notes specific to this event. |
Examples
XML Example
<recipient>
<id>258155</id>
<events>
<event>
<id>552803</id>
<date>03/16/2020 11:17</date>
<name>Order Created</name>
</event>
<event>
<id>552808</id>
<date>03/16/2020 11:17</date>
<name>Order Processing</name>
</event>
<event>
<id>552813</id>
<date>03/16/2020 11:17</date>
<name>Order Processed</name>
</event>
<event>
<id>552818</id>
<date>03/16/2020 11:17</date>
<name>Reward Email Viewed</name>
</event>
<event>
<id>552819</id>
<date>03/16/2020 11:17</date>
<name>Reward Email Link Clicked</name>
</event>
<event>
<id>552820</id>
<date>03/16/2020 11:17</date>
<name>Reward Claimed</name>
<note>Physical MasterCard® Reward (USD) - 6-Month</note>
</event>
</events>
</recipient>
JSON Example
{"recipient":{
"Id":"258155","events":[
{"id":"552803",
"date":"03/16/2020 11:17",
"name":"Order Created"},
{"id":"552808",
"date":"03/16/2020 11:17",
"name":"Order Processing"},
{"id":"552813",
"date":"03/16/2020 11:17",
"name":"Order Processed"},
{"id":"552818",
"date":"03/16/2020 11:17",
"name":"Reward Email Viewed"},
{"id":"552819",
"date":"03/16/2020 11:17",
"name":"Reward Email Link Clicked"},
{"id":"552820",
"date":"03/16/2020 11:17",
"name":"Reward Claimed",
"note":"Physical MasterCard® Reward (USD) - 6-Month"}]}}
Updated over 4 years ago