Måttslutpunkt
Mätvärden för observerbarhet ger insikt i användningsstatistik, historiska trender och resultatindikatorer för olika funktioner i Adobe Experience Platform. The /metrics
slutpunkt i Observability Insights API gör att du kan hämta mätdata för organisationens aktiviteter i Platform.
Komma igång
API-slutpunkten som används i den här guiden är en del av Observability Insights API. Läs igenom komma igång-guide för länkar till relaterad dokumentation, en guide till hur du läser exempel-API-anrop i det här dokumentet och viktig information om vilka huvuden som behövs för att kunna ringa anrop till Experience Platform API.
Hämta mätvärden för observerbarhet
Du kan hämta mätdata genom att göra en POST-förfrågan till /metrics
slutpunkt, ange de mått som du vill hämta i nyttolasten.
API-format
POST /metrics
Begäran
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
returnerar mått för varje dag mellan start
och end
datum, medan värdet MONTH
skulle gruppera mätresultaten per månad i stället. När du använder det här fältet, en downsample
Egenskapen måste också anges för att ange den aggregeringsfunktion som data ska grupperas efter.metrics
name
filters
Ett valfritt fält där du kan filtrera mätvärden efter specifika datauppsättningar. Fältet är en array med objekt (ett för varje filter), där varje objekt innehåller följande egenskaper:
name
: Den typ av entitet som mätvärden ska filtreras mot. För närvarande, endastdataSets
stöds.value
: ID för en eller flera datauppsättningar. Flera datauppsättnings-ID:n kan anges som en enda sträng, där varje ID avgränsas med lodräta streck (|
).groupBy
: Om värdet är true anger det att motsvarandevalue
representerar flera datauppsättningar vars mätresultat ska returneras separat. Om värdet är false grupperas mätresultaten för de datauppsättningarna tillsammans.
aggregator
downsample
granularity
-egenskap. Mer information om nedsampling finns i OpenTSDB-dokumentation.Svar
Ett lyckat svar returnerar de resulterande datapunkterna för de mätvärden och filter som anges i begäran.
{
"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
för ett mätresultat och groupBy
alternativet var inställt på true i begäran, kommer det här objektet att innehålla ID:t för datauppsättningen som motsvarar dps
egenskapen gäller för.Om objektet är tomt i svaret visas motsvarande
dps
egenskapen gäller för alla datauppsättningar som finns i filters
array (eller alla datauppsättningar i Platform om inga filter har angetts).dps
granularity
det värde som anges i begäran.Bilaga
Följande avsnitt innehåller ytterligare information om hur du arbetar med /metrics
slutpunkt.
Tillgängliga mått available-metrics
I följande tabeller visas alla mätvärden som visas av Observability Insights, uppdelat efter Platform service. Varje mätvärde innehåller en beskrivning och en godkänd ID-frågeparameter.
Data Ingestion ingestion
I följande tabell visas mätvärden för Adobe Experience Platform Data Ingestion. Mätvärden i fet är mätvärden för direktuppspelad konsumtion.
Identity Service identity
I följande tabell visas mätvärden för Adobe Experience Platform Identity Service.
Real-Time Customer Profile profile
Följande tabell visar mätvärden för Real-Time Customer Profile.
Felmeddelanden
Svar från /metrics
slutpunkten kan returnera felmeddelanden under vissa förhållanden. Dessa felmeddelanden returneras i följande format:
{
"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
I följande tabell visas de olika felkoderna som kan returneras av API
INSGHT-1000-400
Något var fel med nyttolasten för begäran. Kontrollera att du matchar nyttolastens formatering exakt som den visas ovan. Alla möjliga orsaker kan utlösa det här felet:
- Obligatoriska fält saknas, till exempel
aggregator
- Ogiltiga mått
- Begäran innehåller en ogiltig aggregator
- Ett startdatum infaller efter ett slutdatum
INSGHT-1001-400
INSGHT-1001-500
INSGHT-1002-500
INSGHT-1003-401
x-sandbox-name
header representerar en giltig, aktiverad sandlåda för din organisation innan du försöker utföra begäran igen.