Skip to main content

Table of Contents

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


Only available versions of this content are shown in the dropdown

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

The URL pattern for this service is:


Service Request

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

Name Required Description
CustomerID Customer identifier.

A sample invocation request is shown below:

  • {"CustomerID":
  • "CONNOR",}

Service Response

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

Name Description
OfferHistory An array of History records for the customer.

OfferHistory attributes for each record:

Name Description
Name Name of the action.
Issue Issue to which the action belongs.
Group Group to which the action belongs.
Channel Channel through which this action was communicated
Direction Direction of communication for this action.
InteractionID Interaction History record identifier for this action.
ExternalID Associated work object identifier.
OutcomeTime Time when the outcome was captured.
Outcome Response recorded for this action (for example, Accepted, Rejected, Impression)
Behaviour Behavior of the specified outcome (for example, Positive, Negative, Neutral)
Identifier Identifier for the action.
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"
  • }]
  • }
Did you find this content helpful?

Have a question? Get answers now.

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

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice
Contact us