Introdução à API de consulta de auditoria

O Adobe Experience Platform permite auditar a atividade do usuário em vários serviços e recursos na forma de logs de eventos de auditoria. 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.

A API de Consulta de auditoria permite auditar a atividade do usuário em vários serviços e recursos na forma de logs de eventos de auditoria. Este documento fornece uma introdução aos conceitos principais que você precisa saber antes de tentar fazer chamadas para a API de consulta de auditoria.

Pré-requisitos

Para gerenciar eventos de auditoria, você deve ter a Exibir log de atividades do usuário permissão de controle de acesso concedida (encontrada sob o Governança de dados categoria). Para saber como gerenciar permissões individuais para recursos da Platform, consulte a documentação de controle de acesso.

Leitura de chamadas de API de amostra

Este guia fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O exemplo de JSON retornado nas respostas da API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de exemplo, consulte a seção sobre como ler chamadas de API de exemplo no guia de solução de problemas de Experience Platform.

Coletar valores para cabeçalhos obrigatórios

Este guia requer que você tenha concluído o tutorial de autenticação para fazer chamadas com êxito para APIs da Platform. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API de Experience Platform, conforme mostrado abaixo:

  • Autorização: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Todos os recursos em Experience Platform são isolados em sandboxes virtuais específicas. Todas as solicitações para Platform As APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá. Para obter mais informações sobre sandboxes no Platform, consulte o documentação de visão geral da sandbox.

  • x-sandbox-name: {SANDBOX_NAME}

Todas as solicitações que contêm uma carga (POST, PUT e PATCH) exigem um cabeçalho adicional:

  • Tipo de conteúdo: application/json

Próximas etapas

Para começar a fazer chamadas usando o Audit Query API, consulte a manual de endpoint de eventos e a variável exportar guia de endpoint.

Nesta página