Previsualizar extremo de estado de muestra (vista previa del perfil)
Adobe Experience Platform le permite introducir datos de clientes de varias fuentes para crear un perfil sólido y unificado para cada uno de sus clientes individuales. A medida que los datos se incorporan a Experience Platform, se ejecuta un trabajo de ejemplo para actualizar el recuento de perfiles y otras métricas relacionadas con los datos del perfil del cliente en tiempo real.
Los resultados de este trabajo de ejemplo se pueden ver mediante el extremo /previewsamplestatus, parte de la API del perfil del cliente en tiempo real. Este extremo también se puede utilizar para enumerar distribuciones de perfil por conjunto de datos y área de nombres de identidad, así como para generar varios informes con el fin de obtener visibilidad sobre la composición del almacén de perfiles de su organización. Esta guía muestra los pasos necesarios para ver estas métricas mediante el extremo de API /previewsamplestatus.
Introducción
El extremo de API utilizado en esta guía forma parte de la Real-Time Customer Profile API. Antes de continuar, revisa la guía de introducción para ver vínculos a documentación relacionada, una guía para leer las llamadas de API de ejemplo en este documento e información importante sobre los encabezados necesarios para realizar correctamente llamadas a cualquier API de Experience Platform.
Fragmentos de perfil frente a perfiles combinados
Esta guía hace referencia a "fragmentos de perfil" y a "perfiles combinados". Es importante comprender la diferencia entre estos términos antes de continuar.
Cada perfil de cliente individual está compuesto por varios fragmentos de perfil que se han combinado para formar una sola vista de ese cliente. Por ejemplo, si un cliente interactúa con su marca en varios canales, es probable que su organización tenga varios fragmentos de perfil relacionados con ese único cliente que aparecen en varios conjuntos de datos.
Cuando los fragmentos de perfil se incorporan en Experience Platform, se combinan (según una política de combinación) para crear un único perfil para ese cliente. Por lo tanto, es probable que el número total de fragmentos de perfil siempre sea mayor que el número total de perfiles combinados, ya que cada perfil está compuesto por varios fragmentos.
Para obtener más información sobre los perfiles y su función en Experience Platform, comience por leer la descripción general del perfil del cliente en tiempo real.
Activación del trabajo de muestra
A medida que los datos habilitados para el perfil del cliente en tiempo real se incorporan en Experience Platform, se almacenan dentro del almacén de datos del perfil. Cuando la ingesta de registros en el almacén de perfiles aumenta o disminuye el recuento total de perfiles en más del 3 %, se activa un trabajo de muestreo para actualizar el recuento. La forma en que se activa la muestra depende del tipo de ingesta que se utilice:
- Para flujos de trabajo de datos de streaming, se realiza una comprobación cada hora para determinar si se ha alcanzado el umbral de aumento o disminución del 3 %. Si es así, se activa automáticamente un trabajo de muestra para actualizar el recuento.
- Para la ingesta por lotes, en los 15 minutos siguientes a la ingesta correcta de un lote en el almacén de perfiles, si se alcanza el umbral de aumento o disminución del 3 %, se ejecuta un trabajo para actualizar el recuento. Con la API de perfil puede obtener una vista previa del último trabajo de ejemplo correcto, así como una distribución de perfiles de lista por conjunto de datos y por área de nombres de identidad.
El recuento de perfiles y los perfiles por métricas de área de nombres también están disponibles en la sección Profiles de la interfaz de usuario de Experience Platform. Para obtener información sobre cómo obtener acceso a los datos del perfil mediante la interfaz de usuario, visite la Profile guía de la interfaz de usuario.
Ver el último estado de muestra view-last-sample-status
Puede ver los detalles del último trabajo de ejemplo correcto que se ejecutó para su organización realizando una petición GET al extremo /previewsamplestatus. Este informe incluye el número total de perfiles de la muestra, así como la métrica de recuento de perfiles o el número total de perfiles que su organización tiene en Experience Platform.
El recuento de perfiles se genera después de combinar fragmentos de perfil para formar un único perfil para cada cliente individual. En otras palabras, cuando los fragmentos de perfil se combinan, devuelven un recuento de "1" perfiles porque todos están relacionados con el mismo individuo.
El recuento de perfiles también incluye perfiles con atributos (datos de registro), así como perfiles que solo contienen datos de series temporales (eventos), como perfiles de Adobe Analytics. El trabajo de ejemplo se actualiza regularmente a medida que se incorporan los datos del perfil para proporcionar un número total actualizado de perfiles dentro de Experience Platform.
Formato de API
GET /previewsamplestatus
Solicitud
| code language-shell |
|---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 e incluye los detalles del último trabajo de muestra correcto que se ejecutó para la organización.
| note note |
|---|
| NOTE |
En esta respuesta de ejemplo, numRowsToRead y totalRows son iguales entre sí. Según el número de perfiles que tenga su organización en Experience Platform, este puede ser el caso. Sin embargo, generalmente estos dos números son diferentes, siendo numRowsToRead el número más pequeño porque representa la muestra como un subconjunto del número total de perfiles (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 | |
|---|---|
| Propiedad | Descripción |
numRowsToRead |
Número total de perfiles combinados en la muestra. |
sampleJobRunning |
Un valor booleano que devuelve true cuando un trabajo de muestra está en curso. Proporciona transparencia sobre la latencia que se produce cuando se carga un archivo por lotes en, cuando se agrega realmente al almacén de perfiles. |
docCount |
Recuento total de documentos en la base de datos. |
totalFragmentCount |
Número total de fragmentos de perfil en el almacén de perfiles. |
lastSuccessfulBatchTimestamp |
Marca de tiempo de la última ingesta correcta por lotes. |
streamingDriven |
Este campo ha quedado obsoleto y no contiene ningún significado para la respuesta. |
totalRows |
Número total de perfiles combinados en Experience Platform, también conocidos como recuento de perfiles. |
lastBatchId |
ID de la última ingesta por lotes. |
status |
Estado de la última muestra. |
samplingRatio |
Proporción de perfiles combinados muestreados (numRowsToRead) respecto al total de perfiles combinados (totalRows), expresada como porcentaje en formato decimal. |
mergeStrategy |
Estrategia de combinación utilizada en el ejemplo. |
lastSampledTimestamp |
Última marca de tiempo de muestra correcta. |
Enumerar la distribución de perfiles por conjunto de datos
Puede ver la distribución de perfiles por conjunto de datos realizando una petición GET al extremo /previewsamplestatus/report/dataset.
Formato de API
GET /previewsamplestatus/report/dataset
GET /previewsamplestatus/report/dataset?{QUERY_PARAMETERS}
datedate=2024-12-31Solicitud
La siguiente solicitud usa el parámetro date para devolver el informe más reciente para la fecha especificada.
| code language-shell |
|---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 e incluye una matriz data, que contiene una lista de objetos de conjunto de datos.
| note note |
|---|
| NOTE |
| La siguiente respuesta mostrada se ha truncado para mostrar tres conjuntos de datos. |
| 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 | |
|---|---|
| Propiedad | Descripción |
sampleCount |
Número total de perfiles combinados muestreados con este ID de conjunto de datos. |
samplePercentage |
sampleCount como porcentaje del número total de perfiles combinados muestreados (el valor numRowsToRead devuelto en el último estado de muestra), expresado en formato decimal. |
fullIDsCount |
Número total de perfiles combinados con este ID de conjunto de datos. |
fullIDsPercentage |
fullIDsCount como porcentaje del número total de perfiles combinados (el valor totalRows devuelto en el último estado de muestra), expresado en formato decimal. |
name |
El nombre del conjunto de datos, tal como se proporciona durante la creación del conjunto de datos. |
description |
La descripción del conjunto de datos, tal como se proporciona durante la creación del conjunto de datos. |
value |
El ID del conjunto de datos. |
streamingIngestionEnabled |
Si el conjunto de datos está habilitado para la ingesta de transmisión. |
createdUser |
El ID del usuario que creó el conjunto de datos. |
reportTimestamp |
La marca de tiempo del informe. Si se proporcionó un parámetro date durante la solicitud, el informe devuelto es para la fecha proporcionada. Si no se proporciona ningún parámetro date, se devuelve el informe más reciente. |
Enumerar la distribución de perfiles por área de nombres de identidad
Puede realizar una petición GET al extremo /previewsamplestatus/report/namespace para ver el desglose por área de nombres de identidad en todos los perfiles combinados del almacén de perfiles. Esto incluye tanto las identidades estándar proporcionadas por Adobe como las identidades personalizadas definidas por su organización.
Las áreas de nombres de identidad son un componente importante de Adobe Experience Platform Identity Service, y sirven de indicadores del contexto al que se relacionan los datos de los clientes. Para obtener más información, comience por leer la descripción general del área de nombres de identidad.
Formato de API
GET /previewsamplestatus/report/namespace
GET /previewsamplestatus/report/namespace?{QUERY_PARAMETERS}
dateYYYY-MM-DD.date=2025-6-20Solicitud
La siguiente solicitud no especifica un parámetro date y devolverá el informe más reciente.
| code language-shell |
|---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 e incluye una matriz data, con objetos individuales que contienen los detalles de cada área de nombres. La respuesta mostrada se ha truncado para mostrar cuatro áreas de nombres.
| 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 | |
|---|---|
| Propiedad | Descripción |
sampleCount |
Número total de perfiles combinados muestreados en el área de nombres. |
samplePercentage |
sampleCount como porcentaje de perfiles combinados muestreados (el valor numRowsToRead devuelto en el último estado de muestra), expresado en formato decimal. |
reportTimestamp |
La marca de tiempo del informe. Si se proporcionó un parámetro date durante la solicitud, el informe devuelto es para la fecha proporcionada. Si no se proporciona ningún parámetro date, se devuelve el informe más reciente. |
fullIDsFragmentCount |
Número total de fragmentos de perfil en el área de nombres. |
fullIDsCount |
Número total de perfiles combinados en el área de nombres. |
fullIDsPercentage |
fullIDsCount como porcentaje del total de perfiles combinados (el valor totalRows devuelto en el último estado de muestra), expresado en formato decimal. |
code |
El code del área de nombres. Esto se encuentra al trabajar con áreas de nombres mediante la API del servicio de identidad de Adobe Experience Platform, y también se denomina Identity symbol en la interfaz de usuario de Experience Platform. Para obtener más información, visite la descripción general del área de nombres de identidad. |
value |
El valor id del área de nombres. Esto se puede encontrar al trabajar con áreas de nombres usando la API del servicio de identidad. |
Enumeración de las estadísticas del conjunto de datos dataset-stats
Puede generar un informe que proporcione estadísticas sobre el conjunto de datos realizando una petición GET al extremo /previewsamplestatus/report/dataset_stats.
Formato de API
GET /previewsamplestatus/report/dataset_stats
Solicitud
| code language-shell |
|---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con información sobre las estadísticas del conjunto de datos.
| note note |
|---|
| NOTE |
| La siguiente respuesta se ha truncado para mostrar tres conjuntos de datos. |
| 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 | |
|---|---|
| Propiedad | Descripción |
120days |
El número de registros que permanecerán en el conjunto de datos después de una caducidad de datos de 120 días. |
14days |
El número de registros que permanecerán en el conjunto de datos después de una caducidad de datos de 14 días. |
30days |
El número de registros que permanecerán en el conjunto de datos después de una caducidad de datos de 30 días. |
365days |
El número de registros que permanecerán en el conjunto de datos después de una caducidad de datos de 365 días. |
60days |
El número de registros que permanecerán en el conjunto de datos después de una caducidad de datos de 60 días. |
7days |
El número de registros que permanecerán en el conjunto de datos después de una caducidad de datos de 7 días. |
90days |
El número de registros que permanecerán en el conjunto de datos después de una caducidad de datos de 90 días. |
datasetId |
El ID del conjunto de datos. |
datasetType |
El tipo de conjunto de datos. Este valor puede ser Profiles o ExperienceEvents. |
percentEvents |
El porcentaje de registros de eventos de experiencia que se encuentran dentro del conjunto de datos. |
percentProfiles |
El porcentaje de registros de perfil que están dentro del conjunto de datos. |
profileFragments |
Número total de fragmentos de perfil que existen en el conjunto de datos. |
records |
Número total de registros de perfil introducidos en el conjunto de datos. |
totalProfiles |
Número total de perfiles introducidos en el conjunto de datos. |
Obtener el tamaño del conjunto de datos character-count
Puede utilizar este extremo para obtener el tamaño del conjunto de datos en bytes semana a semana.
Formato de API
GET /previewsamplestatus/report/character_count
Solicitud
| code language-shell |
|---|
|
Respuesta
Una respuesta correcta devuelve el estado HTTP 200 con información sobre el tamaño del conjunto de datos a lo largo de las semanas.
| note note |
|---|
| NOTE |
| La siguiente respuesta se ha truncado para mostrar tres conjuntos de datos. |
| code language-json |
|---|
|
| table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 | |
|---|---|
| Propiedad | Descripción |
datasetId |
El ID del conjunto de datos. |
recordType |
El tipo de datos dentro del conjunto de datos. El tipo de registro afecta al valor de la variable weeks. Los valores admitidos son keyvalue y timeseries. |
weeks |
Matriz que contiene la información de tamaño sobre el conjunto de datos. Para conjuntos de datos del tipo de registro keyvalue, contiene la semana más reciente, así como el tamaño total del conjunto de datos en bytes. Para conjuntos de datos del tipo de registro timeseries, contiene cada semana desde la ingesta del conjunto de datos hasta la semana más reciente y el tamaño total del conjunto de datos en bytes para cada una de esas semanas. |
modelName |
Nombre del modelo del conjunto de datos. Los valores posibles incluyen _xdm.context.profile y _xdm.context.experienceevent. |
reportTimestamp |
La fecha y la hora en que se generó el informe. |
Próximos pasos
Ahora que sabe cómo obtener una vista previa de los datos de ejemplo en el almacén de perfiles y ejecutar varios informes sobre los datos, también puede utilizar los extremos de estimación y vista previa de la API del servicio de segmentación para ver información de resumen sobre sus definiciones de segmento. Esta información le ayuda a aislar la audiencia esperada. Para obtener más información sobre cómo trabajar con vistas previas y estimaciones mediante la API de segmentación, visita la guía de vista previa y estimación de extremos.