Voorbeelden van OData-query's

Opmerking

Customer Insights - Gegevens-tabellen zijn ook toegankelijk via Dataverse-API's. We raden u aan Dataverse-API's te gebruiken om Customer Insights-gegevens op te vragen, omdat deze uitgebreidere filters, een grotere doorvoer en een lagere latentie bieden. Zie Dataverse-API's voor Customer Insights voor meer informatie.

Het Open Data Protocol (OData) is een gegevenstoegangsprotocol dat is gebaseerd op kernprotocollen zoals HTTP. Het maakt gebruik van algemeen aanvaarde methodologieën zoals REST voor het web. Je kunt verschillende soorten bibliotheken en tools gebruiken om OData-diensten te gebruiken.

Om u te helpen bij het bouwen van uw eigen implementaties op basis van de Dynamics 365 Customer Insights - Data-API's bekijkt u enkele veelgevraagde voorbeeldquery's.

Wijzig de queryvoorbeelden om ze te laten werken in de doelomgevingen:

  • {serviceRoot} https://api.ci.ai.dynamics.com/v1/instances/{instanceId}: waar {instanceId} is de GUID van de omgeving Customer Insights - Gegevens die je wilt opzoeken? De ListAllInstances-operatie helpt je de {InstanceId} functies te vinden waar je toegang toe hebt.
  • {CID}: GUID van een uniforme klantregistratie. Voorbeeld: ce759201f786d590bf2134bff576c369.
  • {AlternateKey}: Identificatie van de primaire sleutel van een klantrecord in een databron. Voorbeeld: CNTID_1002.
  • {DSname}: String met de tabelnaam van een databron die wordt opgenomen in Customer Insights - Gegevens. Voorbeeld: Website_contacts.
  • {SegmentName}: String met de naam van de output table van een segment in Customer Insights - Gegevens. Voorbeeld: Male_under_40.

klant

Voorbeeldquery's voor de tabel Klant.

Querytype Voorbeeld Opmerking
Eén klant-id {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}' 
Alternatieve sleutel {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} eq '{AlternateKey}' Alternatieve sleutels blijven bestaan in de geharmoniseerde klantentabel
Select {serviceRoot}/data/Customer?$select=CustomerId,FullName&$filter=customerid eq '1'
Over {serviceRoot}/data/Customer?$filter=CustomerId in ('{CID1}',’{CID2}’)
Alternatieve sleutel + In {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} in ('{AlternateKey}','{AlternateKey}')
Zoeken {serviceRoot}/data/Customer?$top=10&$skip=0&$search="string" Retourneert top 10 resultaten voor een zoekreeks
Segmentlidmaatschap {serviceRoot}/data/Customer?select=*&$filter=IsMemberOfSegment('{SegmentName}')&$top=10 Retourneert een vooraf ingesteld aantal rijen van de segmentatietabel.
Segmentlidmaatschap voor een klant {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}'&IsMemberOfSegment('{SegmentName}') Retourneert het klantprofiel als ze lid zijn van het opgegeven segment

Geharmoniseerde activiteit

Voorbeeldquery's voor de tabel UnifiedActivity.

Querytype Voorbeeld Opmerking
Activiteit van cid {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}'  Geeft activiteiten van een specifiek klantprofiel weer
Tijdsbestek van activiteit {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityTime gt 2017-01-01T00:00:00.000Z and ActivityTime lt 2020-01-01T00:00:00.000Z Activiteiten van een klantprofiel binnen een tijdsbestek
Type activiteit {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityType eq '{ActivityName}'
Activiteit per weergavenaam {serviceRoot}/data/UnifiedActivity$filter=CustomerId eq ‘{CID}’ and ActivityTypeDisplay eq ‘{ActivityDisplayName}’
Activiteiten sorteren {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq ‘{CID}’ & $orderby=ActivityTime asc In oplopende of aflopende volgorde activiteiten sorteren
Alle werkzaamheden en metingen voor een klant {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId eq '{CID}' Activiteiten en metingen zijn aanvullende sleutel/waarde-paren op het geretourneerde klantprofiel

Werkstromen beheren

Voorbeeldquery's met betrekking tot processen in Customer Insights - Gegevens, zoals het vernieuwen van een gegevensbron, het harmoniseren van gegevens of het ophalen van de status van een harmonisatietaak.

Querytype Voorbeeld Opmerking
Gegevensbron-id's ophalen {serviceRoot}/manage/datasources/v2 Hiermee worden alle gegevensbronnen in uw omgeving geretourneerd. Uit de reactie kun je de friendlyName controleren op een specifieke databron en vervolgens zijn dataSourceId.
Een gegevensbron vernieuwen {serviceRoot}/manage/workflows/main/jobs?operationType=Ingestion&identifiers='{dataSourceId}'&forceRunRequested=true Gebruik de dataSourceId bovenstaande reactie om een databron te verversen. Dit verzoek maakt gebruik van de POST-methode.
Volledig vernieuwen uitvoeren {serviceRoot}/manage/workflows/main/jobs?operationType=all&forceRunRequested=true Hiermee worden alle processen in uw omgeving vernieuwd. Dit verzoek maakt gebruik van de POST-methode.
De status van processen ophalen {serviceRoot}/manage/workflows/main/jobs

Andere voorbeelden

Voorbeeldquery's voor andere tabellen.

Querytype Voorbeeld Opmerking
Metingen van cid {serviceRoot}/data/Customer_Measure?$filter=CustomerId eq '{CID}'
Verrijkte merken van cid {serviceRoot}/data/BrandShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}'
Verrijkte interesses van cid {serviceRoot}/data/InterestShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}'
In-component + uitbreiden {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId in ('{CID}', '{CID}')

Beperkingen

  • Customer Insights API retourneert standaard maximaal 100 objecten. U kunt meer dan de 100 geretourneerde objecten parseren met behulp van standaard pagineringstechnieken. U kunt ook uw gegevens exporteren.

  • De volgende query's worden niet ondersteund:

    • $filter in opgenomen brontabellen. U kunt alleen $filter-query's uitvoeren op systeemtabellen die door Customer Insights - Gegevens worden gemaakt.
    • $expand bij een $search-query. Voorbeeld: Customer?$expand=UnifiedActivity$top=10&$skip=0&$search="corey".
    • $expand bij $select als alleen een subset van kenmerken is geselecteerd. Voorbeeld: Customer?$select=CustomerId,FullName&$expand=UnifiedActivity&$filter=CustomerId eq '{CID}'.
    • Met $expand verrijkte merk- of interesseaffiniteiten voor een bepaalde klant. Voorbeeld: Customer?$expand=BrandShareOfVoiceFromMicrosoft&$filter=CustomerId eq '518291faaa12f6d853c417835d40eb10'.
    • Uitvoertabellen voor queryvoorspellingsmodel via alternatieve sleutel. Voorbeeld: OOBModelOutputTable?$filter=HotelCustomerID eq '{AK}'.
  • Last updated on