DocumentaçãoExperience PlatformVisão geral da Experience Platform

Endpoint de eventos de auditoria

Last update: Tue Nov 19 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Desenvolvedor

Os logs de auditoria são usados para fornecer detalhes da atividade do usuário para vários serviços e recursos. Cada ação registrada em um log contém metadados que indicam o tipo de ação, a data e a hora, a ID do email do usuário que executou a ação e atributos adicionais relevantes ao tipo de ação. O ponto de extremidade /audit/events na API Audit Query permite recuperar programaticamente dados do evento para a atividade de sua organização no Platform.

Introdução

O ponto de extremidade de API usado neste guia faz parte da Audit Query API. Antes de continuar, consulte o guia de introdução para obter links para a documentação relacionada, um guia para ler as chamadas de API de exemplo neste documento e informações importantes sobre os cabeçalhos necessários para fazer chamadas com êxito para qualquer API do Experience Platform.

Listar eventos de auditoria

Você pode recuperar dados de eventos fazendo uma solicitação GET para o ponto de extremidade /audit/events, especificando os eventos que deseja recuperar na carga.

Formato da API

GET /audit/events

A API Audit Query oferece suporte ao uso de parâmetros de consulta para página e filtrar resultados ao listar eventos.

Parâmetro
Descrição
limit
O número máximo de registros a serem retornados na resposta. O padrão limit é 50.
start
Um ponteiro para o primeiro item dos resultados da pesquisa retornados. Para acessar a próxima página de resultados, esse parâmetro deve ser incrementado na mesma quantidade indicada pelo limite. Exemplo: para acessar a próxima página de resultados de uma solicitação com limite=50, use o parâmetro start=50, depois start=100 para a página após essa e assim por diante.
queryId
Ao fazer uma consulta ao endpoint /audit/events, a resposta inclui uma propriedade de sequência de caracteres queryId. Para fazer a mesma consulta em uma chamada separada, você pode incluir o valor da ID como um único parâmetro de consulta em vez de configurar manualmente os parâmetros de pesquisa novamente.

Solicitação

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

Resposta

Uma resposta bem-sucedida retorna os pontos de dados resultantes para as métricas e os filtros especificados na solicitação.

{
   "_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"
}
Propriedade
Descrição
customerAuditLogList
Uma matriz cujos objetos representam cada um dos eventos especificados na solicitação. Cada objeto contém informações sobre a configuração de filtro e os dados do evento retornados.
userEmail
O email do usuário que executou o evento.
eventType
O tipo de evento. Os tipos de eventos incluem Core e Enhanced.
imsOrgId
A ID da organização na qual o evento ocorreu.
permissionResource

O produto ou recurso que forneceu a permissão para executar a ação. Um recurso pode ser qualquer um dos seguintes:

  • Activation
  • ActivationAssociation
  • AnalyticSource
  • AudienceManagerSource
  • BizibleSource
  • CustomerAttributeSource
  • Dataset
  • EnterpriseSource
  • LaunchSource
  • MarketoSource
  • ProductProfile
  • ProfileConfig
  • Sandbox
  • Schema
  • Segment
  • StreamingSource
permissionType
O tipo de permissão envolvido na ação.
assetType
O tipo de recurso da Platform no qual a ação foi executada.
assetId
Um identificador exclusivo do recurso da Platform no qual a ação foi executada.
assetName
O nome do recurso da plataforma no qual a ação foi executada.
action

O tipo de ação que foi gravado para o evento. Uma ação pode ser qualquer um dos seguintes:

  • 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

O status da ação. Um status pode ser qualquer um dos seguintes:

  • Allow

  • Deny

  • Failure

  • Success

recommendation-more-help
5741548a-2e07-44b3-9157-9c181502d0c5