Show Menu
主題×

Adobe Experience Platform可觀性洞察概觀

可觀測性洞察是REST風格的API,可讓您在Adobe Experience Platform中公開關鍵的可觀測性度量。 這些量度可提供平台使用統計資料、平台服務狀況檢查、歷史趨勢以及各種平台功能效能指標的深入資訊。
本檔案示範對Encomberity Insights API的範例呼叫。 如需完整的可觀測端點清單,請參閱可觀 測洞察API參考

快速入門

若要呼叫平台API,您必須先完成驗證教 學課程 。 完成驗證教學課程後,所有Experience Platform API呼叫中每個必要標題的值都會顯示在下方:
  • 授權:生產者 {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Experience Platform中的所有資源都隔離至特定的虛擬沙盒。 所有對平台API的請求都需要一個標題,該標題會指定要進行操作的沙盒名稱。 如需平台中沙盒的詳細資訊,請參閱沙盒 概觀檔案
  • x-sandbox-name: {SANDBOX_NAME}

擷取可觀測度量

您可以在「可觀性洞察API」中對端點提出GET請求, /metrics 以擷取可觀性度量。
API格式
使用端點 /metrics 時,必須至少提供一個量度請求參數。 其他查詢參數是篩選結果的可選參數。
GET /metrics?metric={METRIC}
GET /metrics?metric={METRIC}&metric={METRIC_2}
GET /metrics?metric={METRIC}&id={ID}
GET /metrics?metric={METRIC}&dateRange={DATE_RANGE}
GET /metrics?metric={METRIC}&metric={METRIC_2}&id={ID}&dateRange={DATE_RANGE}

參數
說明
{METRIC}
您要公開的量度。 在單一呼叫中合併多個量度時,您必須使用&符號( & )來分隔個別量度。 例如, metric={METRIC_1}&metric={METRIC_2} .
{ID}
您要公開其量度的特定平台資源的識別碼。 此ID可能是選用、必要或不適用,視使用的量度而定。 如需每個度量的可用度量清單以及支援的ID(必要和可選),請參閱可用度量的參考 檔案
{DATE_RANGE}
您要公開的量度日期範圍,使用ISO 8601格式(例如 2018-10-01T07:00:00.000Z/2018-10-09T07:00:00.000Z )。
請求
curl -X GET \
  https://platform.adobe.io/data/infrastructure/observability/insights/metrics?metric=timeseries.ingestion.dataset.size&metric=timeseries.ingestion.dataset.recordsuccess.count&id=5cf8ab4ec48aba145214abeb&dateRange=2018-10-01T07:00:00.000Z/2019-06-06T07:00:00.000Z \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

回應
成功的響應返回對象清單,每個對象都包含提供的時間戳和請求路徑中 dateRange 指定的度量的相應值。 如果 id 請求路徑中包含平台資源,則結果僅適用於該特定資源。 若省略 id 此項目,結果將套用至IMS組織內的所有適用資源。
{
    "id": "5cf8ab4ec48aba145214abeb",
    "imsOrgId": "{IMS_ORG}",
    "timeseries": {
        "granularity": "MONTH",
        "items": [
            {
                "timestamp": "2019-06-01T00:00:00Z",
                "metrics": {
                    "timeseries.ingestion.dataset.recordsuccess.count": 1125,
                    "timeseries.ingestion.dataset.size": 32320
                }
            },
            {
                "timestamp": "2019-05-01T00:00:00Z",
                "metrics": {
                    "timeseries.ingestion.dataset.recordsuccess.count": 1003,
                    "timeseries.ingestion.dataset.size": 31409
                }
            },
            {
                "timestamp": "2019-04-01T00:00:00Z",
                "metrics": {
                    "timeseries.ingestion.dataset.recordsuccess.count": 740,
                    "timeseries.ingestion.dataset.size": 25809
                }
            },
            {
                "timestamp": "2019-03-01T00:00:00Z",
                "metrics": {
                    "timeseries.ingestion.dataset.recordsuccess.count": 740,
                    "timeseries.ingestion.dataset.size": 25809
                }
            },
            {
                "timestamp": "2019-02-01T00:00:00Z",
                "metrics": {
                    "timeseries.ingestion.dataset.recordsuccess.count": 390,
                    "timeseries.ingestion.dataset.size": 16801
                }
            }
        ],
        "_page": null,
        "_links": null
    },
    "stats": {}
}

後續步驟

本檔案提供可觀性分析API的概觀。 如需可用 量度的完整清單 ,請參閱可用量度上的檔案。