指標エンドポイント
観察性指標は、Adobe Experience Platformの様々な機能の使用状況の統計、過去の傾向、パフォーマンス指標に関するインサイトを提供します。 この /metrics
エンドポイント Observability Insights API を使用すると、で組織のアクティビティの指標データをプログラムによって取得できます。 Platform.
はじめに
このガイドで使用する API エンドポイントは、Observability Insights API の一部です。先に進む前に、はじめる前にのガイドを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API の呼び出しを成功させるのに必要なヘッダーに関する重要な情報を確認してください。
観察性指標の取得
指標データを取得するには、 /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
特定のデータセットで指標をフィルタリングできるオプションのフィールドです。 フィールドはオブジェクトの配列(各フィルターに対して 1 つ)で、各オブジェクトには次のプロパティが含まれます。
name
:指標をフィルターするエンティティのタイプ。 現在は、dataSets
のみがサポートされています。value
:1 つ以上のデータセットの ID。 複数のデータセット ID を 1 つの文字列として指定でき、各 ID を縦棒グラフ (|
) をクリックします。groupBy
:true に設定した場合、は、対応するvalue
は、指標の結果を個別に返す必要がある複数のデータセットを表します。 false に設定した場合、これらのデータセットの指標の結果は 1 つにグループ化されます。
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 に設定された場合、このオブジェクトには、対応する dps
プロパティの適用先:このオブジェクトが応答で空の場合、
dps
プロパティは、 filters
配列(またはすべてのデータセット) Platform (フィルターが指定されていない場合)。dps
granularity
リクエストで指定された値。付録
次の節では、 /metrics
endpoint.
使用可能な指標 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
ヘッダーは、組織で有効になっている、リクエストを再試行する前の有効なサンドボックスを表します。