Eksempler på OData-spørring

Merk

Du kan også få tilgang til Customer Insights - Data-tabeller ved hjelp av Dataverse-API-er. Vi anbefaler at du bruker Dataverse-API-er til å spørre etter Customer Insights-data fordi de tilbyr mer omfattende filtrering, større gjennomstrømning og lavere ventetid. Hvis du vil ha mer informasjon, kan du se Dataverse-API-er for Customer Insights.

OData (Open Data Protocol) er en datatilgangsprotokoll som er bygd på kjerneprotokoller som HTTP. Den bruker allment aksepterte metoder som REST for Internett. Du kan bruke ulike typer biblioteker og verktøy for å bruke OData-tjenester.

Se gjennom noen ofte etterspurte eksempelspørringer som kan hjelpe deg å bygge dine egne implementeringer basert på API-ene for Dynamics 365 Customer Insights - Data.

Endre spørringseksemplene slik at de fungerer i målmiljøene:

  • {serviceRoot} https://api.ci.ai.dynamics.com/v1/instances/{instanceId}: hvor {instanceId} er GUID-en til Customer Insights - Data-miljøet du ønsker å søke i. ListAllInstances-operasjonen hjelper deg å finne de {InstanceId} du har tilgang til.
  • {CID}: GUID for en samlet kunderegister. Eksempel: ce759201f786d590bf2134bff576c369.
  • {AlternateKey}: Identifikator for primærnøkkelen til en kundepost i en datakilde. Eksempel: CNTID_1002.
  • {DSname}: Streng med tabellnavnet til en datakilde som importeres til Customer Insights - Data. Eksempel: Website_contacts.
  • {SegmentName}: Streng med navnet på utdatatabellen til et segment i Customer Insights - Data. Eksempel: Male_under_40.

Kunde

Eksempelspørringer for Kunde-tabellen.

Spørringstype Eksempel Merk
Enkelt kunde-ID {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}' 
Alternativ nøkkel {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} eq '{AlternateKey}' Alternative nøkler beholdes i tabellen for enhetlige kunder
Select {serviceRoot}/data/Customer?$select=CustomerId,FullName&$filter=customerid eq '1'
om {serviceRoot}/data/Customer?$filter=CustomerId in ('{CID1}',’{CID2}’)
Alternativ nøkkel + In {serviceRoot}/data/Customer?$filter={DSname_TableName_PrimaryKeyColumnName} in ('{AlternateKey}','{AlternateKey}')
Search {serviceRoot}/data/Customer?$top=10&$skip=0&$search="string" Returnerer de ti beste resultatene for en søkestreng
Segmentmedlemskap {serviceRoot}/data/Customer?select=*&$filter=IsMemberOfSegment('{SegmentName}')&$top=10 Returnerer et antall rader for serienummer fra segmenteringstabellen.
Segmentmedlemskap for en kunde {serviceRoot}/data/Customer?$filter=CustomerId eq '{CID}'&IsMemberOfSegment('{SegmentName}') Returnerer kundeprofilen hvis de er medlem i gitt segment

Enhetlig aktivitet

Eksempelspørringer for UnifiedActivity-tabellen:

Spørringstype Eksempel Merk
Aktivitet for CID {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}'  Viser aktiviteter for en bestemt kundeprofil
Aktivitetstidsramme {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 Aktiviteter for en kundeprofil i en tidsramme
Aktivitetstype {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq '{CID}' and ActivityType eq '{ActivityName}'
Aktivitet etter visningsnavn {serviceRoot}/data/UnifiedActivity$filter=CustomerId eq ‘{CID}’ and ActivityTypeDisplay eq ‘{ActivityDisplayName}’
Aktivitetssortering {serviceRoot}/data/UnifiedActivity?$filter=CustomerId eq ‘{CID}’ & $orderby=ActivityTime asc Sorter aktiviteter stigende eller synkende
Alle aktiviteter og mål for en kunde {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId eq '{CID}' Aktiviteter og mål er flere nøkkel-/verdipar i den returnerte kundeprofilen

Behandle arbeidsflyter

Eksempelspørringer relatert til prosesser i Customer Insights - Data for eksempel oppdatering av en datakilde, forening av data eller å få status for en foreningsjobb.

Spørringstype Eksempel Merk
Hent ID-er for datakilder {serviceRoot}/manage/datasources/v2 Returnerer alle datakilder i miljøet. Ut fra svaret kan du sjekke for friendlyName en spesifikk datakilde og deretter bruke dens dataSourceId.
Oppdatere en datakilde {serviceRoot}/manage/workflows/main/jobs?operationType=Ingestion&identifiers='{dataSourceId}'&forceRunRequested=true Bruk svaret dataSourceId fra forrige for å oppdatere en datakilde. Denne forespørselen bruker POST-metoden.
Kjør en fullstendig oppdatering {serviceRoot}/manage/workflows/main/jobs?operationType=all&forceRunRequested=true Oppdaterer alle prosesser i miljøet. Denne forespørselen bruker POST-metoden.
Hent status for prosesser {serviceRoot}/manage/workflows/main/jobs

Andre eksempler

Eksempelspørringer for andre tabeller.

Spørringstype Eksempel Merk
Mål for CID {serviceRoot}/data/Customer_Measure?$filter=CustomerId eq '{CID}'
Supplerte merker for CID {serviceRoot}/data/BrandShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}'
Supplerte interesser for CID {serviceRoot}/data/InterestShareOfVoiceFromMicrosoft?$filter=CustomerId eq '{CID}'
In-Clause + utvid {serviceRoot}/data/Customer?$expand=UnifiedActivity,Customer_Measure&$filter=CustomerId in ('{CID}', '{CID}')

Begrensninger

  • API for Customer Insights returnerer maksimalt 100 objekter som standard. Du kan analysere flere enn de 100 returnerte objektene ved hjelp av standard pagineringsteknikker. Du kan også eksportere dataene.

  • Følgende spørringer støttes ikke:

    • $filter på inntatte kildetabeller. Du kan bare kjøre $filter-spørringer på systemtabeller som Customer Insights - Data oppretter.
    • $expand fra en $search-spørring. Eksempel: Customer?$expand=UnifiedActivity$top=10&$skip=0&$search="corey".
    • $expand fra $select hvis bare et delsett av attributter er valgt. Eksempel: Customer?$select=CustomerId,FullName&$expand=UnifiedActivity&$filter=CustomerId eq '{CID}'.
    • $expand-supplerte varemerker eller interessetilknytninger for en gitt kunde. Eksempel: Customer?$expand=BrandShareOfVoiceFromMicrosoft&$filter=CustomerId eq '518291faaa12f6d853c417835d40eb10'.
    • Spørring av utdatatabeller for prediksjonsmodell gjennom alternativ nøkkel. Eksempel: OOBModelOutputTable?$filter=HotelCustomerID eq '{AK}'.