Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Accessing a customer's interaction history with the CustomerOfferHistory REST service

Updated on September 15, 2022

CustomerOfferHistory is a REST service that supports both GET and POST HTTP methods. This service returns the Interaction History records for a customer.

Pega Customer Decision Hub

The URL pattern for this service is:


Service Request

For the request, the service expects a JSON Object with the following attributes:

CustomerIDCustomer identifier.

A sample invocation request is shown below:


Service Response

For the response, the service returns a JSON object with the following attributes:

OfferHistoryAn array of History records for the customer.

OfferHistory attributes for each record:

NameName of the action.
IssueIssue to which the action belongs.
GroupGroup to which the action belongs.
ChannelChannel through which this action was communicated
DirectionDirection of communication for this action.
InteractionIDInteraction History record identifier for this action.
ExternalIDAssociated work object identifier.
OutcomeTimeTime when the outcome was captured.
OutcomeResponse recorded for this action (for example, Accepted, Rejected, Impression)
BehaviourBehavior of the specified outcome (for example, Positive, Negative, Neutral)
IdentifierIdentifier for the action.
Note: For Negotiation history records, there is a nested OfferHistory element which is an array of action names.

A sample service response is shown below:

{"OfferHistory": [{"Name": "Negotiation","Issue": "Negotiation","Channel": "CallCenter","InteractionID": "7382338912749122452","ExternalID": "S-13805","OutcomeTime": "20160225T125501.526 GMT","Behaviour": "Negative","OfferHistory": [{ "Name": "Handsets_fromGoogleNexus4" },{ "Name": "DataPlan100Min" },{ "Name": "MemoryCard_V2_M3" }],"Outcome": "Rejected","Identifier": "/Negotiation/Negotiation/Negotiation","Direction": "Inbound","Group": "Negotiation"},{"Name": "MI","Issue": "Sales","Channel": "CallCenter","InteractionID": "-7714067498846096636","ExternalID": "","OutcomeTime": "20160224T101058.055 GMT","Behaviour": "Positive","Outcome": "Accepted","Identifier": "/Sales/Handsets/MI","Direction": "Inbound","Group": "Handsets"}]}
  • Previous topic Capturing responses to actions in the Agent Assisted channel with the CaptureOrder service
  • Next topic Capturing clicks on the click-through URL

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us