Última modificação: 28 de agosto de 2025
Use a API de análise da eventos para buscar eventos associados a qualquer tipo de registro do CRM (somente para Marketing Hub Enterprise, Sales Hub Enterprise, Service Hub Enterprise, ou CMS Hub Enterprise. Isso inclui eventos padrão, como visualizações de página do site e aberturas de e-mail, bem como eventos personalizados. Por exemplo, use essa API para visualizar uma linha do tempo das interações que um contato teve com seu conteúdo. Você pode usar essa linha do tempo para criar um conjunto de dados para análise personalizada ou apresentar uma linha do tempo de contato em um aplicativo externo.

​
Conclusões individuais de evento

Esta API retorna eventos para um registro de CRM por vez. Você pode selecionar o registro ao especificar o objectType e incluir o parâmetro de consulta objectId ou objectProperty.

​
Selecionar por ID de objeto

Para especificar um registro pelo ID, adicione parâmetro de consulta objectId. Por exemplo, para especificar um registro do contato com o ID 2832, você faria a seguinte solicitação GET: /events/v3/events/?objectType=contact&objectId=224834

​
Selecionar por propriedade de objeto

Para especificar um registro por uma propriedade exclusiva em vez de ID de contato, adicione o parâmetro objectProperty. Consulte a propriedade incluindo o nome da propriedade e o valor no seguinte formato: objectProperty.{propname}={propvalue} Por exemplo, para especificar um contato pelo endereço de e-mail, você faria a seguinte solicitação GET: /events/v3/events/?objectType=contact&objectProperty.email=user12@dev.com

​
Consultar e filtrar tipos de eventos

Quando consultar eventos associados a um determinado objeto de CRM, a resposta incluirá todos os tipos de evento, incluindo eventos de comportamentos personalizados. Para retornar apenas conclusões de um tipo de evento específico, você pode incluir um parâmetro eventType seguido do nome do evento. Para obter uma lista de todos os tipos de eventos disponíveis, pode fazer uma solicitação GET para /events/v3/events/event-types. A resposta retornará todos os tipos de eventos da sua conta. Você pode utilizar um destes nomes de eventos como parâmetro de consulta em uma solicitação GET para o ponto de extremidade /events/v3/events. Por exemplo: /events/v3/events/eventType={EVENT_NAME}&objectType=contact&objectId=224834