稽核事件端點

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

建立對象：

開發人員
使用者
管理員
主機

稽核記錄用於提供各種服務和功能的使用者活動細節。記錄中記錄的每個動作都包含中繼資料，其指出動作型別、日期和時間、執行動作之使用者的電子郵件ID，以及與動作型別相關的其他屬性。 Audit Query API中的/audit/events端點可讓您以程式設計方式擷取貴組織在Platform中的活動事件資料。

快速入門

本指南中使用的API端點是Audit Query API的一部分。繼續之前，請先檢閱快速入門手冊，以取得相關檔案的連結、閱讀本檔案中範例API呼叫的手冊，以及有關成功呼叫任何Experience Platform API所需必要標題的重要資訊。

列出稽核事件

您可以向/audit/events端點發出GET要求，指定您要在承載中擷取的事件，以擷取事件資料。

API格式

GET /audit/events

Audit Query API支援在列出事件時使用查詢引數來頁面和篩選結果。

參數

說明

limit

回應中可傳回的最大記錄數。預設limit為50。

start

針對傳回的搜尋結果，指向第一個專案的指標。若要存取結果的下一頁，此引數應該以限制所指示的相同量增加。範例：若要存取limit=50之要求的下一頁結果，請使用引數start=50，然後對其後的頁面使用start=100，以此類推。

queryId

向/audit/events端點提出查詢時，回應會包含queryId字串屬性。若要在個別呼叫中進行相同的查詢，您可以將ID值納入為單一查詢引數，而非再次手動設定搜尋引數。

要求

curl -X POST \
  https://platform.adobe.io/data/foundation/audit/events?limit=10
  -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}' \
  -H 'x-request-id: {TRACING_ID}' \

回應

成功的回應會傳回要求中所指定量度和篩選器的結果資料點。

{
   "_embedded": {
     "customerAuditLogList": [
       {
         "userEmail": "{USER_ID}",
         "userIpAddresses": [ ],
         "eventType": "Core",
         "id": "32b72208-3035-4bc6-b434-39e34401a864",
         "version": "1.0",
         "imsOrgId": "{ORGANIZATION_ID}",
         "sandboxName": "prod",
         "region": "VA7",
         "requestId": "5NphpgUQdQnjTWOcS9DSMs2wD1EUMlYG",
         "authId": "96715f98-d100-4575-8491-ebbcea654eb9",
         "permissionResource": "Sandbox",
         "permissionType": "RESET",
         "assetType": "Sandbox",
         "assetId": "prod",
         "assetName": "prod",
         "action": "Reset",
         "status": "Allow",
         "failureCode": "",
         "timestamp": "2021-08-04T21:58:09.745+0000"
       },
       {
         "userEmail": "{USER_ID}",
         "userIpAddresses": [ ],
         "eventType": "Core",
         "id": "a178736a-8fa1-47da-bac5-b0d9e741e414",
         "version": "1.0",
         "imsOrgId": "{ORGANIZATION_ID}",
         "sandboxName": "prod",
         "region": "VA7",
         "requestId": "7AlGIAhWvaEzYWHLzvuf26AAFAkqSyKg",
         "authId": "60fc1077-4aef-4e1f-a5ff-f64183e060f4",
         "permissionResource": "Sandbox",
         "permissionType": "RESET",
         "assetType": "Sandbox",
         "assetId": "prod",
         "assetName": "prod",
         "action": "Reset",
         "status": "Allow",
         "failureCode": "",
         "timestamp": "2021-08-04T21:28:00.301+0000"
       },
       {
         "userEmail": "{USER_ID}",
         "userIpAddresses": [ ],
         "eventType": "Core",
         "id": "ccfe8c77-9b93-481d-a561-0b2edf3b77dc",
         "version": "1.0",
         "imsOrgId": "{ORGANIZATION_ID}",
         "sandboxName": "prod",
         "region": "VA7",
         "requestId": "hArqS4CAa8wfRPnKuxV4yaA82atxwzYu",
         "authId": "80b7d887-9338-4cd5-9d79-2483b03f0160",
         "permissionResource": "Sandbox",
         "permissionType": "RESET",
         "assetType": "Sandbox",
         "assetId": "prod",
         "assetName": "prod",
         "action": "Reset",
         "status": "Allow",
         "failureCode": "",
         "timestamp": "2021-08-04T20:58:07.750+0000"
       }
     ]
   },
   "_links": {
     "self": {
       "href": "https://platform.adobe.io/data/foundation/audit/events?limit=10&start=0&property=type%253D%253Dcore"
     },
     "next": {
       "href": "https://platform.adobe.io/data/foundation/audit/events?queryId=cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2&start=10&limit=10"
     },
     "page": {
       "href": "https://platform.adobe.io/data/foundation/audit/events?queryId=cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2&limit=10{&start}",
       "templated": true
     }
  },
  "page": {
    "size": 10,
    "totalElements": 3,
    "totalPages": 1,
    "number": 1
  },
  "queryId": "cXVlcnlJZD0xYjA4MDM4MV81ZWNkXzRjNTZfYTM2N18zYWExOWI5YzNhNTlfMTYyODExNDY5MTg1NSZ0b3RhbEVsZW1lbnRzPTI2"
}

屬性

說明

customerAuditLogList

陣列，其物件代表要求中指定的每個事件。每個物件都包含有關篩選器設定和傳回事件資料的資訊。

userEmail

執行事件之使用者的電子郵件。

eventType

事件型別。事件型別包括Core和Enhanced。

imsOrgId

發生事件之組織的ID。

permissionResource

提供許可權的產品或功能會執行此動作。資源可以是下列任一專案：

Activation
ActivationAssociation
AnalyticSource
AudienceManagerSource
BizibleSource
CustomerAttributeSource
Dataset
EnterpriseSource
LaunchSource
MarketoSource
ProductProfile
ProfileConfig
Sandbox
Schema
Segment
StreamingSource

permissionType

動作涉及的許可權型別。

assetType

執行動作的Platform資源型別。

assetId

執行動作之Platform資源的唯一識別碼。

assetName

執行動作的Platform資源名稱。

action

為事件記錄的動作型別。動作可以是下列任一專案：

Add
Create
Dataset activate
Dataset remove
Delete
Disable for profile
Enable
Enable for profile
Profile activate
Profile remove
remove
reset
segment activate
segment remove
update

status

動作的狀態。狀態可以是下列任一專案：

Allow
Deny
Failure
Success

recommendation-more-help

5741548a-2e07-44b3-9157-9c181502d0c5