Endpoint de métricas
As métricas de observação fornecem insights sobre estatísticas de uso, tendências históricas e indicadores de desempenho para vários recursos no Adobe Experience Platform. A variável /metrics
endpoint na variável Observability Insights API O permite recuperar programaticamente dados de métrica para a atividade de sua organização no Platform.
Introdução
O endpoint da API usado neste guia faz parte da Observability Insights API. Antes de continuar, reveja o guia de introdução para obter links para a documentação relacionada, um guia para ler as chamadas de API de exemplo neste documento e informações importantes sobre os cabeçalhos necessários para fazer chamadas com êxito para qualquer Experience Platform API.
Recuperar métricas de observabilidade
Você pode recuperar dados de métricas fazendo uma solicitação POST para o /metrics
ponto de acesso, especificando as métricas que deseja recuperar na carga.
Formato da API
POST /metrics
Solicitação
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
retorna métricas para cada dia entre a variável start
e end
data, enquanto um valor de MONTH
agruparia os resultados da métrica por mês. Ao usar esse campo, uma variável downsample
A propriedade também deve ser fornecida para indicar a função de agregação pela qual agrupar dados.metrics
name
filters
Um campo opcional que permite filtrar métricas por conjuntos de dados específicos. O campo é uma matriz de objetos (um para cada filtro), com cada objeto contendo as seguintes propriedades:
name
: o tipo de entidade para filtrar métricas. Atualmente, somentedataSets
é compatível.value
: A ID de um ou mais conjuntos de dados. Várias IDs de conjunto de dados podem ser fornecidas como uma única cadeia de caracteres, com cada ID separada por caracteres de barra vertical (|
).groupBy
: Quando definido como true, indica que o valor correspondentevalue
representa vários conjuntos de dados cujos resultados de métrica devem ser retornados separadamente. Se definido como falso, os resultados da métrica para esses conjuntos de dados serão agrupados.
aggregator
downsample
granularity
propriedade. Para obter informações detalhadas sobre redução da resolução, consulte o Documentação do OpenTSDB.Resposta
Uma resposta bem-sucedida retorna os pontos de dados resultantes para as métricas e os filtros especificados na solicitação.
{
"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
para uma métrica, e a variável groupBy
estiver definida como true na solicitação, esse objeto conterá a ID do conjunto de dados que o dps
se aplica a.Se esse objeto aparecer vazio na resposta, a variável correspondente
dps
se aplica a todos os conjuntos de dados fornecidos na variável filters
matriz (ou todos os conjuntos de dados no Platform se nenhum filtro foi fornecido).dps
granularity
valor especificado na solicitação.Apêndice
A seção a seguir contém informações adicionais sobre como trabalhar com a /metrics
terminal.
Métricas disponíveis available-metrics
As tabelas a seguir listam todas as métricas expostas pelo Observability Insights, discriminados por Platform serviço. Cada métrica inclui uma descrição e um parâmetro de consulta de ID aceito.
Data Ingestion ingestion
A tabela a seguir descreve as métricas do Adobe Experience Platform Data Ingestion. Métricas no negrito são métricas de assimilação por transmissão.
Identity Service identity
A tabela a seguir descreve as métricas do Adobe Experience Platform Identity Service.
Real-Time Customer Profile profile
A tabela a seguir descreve as métricas para Real-Time Customer Profile.
Mensagens de erro
Respostas dos /metrics
O endpoint pode retornar mensagens de erro em determinadas condições. Essas mensagens de erro são retornadas no seguinte formato:
{
"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
A tabela a seguir lista os diferentes códigos de erro que podem ser retornados pela API:
INSGHT-1000-400
Algo deu errado com a carga da solicitação. Verifique se a formatação da carga é exatamente igual à mostrada acima. Qualquer um dos possíveis motivos pode acionar esse erro:
- Campos obrigatórios ausentes, como
aggregator
- Métricas inválidas
- A solicitação contém um agregador inválido
- Uma data inicial ocorre após uma data final
INSGHT-1001-400
INSGHT-1001-500
INSGHT-1002-500
INSGHT-1003-401
x-sandbox-name
o cabeçalho representa uma sandbox válida e ativada para sua organização antes de tentar a solicitação novamente.