Point de terminaison des mesures
Les mesures d’observabilité fournissent des informations sur les statistiques d’utilisation, les tendances historiques et les indicateurs de performances de diverses fonctionnalités de Adobe Experience Platform. Le /metrics
du point de terminaison Observability Insights API vous permet de récupérer par programmation les données de mesure pour l’activité de votre entreprise dans Platform.
Prise en main
Le point d’entrée dʼAPI utilisé dans ce guide fait partie de lʼ Observability Insights API. Avant de continuer, consultez le guide de prise en main pour obtenir des liens vers la documentation associée, un guide de lecture des exemples dʼappels API dans ce document et des informations importantes sur les en-têtes requis pour réussir des appels à nʼimporte quel API dʼExperience Platform.
Récupération des mesures d’observabilité
Vous pouvez récupérer des données de mesure en envoyant une requête de POST à la variable /metrics
point de terminaison , en spécifiant les mesures que vous souhaitez récupérer dans la payload.
Format d’API
POST /metrics
Requête
curl -X POST \
https://platform.adobe.io/data/infrastructure/observability/insights/metrics \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '{
"start": "2020-07-14T00:00:00.000Z",
"end": "2020-07-22T00:00:00.000Z",
"granularity": "day",
"metrics": [
{
"name": "timeseries.ingestion.dataset.recordsuccess.count",
"filters": [
{
"name": "dataSetId",
"value": "5edcfb2fbb642119194c7d94|5eddb21420f516191b7a8dad",
"groupBy": true
}
],
"aggregator": "sum",
"downsample": "sum"
},
{
"name": "timeseries.ingestion.dataset.dailysize",
"filters": [
{
"name": "dataSetId",
"value": "5eddb21420f516191b7a8dad",
"groupBy": false
}
],
"aggregator": "sum",
"downsample": "sum"
}
]
}'
start
end
granularity
DAY
renvoie des mesures pour chaque jour entre la variable start
et end
date, alors qu’une valeur de MONTH
Regroupe plutôt les résultats des mesures par mois. Lors de l’utilisation de ce champ, une downsample
doit également être fournie pour indiquer la fonction d’agrégation par laquelle regrouper les données.metrics
name
filters
Champ facultatif qui vous permet de filtrer les mesures selon des jeux de données spécifiques. Le champ est un tableau d’objets (un pour chaque filtre), chaque objet contenant les propriétés suivantes :
name
: Type d’entité par rapport auquel filtrer les mesures. Actuellement, seuldataSets
est pris en charge.value
: L’identifiant d’un ou de plusieurs jeux de données. Plusieurs identifiants de jeu de données peuvent être fournis sous la forme d’une seule chaîne, chaque identifiant étant séparé par des caractères de barre verticale (|
).groupBy
: Lorsque la valeur est définie sur true, indique que la variablevalue
représente plusieurs jeux de données dont les résultats de mesure doivent être renvoyés séparément. S’il est défini sur false, les résultats des mesures de ces jeux de données sont regroupés.
aggregator
downsample
granularity
. Pour plus d’informations sur le sous-échantillonnage, reportez-vous à la section Documentation OpenTSDB.Réponse
Une réponse réussie renvoie les points de données résultants pour les mesures et les filtres spécifiés dans la requête.
{
"metricResponses": [
{
"metric": "timeseries.ingestion.dataset.recordsuccess.count",
"filters": [
{
"name": "dataSetId",
"value": "5edcfb2fbb642119194c7d94|5eddb21420f516191b7a8dad",
"groupBy": true
}
],
"datapoints": [
{
"groupBy": {
"dataSetId": "5edcfb2fbb642119194c7d94"
},
"dps": {
"2020-07-14T00:00:00Z": 44.0,
"2020-07-15T00:00:00Z": 46.0,
"2020-07-16T00:00:00Z": 36.0,
"2020-07-17T00:00:00Z": 50.0,
"2020-07-18T00:00:00Z": 38.0,
"2020-07-19T00:00:00Z": 40.0,
"2020-07-20T00:00:00Z": 42.0,
"2020-07-21T00:00:00Z": 42.0,
"2020-07-22T00:00:00Z": 50.0
}
},
{
"groupBy": {
"dataSetId": "5eddb21420f516191b7a8dad"
},
"dps": {
"2020-07-14T00:00:00Z": 44.0,
"2020-07-15T00:00:00Z": 46.0,
"2020-07-16T00:00:00Z": 36.0,
"2020-07-17T00:00:00Z": 50.0,
"2020-07-18T00:00:00Z": 38.0,
"2020-07-19T00:00:00Z": 40.0,
"2020-07-20T00:00:00Z": 42.0,
"2020-07-21T00:00:00Z": 42.0,
"2020-07-22T00:00:00Z": 50.0
}
}
],
"granularity": "DAY"
},
{
"metric": "timeseries.ingestion.dataset.dailysize",
"filters": [
{
"name": "dataSetId",
"value": "5eddb21420f516191b7a8dad",
"groupBy": false
}
],
"datapoints": [
{
"groupBy": {},
"dps": {
"2020-07-14T00:00:00Z": 38455.0,
"2020-07-15T00:00:00Z": 40213.0,
"2020-07-16T00:00:00Z": 31476.0,
"2020-07-17T00:00:00Z": 43705.0,
"2020-07-18T00:00:00Z": 33227.0,
"2020-07-19T00:00:00Z": 34977.0,
"2020-07-20T00:00:00Z": 36735.0,
"2020-07-21T00:00:00Z": 36737.0,
"2020-07-22T00:00:00Z": 43715.0
}
}
],
"granularity": "DAY"
}
]
}
metricResponses
metric
filters
datapoints
groupBy
filter
pour une mesure et la propriété groupBy
a été définie sur true dans la requête, cet objet contiendra l’identifiant du jeu de données correspondant. dps
s’applique à .Si cet objet apparaît vide dans la réponse, la variable
dps
s’applique à tous les jeux de données fournis dans la variable filters
tableau (ou tous les jeux de données dans Platform si aucun filtre n’a été fourni).dps
granularity
valeur spécifiée dans la requête.Annexe
La section suivante contient des informations supplémentaires sur l’utilisation de la variable /metrics
point de terminaison .
Mesures disponibles available-metrics
Les tableaux suivants répertorient toutes les mesures exposées par Observability Insights, ventilé par Platform service. Chaque mesure comprend une description et un paramètre de requête d’identifiant accepté.
Data Ingestion ingestion
Le tableau suivant décrit les mesures pour Adobe Experience Platform Data Ingestion. Les mesures en gras sont des mesures d’ingestion par flux.
Identity Service identity
Le tableau suivant décrit les mesures pour Adobe Experience Platform Identity Service.
Real-Time Customer Profile profile
Le tableau suivant décrit les mesures pour Real-Time Customer Profile.
Messages d’erreur
Réponses de la /metrics
endpoint peut renvoyer des messages d’erreur sous certaines conditions. Ces messages d’erreur sont renvoyés au format suivant :
{
"type": "http://ns.adobe.com/aep/errors/INSGHT-1000-400",
"title": "Bad Request - Start date cannot be after end date.",
"status": 400,
"report": {
"tenantInfo": {
"sandboxName": "prod",
"sandboxId": "49f58060-5d47-34rd-aawf-a5384333ff12",
"imsOrgId": "{ORG_ID}"
},
"additionalContext": null
},
"error-chain": [
{
"serviceId": "INSGHT",
"errorCode": "INSGHT-1000-400",
"invokingServiceId": "INSGHT",
"unixTimeStampMs": 1602095177129
}
]
}
title
report
Le tableau suivant répertorie les différents codes d’erreur qui peuvent être renvoyés par l’API :
INSGHT-1000-400
Un problème s’est produit avec le payload de la requête. Assurez-vous que la mise en forme de la payload correspond exactement à celle affichée. above. L’une des raisons possibles peut déclencher cette erreur :
- Champs obligatoires manquants, tels que
aggregator
- Mesures non valides
- La requête contient un agrégateur non valide
- Une date de début a lieu après une date de fin
INSGHT-1001-400
INSGHT-1001-500
INSGHT-1002-500
INSGHT-1003-401
x-sandbox-name
L’en-tête représente un environnement de test valide et activé pour votre organisation avant de réessayer la requête.