Documentazione Experience Platform Panoramica di Experience Platform

Endpoint “audit_events”

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

Creato per:

Sviluppatore
Utente
Amministratore
Leader

I registri di audit vengono utilizzati per fornire dettagli sull’attività dell’utente per vari servizi e funzionalità. Ogni azione registrata contiene metadati che indicano il tipo di azione, la data e l’ora, l’ID e-mail dell’utente che l’ha eseguita e altri attributi relativi al tipo di azione. L'endpoint /audit/events nell'API Audit Query consente di recuperare in modo programmatico i dati evento per l'attività dell'organizzazione in Platform.

Introduzione

L'endpoint API utilizzato in questa guida fa parte dell'Audit Query API. Prima di continuare, consulta la guida introduttiva per i collegamenti alla documentazione correlata, una guida alla lettura delle chiamate API di esempio in questo documento e informazioni importanti sulle intestazioni necessarie per effettuare correttamente le chiamate a qualsiasi API Experience Platform.

Elencare eventi di audit

È possibile recuperare i dati degli eventi effettuando una richiesta GET all'endpoint /audit/events, specificando gli eventi da recuperare nel payload.

Formato API

GET /audit/events

L'API Audit Query supporta l'utilizzo di parametri di query per la pagina e il filtro dei risultati durante l'elenco degli eventi.

Parametro

Descrizione

limit

Numero massimo di record da restituire nella risposta. Il valore predefinito limit è 50.

start

Puntatore al primo elemento per i risultati di ricerca restituiti. Per accedere alla pagina successiva dei risultati, questo parametro deve essere incrementato della stessa quantità indicata da un limite. Esempio: per accedere alla pagina successiva dei risultati per una richiesta con limite=50, utilizza il parametro start=50, quindi start=100 per la pagina successiva e così via.

queryId

Quando si esegue una query sull’endpoint /audit/events, la risposta include una proprietà stringa queryId. Per eseguire la stessa query in una chiamata separata, puoi includere il valore Id come un singolo parametro di query invece di configurare manualmente di nuovo i parametri di ricerca.

Richiesta

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}' \

Risposta

In caso di esito positivo, la risposta restituisce i punti dati risultanti per le metriche e i filtri specificati nella richiesta.

{
   "_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"
}

Proprietà

Descrizione

customerAuditLogList

Matrice i cui oggetti rappresentano ciascuno degli eventi specificati nella richiesta. Ogni oggetto contiene informazioni sulla configurazione del filtro e sui dati evento restituiti.

userEmail

Indirizzo e-mail dell’utente che ha eseguito l’evento.

eventType

Il tipo di evento. I tipi di eventi includono Core e Enhanced.

imsOrgId

ID dell’organizzazione in cui si è verificato l’evento.

permissionResource

Il prodotto o la funzionalità che ha fornito l’autorizzazione eseguono l’azione. Una risorsa può essere una qualsiasi delle seguenti:

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

permissionType

Tipo di autorizzazione coinvolto nell’azione.

assetType

Tipo di risorsa Platform su cui è stata eseguita l’azione.

assetId

Identificatore univoco della risorsa Platform su cui è stata eseguita l’azione.

assetName

Nome della risorsa Platform su cui è stata eseguita l’azione.

action

Tipo di azione registrata per l’evento. Un’azione può essere una qualsiasi delle seguenti:

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

Stato dell’azione. Uno stato può essere uno dei seguenti:

Allow
Deny
Failure
Success

recommendation-more-help

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