With the Sitefinity Insight REST API, you can personalize content in an easy and straightforward way.
You use this API to retrieve available personas, lead scorings, touchpoints, conversions, or contact properties for a given visitor or contact. You can select which information to obtain, making this call very efficient.
Authorization
x-dataintelligence-datacenterkey
x-dataintelligence-datasource
x-dataintelligence-subject
You declare in the body of the request what information you need. The body is a JSON-encoded object, containing the fields described below. All fields are optional, but the request must have at least one field.
Touchpoints
Conversions
PersonasIds
LeadsIds
ContactProperties
The PersonalizationEntitiesWithPeriod object contains the following fields, all of which are optional:
PersonalizationEntitiesWithPeriod
Ids
PeriodInDays
-1, 7, 30, 90, 180, and 365
{ Properties?: Object PassedLeads?: PersContextLead[], InPersonas?: PersContextPersona[], InTouchpoints?: PersContextEntityWithEventDate[], InConversions?: PersContextEntityWithEventDate[] }
Properties
ContactProperty
InPersonas
PassedLeads
InTouchpoints
InConversions
PersContextPersona
PersonaId
PersContextLead
LeadId
LevelId
PersContextEntityWithEventDate
Id
LatestEventDate
Headers:
Authorization: bearer token
x-dataintelligence-datacenterkey: c27aeeb7-d222-d848-d8bf-9792485dafa9
x-dataintelligence-datasource: Demo data
x-dataintelligence-subject: 1353
JSON response:
NOTE: Starting with Sitefinity Insight deployment on Jan 20, 2022, this API endpoint is obsoleted. We recommend you to use the POST /analytics/v1/personalization/visitor-context endpoint described above.
POST /analytics/v1/personalization/visitor-context
You send the following parameters in the header of the API request. All parameters are required.
{ Properties: ContactProperty[] InPersonas?: PersContextPersona[], PassedLeads?: PersContextLead[] }
You send the following parameters in the header of the API request.
x-dataintelligence-ids
The IDs of the lead scoring types in the data center you want check. You can check several lead scoring types at once by separating the IDs with a comma. For example: “10, 25, 36”.
“10, 25, 36”
{ “items”: LeadScoringResultV2 }
For details, see Lead scoring result API data type v2.
Returns:
x-dataintelligence-ids: 73, 74
HTTP method
The IDs of the personas in the data center you want check. You can check several personas at once by separating the IDs with a comma. For example: “1, 45, 24”.
“1, 45, 24”
{ “items”: ScoringResult [] }
For details, see Scoring result API data type.
x-dataintelligence-ids: 59, 60
JSON sample response:
x-dataintelligence-contacts
{ "Data Source 1 Name": [“Subject Id of Client 1”, “Subject Id of Client 2”], "Data Source 2 Name": [“Subject Id of Client 3”, “Subject Id of Client 4”] }
The IDs of the lead scoring types in the data center you want check. You can check several lead scoring types at once by separating the IDs with a comma. For example: “10, 25, 46”.
“10, 25, 46”
{ LeadScoringResultReport[] }
For details, see Lead scoring result report API data type.
x-dataintelligence-ids: 73
To submit feedback, please update your cookie settings and allow the usage of Functional cookies.
Your feedback about this content is important