Endpoint dello stato del campione di anteprima (anteprima profilo)
Adobe Experience Platform consente di acquisire i dati dei clienti da più origini per creare un profilo solido e unificato per ciascuno dei singoli clienti. Quando i dati vengono acquisiti in Experience Platform, viene eseguito un processo di esempio per aggiornare il conteggio dei profili e altre metriche relative ai dati del profilo cliente in tempo reale.
I risultati di questo processo di esempio possono essere visualizzati utilizzando l'endpoint /previewsamplestatus, parte dell'API Real-Time Customer Profile. Questo endpoint può essere utilizzato anche per elencare le distribuzioni di profilo per set di dati e spazio dei nomi delle identità, nonché per generare più rapporti al fine di ottenere visibilità nella composizione dell’archivio profili della tua organizzazione. Questa guida descrive i passaggi necessari per visualizzare queste metriche utilizzando l'endpoint API /previewsamplestatus.
Introduzione
L'endpoint API utilizzato in questa guida fa parte dell'Real-Time Customer Profile API. Prima di continuare, consulta la guida introduttiva per i collegamenti alla documentazione correlata, una guida alla lettura delle chiamate API di esempio in questo documento e informazioni importanti sulle intestazioni necessarie per effettuare correttamente le chiamate a qualsiasi API Experience Platform.
Frammenti di profilo e profili uniti
Questa guida fa riferimento sia a "frammenti di profilo" che a "profili uniti". È importante comprendere la differenza tra questi termini prima di procedere.
Ogni singolo profilo cliente è composto da più frammenti di profilo che sono stati uniti per formare un’unica vista di quel cliente. Ad esempio, se un cliente interagisce con il tuo marchio su più canali, è probabile che la tua organizzazione disponga di più frammenti di profilo relativi a quel singolo cliente che compaiono in più set di dati.
Quando i frammenti di profilo vengono acquisiti in Experience Platform, vengono uniti insieme (in base a un criterio di unione) per creare un singolo profilo per quel cliente. Pertanto, è probabile che il numero totale di frammenti di profilo sia sempre superiore al numero totale di profili uniti, in quanto ogni profilo è composto da più frammenti.
Per ulteriori informazioni sui profili e sul loro ruolo in Experience Platform, consulta la Panoramica sul profilo cliente in tempo reale.
Modalità di attivazione del processo di esempio
Poiché i dati abilitati per Real-Time Customer Profile vengono acquisiti in Experience Platform, vengono memorizzati nell'archivio dati del profilo. Quando l’acquisizione dei record nell’archivio profili aumenta o diminuisce il conteggio totale dei profili di oltre il 3%, viene attivato un processo di campionamento per aggiornare il conteggio. Il modo in cui il campione viene attivato dipende dal tipo di acquisizione utilizzata:
- Per flussi di lavoro di dati in streaming, viene eseguito un controllo su base oraria per determinare se la soglia di aumento o di diminuzione del 3% è stata raggiunta. In caso affermativo, viene attivato automaticamente un processo di esempio per aggiornare il conteggio.
- Per l'acquisizione batch, entro 15 minuti dalla corretta acquisizione di un batch nell'archivio profili, se viene raggiunta la soglia di aumento o riduzione del 3%, viene eseguito un processo per aggiornare il conteggio. Utilizzando l’API di profilo è possibile visualizzare in anteprima l’ultimo processo di esempio riuscito, nonché elencare la distribuzione del profilo per set di dati e per spazio dei nomi dell’identità.
Il conteggio dei profili e i profili per metrica dello spazio dei nomi sono disponibili anche nella sezione Profiles dell’interfaccia utente di Experience Platform. Per informazioni su come accedere ai dati del profilo tramite l'interfaccia utente, visitare la Profile guida dell'interfaccia utente.
Visualizza ultimo stato del campione view-last-sample-status
Per visualizzare i dettagli dell'ultimo processo di esempio eseguito correttamente per l'organizzazione, eseguire una richiesta GET all'endpoint /previewsamplestatus. Questo rapporto include il numero totale di profili nel campione, nonché la metrica di conteggio dei profili o il numero totale di profili di cui dispone la tua organizzazione in Experience Platform.
Il conteggio dei profili viene generato dopo l’unione dei frammenti di profilo per formare un singolo profilo per ogni singolo cliente. In altre parole, quando i frammenti di profilo vengono uniti tra loro, viene restituito un conteggio di "1" profilo perché sono tutti correlati allo stesso individuo.
Il conteggio dei profili include anche profili con attributi (dati record) e profili contenenti solo dati di serie temporali (eventi), come i profili di Adobe Analytics. Il processo di esempio viene aggiornato regolarmente man mano che vengono acquisiti i dati del profilo, in modo da fornire un numero totale aggiornato di profili all’interno di Experience Platform.
Formato API
GET /previewsamplestatus
Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 e include i dettagli dell’ultimo processo di esempio eseguito correttamente per l’organizzazione.
| note note |
|---|
| NOTE |
In questo esempio di risposta, numRowsToRead e totalRows sono uguali tra loro. Questo può accadere in base al numero di profili di cui dispone la tua organizzazione in Experience Platform. Tuttavia, in genere questi due numeri sono diversi, con numRowsToRead che è il numero minore perché rappresenta il campione come sottoinsieme del numero totale di profili (totalRows). |
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 | |
|---|---|
| Proprietà | Descrizione |
numRowsToRead |
Numero totale di profili uniti nel campione. |
sampleJobRunning |
Valore booleano che restituisce true quando è in corso un processo di esempio. Fornisce trasparenza nella latenza che si verifica quando un file batch viene caricato in quando viene effettivamente aggiunto all’archivio profili. |
docCount |
Numero totale di documenti nel database. |
totalFragmentCount |
Numero totale di frammenti di profilo nell’archivio Profili. |
lastSuccessfulBatchTimestamp |
Timestamp dell’ultima acquisizione batch riuscita. |
streamingDriven |
Questo campo è stato dichiarato obsoleto e non contiene alcun significato per la risposta. |
totalRows |
Numero totale di profili uniti in Experience Platform, noto anche come conteggio dei profili. |
lastBatchId |
ID dell’ultima acquisizione batch. |
status |
Stato dell’ultimo campione. |
samplingRatio |
Rapporto tra i profili uniti campionati (numRowsToRead) e i profili uniti totali (totalRows), espresso come percentuale in formato decimale. |
mergeStrategy |
Strategia di unione utilizzata nell'esempio. |
lastSampledTimestamp |
Timestamp dell’ultimo esempio riuscito. |
Elenca distribuzione profilo per set di dati
Per visualizzare la distribuzione dei profili per set di dati, devi eseguire una richiesta GET all'endpoint /previewsamplestatus/report/dataset.
Formato API
GET /previewsamplestatus/report/dataset
GET /previewsamplestatus/report/dataset?{QUERY_PARAMETERS}
datedate=2024-12-31Richiesta
La richiesta seguente utilizza il parametro date per restituire il rapporto più recente per la data specificata.
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 e include un array data, contenente un elenco di oggetti set di dati.
| note note |
|---|
| NOTE |
| La seguente risposta è stata troncata per mostrare tre set di dati. |
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 | |
|---|---|
| Proprietà | Descrizione |
sampleCount |
Numero totale di profili uniti campionati con questo ID set di dati. |
samplePercentage |
sampleCount come percentuale del numero totale di profili uniti campionati (il valore numRowsToRead restituito nel ultimo stato campione), espresso in formato decimale. |
fullIDsCount |
Numero totale di profili uniti con questo ID set di dati. |
fullIDsPercentage |
fullIDsCount come percentuale del numero totale di profili uniti (il valore totalRows restituito nell'ultimo stato campione), espresso in formato decimale. |
name |
Nome del set di dati, fornito durante la creazione del set di dati. |
description |
Descrizione del set di dati, fornita durante la creazione del set di dati. |
value |
ID del set di dati. |
streamingIngestionEnabled |
Se il set di dati è abilitato per l’acquisizione in streaming. |
createdUser |
ID utente dell’utente che ha creato il set di dati. |
reportTimestamp |
Il timestamp del rapporto. Se durante la richiesta è stato fornito un parametro date, il rapporto restituito si riferisce alla data specificata. Se non viene fornito alcun parametro date, viene restituito il report più recente. |
Distribuzione del profilo di elenco per spazio dei nomi delle identità
È possibile eseguire una richiesta GET all'endpoint /previewsamplestatus/report/namespace per visualizzare la suddivisione per spazio dei nomi identità in tutti i profili uniti nell'archivio profili. Sono incluse sia le identità standard fornite da Adobe, sia quelle personalizzate definite dalla tua organizzazione.
Gli spazi dei nomi di identità sono un componente importante del servizio Adobe Experience Platform Identity che fungono da indicatori del contesto a cui si riferiscono i dati dei clienti. Per ulteriori informazioni, leggere la panoramica dello spazio dei nomi delle identità.
Formato API
GET /previewsamplestatus/report/namespace
GET /previewsamplestatus/report/namespace?{QUERY_PARAMETERS}
dateYYYY-MM-DD.date=2025-6-20Richiesta
La richiesta seguente non specifica un parametro date e restituirà il report più recente.
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 e include un array data, con singoli oggetti contenenti i dettagli di ogni spazio dei nomi. La risposta mostrata è stata troncata per mostrare quattro spazi dei nomi.
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
|---|---|
| Proprietà | Descrizione |
sampleCount |
Numero totale di profili uniti campionati nello spazio dei nomi. |
samplePercentage |
sampleCount come percentuale dei profili uniti campionati (il valore numRowsToRead restituito nel ultimo stato campione), espresso in formato decimale. |
reportTimestamp |
Il timestamp del rapporto. Se durante la richiesta è stato fornito un parametro date, il rapporto restituito si riferisce alla data specificata. Se non viene fornito alcun parametro date, viene restituito il report più recente. |
fullIDsFragmentCount |
Numero totale di frammenti di profilo nello spazio dei nomi. |
fullIDsCount |
Numero totale di profili uniti nello spazio dei nomi. |
fullIDsPercentage |
Il fullIDsCount come percentuale del totale dei profili uniti (il valore totalRows restituito nel ultimo stato campione), espresso in formato decimale. |
code |
code per lo spazio dei nomi. Questo si può trovare quando si lavora con gli spazi dei nomi utilizzando l'API del servizio Adobe Experience Platform Identity ed è anche indicato come Identity symbol nell'interfaccia utente di Experience Platform. Per ulteriori informazioni, visita la panoramica dello spazio dei nomi delle identità. |
value |
Il valore id per lo spazio dei nomi. Questo problema si verifica quando si lavora con spazi dei nomi utilizzando l'API del servizio Identity. |
Elencare le statistiche del set di dati dataset-stats
È possibile generare un report che fornisca statistiche sul set di dati effettuando una richiesta GET all'endpoint /previewsamplestatus/report/dataset_stats.
Formato API
GET /previewsamplestatus/report/dataset_stats
Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con informazioni sulle statistiche del set di dati.
| note note |
|---|
| NOTE |
| La seguente risposta è stata troncata per mostrare tre set di dati. |
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 | |
|---|---|
| Proprietà | Descrizione |
120days |
Il numero di record che rimarranno nel set di dati dopo una scadenza di 120 giorni. |
14days |
Il numero di record che rimarranno nel set di dati dopo una scadenza di 14 giorni. |
30days |
Il numero di record che rimarranno nel set di dati dopo una scadenza di 30 giorni. |
365days |
Il numero di record che rimarranno nel set di dati dopo una scadenza dei dati di 365 giorni. |
60days |
Il numero di record che rimarranno nel set di dati dopo una scadenza dei dati di 60 giorni. |
7days |
Il numero di record che rimarranno nel set di dati dopo una scadenza di dati di 7 giorni. |
90days |
Il numero di record che rimarranno nel set di dati dopo una scadenza di 90 giorni. |
datasetId |
ID del set di dati. |
datasetType |
Il tipo di set di dati. Questo valore può essere Profiles o ExperienceEvents. |
percentEvents |
Percentuale di record Experience Events all’interno del set di dati. |
percentProfiles |
Percentuale di record Profilo all’interno del set di dati. |
profileFragments |
Numero totale di frammenti di profilo presenti nel set di dati. |
records |
Numero totale di record di profilo acquisiti nel set di dati. |
totalProfiles |
Numero totale di profili acquisiti nel set di dati. |
Ottieni la dimensione del set di dati character-count
Puoi utilizzare questo endpoint per ottenere la dimensione del set di dati in byte settimana per settimana.
Formato API
GET /previewsamplestatus/report/character_count
Richiesta
| code language-shell |
|---|
|
Risposta
In caso di esito positivo, la risposta restituisce lo stato HTTP 200 con informazioni sulle dimensioni del set di dati nel corso delle settimane.
| note note |
|---|
| NOTE |
| La seguente risposta è stata troncata per mostrare tre set di dati. |
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| Proprietà | Descrizione |
datasetId |
ID del set di dati. |
recordType |
Tipo di dati all’interno del set di dati. Il tipo di record influisce sul valore della variabile weeks. I valori supportati includono keyvalue e timeseries. |
weeks |
Matrice contenente le informazioni sulle dimensioni del set di dati. Per i set di dati di tipo record keyvalue, contiene la settimana più recente e le dimensioni totali del set di dati in byte. Per i set di dati di tipo record timeseries, contiene ogni settimana dall'acquisizione del set di dati alla settimana più recente e le dimensioni totali del set di dati in byte per ciascuna di tali settimane. |
modelName |
Nome del modello per il set di dati. I valori possibili includono _xdm.context.profile e _xdm.context.experienceevent. |
reportTimestamp |
La data e l’ora in cui è stato generato il rapporto. |
Passaggi successivi
Ora che sai come visualizzare in anteprima i dati di esempio nell’archivio Profili ed eseguire più rapporti sui dati, puoi anche utilizzare gli endpoint di stima e anteprima dell’API del servizio di segmentazione per visualizzare informazioni di riepilogo sulle definizioni dei segmenti. Queste informazioni sono utili per isolare il pubblico previsto. Per ulteriori informazioni sull'utilizzo delle anteprime e delle stime tramite l'API di segmentazione, consulta la guida dell'anteprima e degli endpoint di stima.