ドキュメント Experience Platform Experience Platform の概要

監査イベントエンドポイント

Last update: Fri Apr 04 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

トピック：
監査
API

作成対象：

開発者

監査ログは、様々なサービスや機能に関するユーザーアクティビティの詳細を提供するために使用されます。ログに記録される各アクションには、アクションのタイプ、日時、アクションを実行したユーザーの電子メール ID、アクションのタイプに関連する追加の属性を示すメタデータが含まれます。Audit Query API の /audit/events エンドポイントを使用すると、組織のアクティビティのイベントデータを Experience Platform でプログラムによって取得できます。

はじめに

このガイドで使用する API エンドポイントは、Audit Query API の一部です。先に進む前に、はじめる前にのガイドを参照し、関連ドキュメントへのリンク、このドキュメントのサンプル API 呼び出しを読み取るためのガイドおよび任意の Experience Platform API の呼び出しを成功させるのに必要なヘッダーに関する重要な情報を確認してください。

監査イベントのリスト

イベントデータを取得するには、/audit/events エンドポイントに対してGET リクエストを実行し、取得するイベントをペイロードで指定します。

API 形式

GET /audit/events

Audit Query API では、イベントをリストする際にクエリパラメーターを使用して結果をページおよびフィルターする機能をサポートしています。

パラメーター

説明

limit

応答で返されるレコードの最大数。デフォルト limit は 50 です。

start

返される検索結果の最初の項目へのポインター。結果の次のページにアクセスするには、このパラメーターを limit で示されるのと同じ量だけ増分する必要があります。例：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

アクションが実行されたExperience Platform リソースのタイプ。

assetId

アクションが実行されたExperience Platform リソースの一意の ID。

assetName

アクションが実行されたExperience 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