Before calling the pixel-based APIs for each platform, you can call the PaidAudiencesContainer REST service to retrieve the paid audiences to which the website visitor belongs based on their customer ID and the destination key. The URL pattern for this service is:

http://<host>:<port>/prweb/PRRestService/PegaMKTContainer/V1/PaidAudiencesContainer

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

CustomerID

Used to identify individuals based on information captured during their interactions with the destination. For individuals yet to be identified, a unique id is stored in a browser cookie. Once an individual has been identified as a customer, their encrypted customer id is stored. For more information, see "Identity Matching" in the Pega Customer Decision Hub User Guide on the Pega Customer Decision Hub product page.

DestinationKey

Because the same individual may have different action priorities and eligibilities per destination, Paid audience membership can vary from one destination to another. To check the destination key for a specific destination, in App Studio, click SettingsChannelsPaid MediaWeb. Take note of the value in the Destination key column.

The paid web service is designed for low latency and does not execute Next-Best-Action for the site visitor which would update the individual's NBA Paid Audiences. However, the real-time container can be called separately to do so.

See below for a sample request and response:

Request:

{    
    "CustomerID":"101",   
    "DestinationKey::"DK6c378a63"
} 

Response:

{
    "ResponseData" : {
        "DK6c378a63" : {
            "PaidAudiences" : [{
                "AudienceId" : "f9d23ce5"
            }],
            "pxSubscript" : "DK6c378a63"
        }
    },
    "CustomerID" : "101"
} 

The AudienceId in the responses is generated by Paid Media Manager and associated with an audience generated in the paid destination. You can see the audience ID for each audience in the AUDIENCE KEY field on the Paid Media Audiences landing page.

Using the key instead of an audience name obfuscates the ad decision from the targeted individual. The actual audience name can be configured in downstream advertising platforms consuming the audiences.