量度端点
可观察性指标可为Adobe Experience Platform中的各种功能提供使用统计数据、历史趋势和绩效指标的洞察。 此 /metrics
中的端点 Observability Insights API 允许您以编程方式检索您组织活动的量度数据,位置在 Platform.
快速入门
本指南中使用的API端点是 Observability Insights API. 在继续之前,请查看 快速入门指南 有关相关文档的链接,请参阅本文档中的示例API调用指南,以及有关成功调用任何组件所需的所需标头的重要信息 Experience Platform API。
检索可观察性指标
您可以通过向以下网站发出POST请求来检索量度数据: /metrics
端点,指定要在有效负载中检索的量度。
API格式
POST /metrics
请求
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
返回介于以下日期之间的每天的指标: start
和 end
日期,而值为 MONTH
将改为按月对指标结果进行分组。 使用此字段时, downsample
还必须提供属性以指示用于对数据进行分组的聚合函数。metrics
name
filters
一个可选字段,允许您按特定数据集筛选量度。 字段是一个对象数组(每个过滤器对应一个对象),每个对象包含以下属性:
name
:要筛选量度的实体类型。 当前,仅限dataSets
受支持。value
:一个或多个数据集的ID。 可以将多个数据集ID作为单个字符串提供,每个ID均以垂直条形字符(|
)。groupBy
:设置为true时,指示相应的value
表示多个数据集,这些数据集的量度结果应单独返回。 如果设置为false,则将这些数据集的量度结果分组在一起。
aggregator
downsample
granularity
属性。 有关缩减取样的详细信息,请参阅 OpenTSDB文档.响应
成功响应将返回请求中指定的量度和过滤器的结果数据点。
{
"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
量度的属性,以及 groupBy
选项在请求中设置为true,此对象将包含相应数据集的ID dps
属性应用于。如果此对象在响应中显示为空,则相应的
dps
属性适用于 filters
数组(或中的所有数据集) Platform (如果未提供过滤器)。dps
granularity
请求中指定的值。附录
以下部分包含有关使用的其他信息 /metrics
端点。
可用量度 available-metrics
下表列出了由以下对象公开的所有指标 Observability Insights,划分依据 Platform 服务。 每个量度都包含一个描述和接受的ID查询参数。
Data Ingestion ingestion
下表概述了Adobe Experience Platform的量度 Data Ingestion. 中的量度 粗体 是流式摄取量度。
Identity Service identity
下表概述了Adobe Experience Platform的量度 Identity Service.
Real-Time Customer Profile profile
下表概述了以下各项的指标 Real-Time Customer Profile.
错误消息
来自 /metrics
端点可能会在某些情况下返回错误消息。 以下列格式返回这些错误消息:
{
"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
下表列出了API可返回的不同错误代码:
INSGHT-1000-400
请求有效负载出现问题。 确保与所示的有效负载格式完全匹配 以上. 任何可能的原因都会触发此错误:
- 缺少必填字段,例如
aggregator
- 量度无效
- 该请求包含无效的汇总
- 开始日期发生在结束日期之后
INSGHT-1001-400
INSGHT-1001-500
INSGHT-1002-500
INSGHT-1003-401
x-sandbox-name
在重试请求之前,标头表示您的组织已启用的有效沙盒。