Profile Anywhere is part of the Enrich Anywhere app family, along with Audiences Anywhere.
This server-side API retrieves user affinity data generated by Dynamic Yield, enabling you to offer enhanced personalized experiences to your customers across all of your touchpoints, both online and offline.
Here are some of the main benefits of using Profile Anywhere:
- Deliver the same personalized shopping experience online and in-person: In-store representatives know customer preferences and make personalized recommendations.
- Create a positive and personalized customer service experience: Contact center reps get user behavioral profiles, rich with information about past engagements and preferences.
- Fine-tune your marketing campaigns with user affinity data: Enrich your marketing tools with additional data (such as affinity and loyalty status), for more personalized campaigns.
Get started with Profile Anywhere
Profile Anywhere includes three tabs: API Logs, Documentation, and API Keys.
The first time you enter the Profile Anywhere app, the app is in an "empty state", because you don't have any information yet. To start calling APIs and viewing log information, you must first generate an API key:
- Go to the API Keys tab, and click Create Key.
- Enter a name for the key, add optional notes, and then click Save.
To use the API key, click the Copy icon in the API key row:
Now, you're ready to start calling your APIs. You can use the instructions and sample code in the Documentation tab in the OS, as well as the API reference information in this article.
The API call
US data center:
https://dy-api.com/v2/userprofile?{parameters}
European data center:
https://dy-api.eu/v2/userprofile?{parameters}
Note: To determine which data center to call, look at your URL when you're logged in to Experience OS, and see whether it is .com or .eu, and send your call to the respective address.
HTTP Method |
|
Headers |
|
Parameters |
|
Call examples
External identifier
curl --request GET \
--url https://dy-api.com/v2/userprofile?cuid=-13510582476552222&cuidType=external&affinity=true \
--header 'content-type: application/json' \
--header 'DY-API-Key: baadc6ba740a352c9106dc7857a7eb9c' \
Hashed email address
curl --request GET \
--url https://dy-api.com/v2/userprofile?cuid=e3dc597r34yfz0641a65e7ed2bv65l16&cuidType=he&affinity=true \
--header 'content-type: application/json' \
--header 'DY-API-Key: baadc6ba740a352c9106dc7857a7eb9c' \
The response
The response includes an array with affinity properties and values for the requested user, sorted according to their ranking. If the user doesn’t have an affinity profile, the response is empty.
Response example
{
"affinity": {
"color": {
"Black": 1,
"White": 2,
"Red": 3
},
"categories": {
"Men": 1,
"Flats": 2,
"Shoes": 3,
"Trainers": 4,
"Sneakers": 5
}
}
}
Profile Anywhere logs
As soon as you begin making API calls, the log information is displayed in the API Logs tab. Use to validate the implementation and troubleshoot failed calls. By default, the report displays all calls made over the last 7 days, divided into 4-hour blocks, with indications of the number of successful and failed calls.
You can search for specific API requests by the transaction ID or the user’s CUID. Or, you can use the filters in the Filters pane to view a different time range, or find calls according to status.
Click an API call row to view more detailed information.
Limitations
- Rate limit: 50 calls per second