API Dataverse pour Customer Insights - Data
Si vous utilisez déjà les API Customer Insights - Data, comme interroger un profil client ou obtenir des adhésions de segment, nous vous recommandons de migrer vos API vers les API Dataverse à la place. La prise en charge de l’interrogation des métadonnées, telles que la définition de segment d’obtention et la gestion des flux de travail, sera bientôt disponible sur les API Dataverse.
Si vous commencez à interroger des données à l’aide d’API, nous vous recommandons d’utiliser les API Dataverse à la place.
Important
Il est recommandé d’utiliser les API Dataverse uniquement pour lire des données (GET) et non pour écrire des données (POST/PATCH/PUT), car cela peut entraîner des problèmes avec le traitement de Customer Insights - Data.
Dataverse Les API présentent les avantages suivants :
Capacités étendues de filtrage et de tri
Mise à l’échelle et performance améliorées
Expérience API cohérente dans Dynamics 365 et applications Power Platform
Exemples de requêtes
Pour commencer à utiliser les API Dataverse, créez un enregistrement d’application dans Azure et demandez des autorisations pour Dataverse et accordez vos autorisations du lecteur d’application sur Customer Insights - Data.
Modifiez les exemples de requêtes pour les faire fonctionner sur les environnements cibles :
{serviceRoot}:
{Organization URI}/api/data/v9.2/
où {URI de l’organisation} est l’URI du Dataverse tenant associé à votre environnement. Par exemple :https://{mydvorg}.crm.dynamics.com
{CID} : GUID d’un enregistrement de client unifié. Par exemple :
ce759201f786d590bf2134bff576c369
.{AlternateKey} : Identifiant de la clé primaire d’un enregistrement de client dans une source de données. Par exemple :
CNTID_1002
.{DSname} : Chaîne avec le nom de table d’une source de données qui est ingéré dans Customer Insights - Data. Par exemple :
Website_contacts
.{SegmentName} : Chaîne avec le nom de la table de sortie d’un segment. Par exemple :
Male_under_40
.{CookieId} : Identifiant de chaque visiteur du site web. Celui-ci est généré automatiquement lors de l’utilisation du script de suivi Web. Par exemple :
3f43317e-d1ef-4cd3-9917-2d3342111d1a
.
Customer
Exemples de requêtes pour la table CustomerProfile et les membres du segment.
Type de requête | Exemple | Note |
---|---|---|
Obtenir tous les clients | {serviceRoot}/msdynci_customerprofiles |
|
Obtenir un client par ID | {serviceRoot}/msdynci_customerprofiles?$filter=msdynci_customerid eq '{CID}' |
|
Obtenir un client par clé secondaire | {serviceRoot}/msdynci_customerprofiles?$filter={msdynci_alternate_column} eq '{AK}' |
Les clés alternatives persistent dans la table client unifiée au format msdynci_DSname_TableName_PrimaryKeyColumnName |
Obtenir les attributs sélectionnés pour un client | {serviceRoot}/msdynci_customerprofiles?$select=msdynci_fullname&$filter=msdynci_customerid eq '{CID}' |
|
Obtenir des clients par ID (interne) | {serviceRoot}/msdynci_customerprofiles?$filter=msdynci_customerid eq '{CID1}' or msdynci_customerid eq '{CID2}' |
|
Obtenir des clients par clés secondaires (interne) | {serviceRoot}/msdynci_customerprofiles?$filter={msdynci_alternate_column} eq '{AK1}' or {msdynci_alternate_column} eq '{AK2}' |
|
Rechercher des clients | {serviceRoot}/msdynci_customerprofiles?$filter=contains(msdynci_lastname,'string')&$top=10 |
|
Obtenir tous les clients membres d’un segment | {serviceRoot}/msdynci_segmentmemberships?$filter=contains(msdynci_segments,'\"{SegmentName}\"')&$select=msdynci_customerid |
|
Obtenir un client s’il est membre d’un segment | {serviceRoot}/msdynci_segmentmemberships?$filter=contains(msdynci_segments,'\"{SegmentName}\"') and msdynci_customerid eq '{CID}'&$select=msdynci_customerid |
|
Obtenir tous les membres du segment d’un client | {serviceRoot}/msdynci_segmentmemberships?$filter=msdynci_customerid eq '{CID}'&$select=msdynci_segments |
Personnalisation web
Exemples de requêtes pour personnaliser votre site Web en fonction du CookieId. La réponse renvoie à la fois des clients connus et inconnus.
Type de requête | Exemple | Note |
---|---|---|
Obtenir un client par CookieId | {serviceRoot}/msdynci_personalizationprofiles(cookieid='{cookieId}') |
|
Obtenir un client par CookieId et inclure des segments, des mesures et des activités | {serviceRoot}/msdynci_personalizationprofiles(cookieid='{cookieId}',include=['segmentmembership','measures','unifiedactivity']) |
|
Obtenir les dernières pages vues (10 récentes) d’un client par CookieId | {serviceRoot}/msdynci_pageviews(cookieid='{cookieId}',top=10) |
Cela peut être modifié pour renvoyer jusqu’à 200 pages vues récentes |
Obtenir les derniers clics de page (10 récents) d’un client par CookieId | {serviceRoot}/msdynci_pageclicks(cookieid='{cookieId}',top=10) |
Cela peut être modifié pour renvoyer jusqu’à 200 clics de page récents |
Activité unifiée
Exemples de requêtes pour la table UnifiedActivity.
Type de requête | Exemple | Note |
---|---|---|
Obtenir toutes les activités d’un client | {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' |
|
Obtenir toutes les activités d’un client dans une période de temps | {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytime gt 2017-01-01T00:00:00Z and msdynci_activitytime lt 2017-01-01T00:00:00Z |
|
Obtenir toutes les activités de type activityType d’un client | {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytype eq '{ActivityType}' |
|
Obtenir toutes les activités de type activityDisplayName d’un client | {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}' and msdynci_activitytypedisplay eq '{ActivityDisplayName}' |
|
Obtenir toutes les activités d’un client et les trier | {serviceRoot}/msdynci_unifiedactivities?$filter=msdynci_customerid eq '{CID}'&$orderby=msdynci_activitytime asc |
Autres exemples
Exemples de requêtes pour d’autres tables.
Type de requête | Exemple | Note |
---|---|---|
Obtenir toutes les mesures d’un client | {serviceRoot}/msdynci_customermeasures?$filter=msdynci_customerid eq '{CID}' |
|
Obtenir des marques enrichies d’un client | {serviceRoot}/msdynci_enrichments?$filter=msdynci_customerid eq '{CID}' and msdynci_enrichmentprovider eq 'BrandShareOfVoiceFromMicrosoft' |
|
Obtenir des intérêts enrichis d’un client | {serviceRoot}/msdynci_enrichments?$filter=msdynci_customerid eq '{CID}' and msdynci_enrichmentprovider eq 'InterestShareOfVoiceFromMicrosoft' |
|
Obtenir les résultats du modèle IA d’un client | {serviceRoot}/msdynci_predictions?$filter=msdynci_customerid eq '{CID}' and msdynci_modelprovider eq 'ChurnModel' |
Étapes suivantes
La plupart des tables Customer Insights - Data sont disponibles dans Dataverse. Pour plus d’informations, voir Tables dans Dataverse.
Dataverse offre un support étendu pour tester leurs API, par exemple via Insomnia. Pour plus d’informations, consultez Utiliser Insomnia avec Dataverse l’API Web.
Pour en savoir plus sur les limites du service d’API Dataverse, voir Vue d’ensemble des limites d’API Microsoft Dataverse.
Pour en savoir plus sur la manière d’utiliser les API Dataverse, voir Interroger les données avec l’API web.