Análise da Web

Acessar e testar APIs em beta. 

Observação: Essa API está em desenvolvimento e está sujeita a alterações com base em teste e feedback. Ao usar esses endpoints, você concorda em atender aos nossos Termos de DesenvolvedorBeta de Desenvolvedor. Você também reconhece e compreende o risco associado ao teste de uma API instável.

Use a API de análises da Web para buscar eventos associados aos registros de CRM de qualquer tipo. Isso inclui eventos padrão, como visualizações de página do site e aberturas de e-mail, bem como eventos de comportamentos 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

Tipos de evento

Quando consultar eventos associados a um determinado objeto de CRM, a resposta incluirá todos os tipos de evento, incluindo eventos de comportamentos personalizados. Durante o beta, alguns tipos de evento padrão estão sujeitos a alterações.

Para voltar a conclusões de eventos de comportamentos personalizados, você pode incluir um parâmetro eventType, seguido pelo nome de evento de comportamentos personalizado. Por exemplo:

/events/v3/events/eventType={EVENT_NAME}&objectType=contact&objectId=224834



Was this article helpful? *
This form is used for documentation feedback only. Learn how to get help with HubSpot...