Customer Engagements REST Endpoints

Sort by

Task Path Method

Customer Engagements

The Customer Engagement resources represent customer engagements with communications sent by Opower. The API allows you to view Send, Open, Click, and Complaint engagements. The standard workflow for using the API: 1. Call Engagement API with offset=0 or omitted offset and with list of request parameters, by which you want to filter out an engagement data. 2. The response will include a list of engagement events to process and the next offset to use for the future call. 3. Take the new offset from the response and call the API once again with exactly the same list of request parameters. 4. Use new offset from the response to call again and again, till we got the response with missed next offset - it means that we don???t have any additional data to return.

Get Click Engagements

Method: get

Path: /apis/customer-engagement-v1/utilities/{utilityCode}/engagements/clicks

Get Complaint Engagements

Method: get

Path: /apis/customer-engagement-v1/utilities/{utilityCode}/engagements/complaints

Get module names by channel

Method: get

Path: /apis/spark-v1/v2/modules/{channel}/names

Get Open Engagements

Method: get

Path: /apis/customer-engagement-v1/utilities/{utilityCode}/engagements/opens

Get Send Engagements

Method: get

Path: /apis/customer-engagement-v1/utilities/{utilityCode}/engagements/sends

Get Track & Campaign name info for a utility

Method: get

Path: /apis/programDesign-v1/v1/utilities/{utilityCode}/tracks/names