Dados de evento da jornada do Amazon Pinpoint - Amazon Pinpoint
Exemplo de evento de jornadaAtributos de eventos de jornadas

Dados de evento da jornada do Amazon Pinpoint

Quando você publica uma jornada, o Amazon Pinpoint pode transmitir dados de eventos para mensagens de e-mail, SMS, push e personalizadas que você enviar da jornada. Depois de configurar a transmissão de eventos, o Amazon Pinpoint recupera os dados do destino que você especificou durante a configuração, para que você possa visualizá-los. Para obter informações detalhadas sobre os dados transmitidos pelo Amazon Pinpoint para mensagens de e-mail e SMS, consulte Fluxo de dados de evento de e-mail do Amazon Pinpoint e Fluxo de dados de evento de SMS do Amazon Pinpoint. Para obter informações sobre como configurar uma transmissão de evento, consulte Configure o Amazon Pinpoint para transmitir dados de eventos do aplicativo por meio do Amazon Kinesis ou do Amazon Data Firehose .

Exemplo de evento de jornada

O objeto JSON para um evento de jornada contém os dados mostrados no exemplo a seguir.

{
   "event_type":"_journey.send",
   "event_timestamp":1572989078843,
   "arrival_timestamp":1572989078843,
   "event_version":"3.1",
   "application":{
      "app_id":"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
      "sdk":{

      }
   },
   "client":{
      "client_id":"d8dcf7c5-e81a-48ae-8313-f540cexample"
   },
   "device":{
      "platform":{

      }
   },
   "session":{

   },
   "attributes":{
      "journey_run_id":"edc9a0b577164d1daf72ebd15example",
      "journey_send_status":"SUCCESS",
      "journey_id":"546401670c5547b08811ac6a9example",
      "journey_activity_id":"0yKexample",
      "journey_activity_type": "EMAIL",
      "journey_send_status_message": "200", 
      "journey_send_status_code": "200"
   },
   "client_context":{
      "custom":{
         "endpoint":"{\"ChannelType\":\"EMAIL\",\"EndpointStatus\":\"ACTIVE\",\"OptOut\":\"NONE\",\"Demographic\":{\"Timezone\":\"America/Los_Angeles\"}}"
      }
   },
   "awsAccountId":"123456789012"
}

Atributos de eventos de jornadas

Esta seção define os atributos incluídos nos dados de fluxo de eventos que o Amazon Pinpoint gera para uma jornada.

Atributo Descrição
event_type

O tipo de evento. Para eventos de jornada, o valor para esse atributo é sempre _journey.send, o que indica que o Amazon Pinpoint executou a jornada.
event_timestamp

A hora em que o evento foi relatado, mostrada como horário do Unix em milissegundos.
arrival_timestamp

A hora em que o evento foi recebido pelo Amazon Pinpoint, mostrada como horário do Unix em milissegundos.
event_version

A versão do esquema do evento JSON.

dica

Marque esta versão no seu aplicativo de processamento de eventos para que você saiba quando atualizar o aplicativo em resposta a uma atualização de esquema.
application

Informações sobre o projeto do Amazon Pinpoint associado ao evento. Para obter mais informações, consulte a tabela Aplicativo.
client

Informações sobre o endpoint ao qual o evento está associado. Para obter mais informações, consulte a tabela Cliente.
device

Informações sobre o dispositivo que relatou o evento. Para jornadas, este objeto está vazio.
session

Informações sobre a sessão que gerou o evento. Para jornadas, este objeto está vazio.
attributes

Atributos associados à jornada e à atividade de jornada que gerou o evento. Para obter mais informações, consulte a tabela Atributos.
client_context Contém um objeto custom, que contém uma propriedade endpoint. A propriedade endpoint contém o conteúdo do registro de endpoint para o endpoint que está associado ao evento.
awsAccountId

O ID da conta da AWS que foi usada para executar a jornada.

Aplicativo

Inclui informações sobre o projeto do Amazon Pinpoint ao qual o evento está associado.

Atributo Descrição
app_id

O ID exclusivo do projeto do Amazon Pinpoint que relatou o evento.
sdk

O SDK usado para relatar o evento.

Cliente

Inclui informações sobre o endpoint que está associado ao evento.

Atributo Descrição
client_id O ID do endpoint.

Atributos

Inclui informações sobre a jornada sessão que gerou o evento.

Atributo Descrição
journey_run_id

O ID exclusivo da execução da jornada que gerou o evento. O Amazon Pinpoint gera e atribui esse ID automaticamente a cada nova execução de uma jornada.
journey_send_status

Indica o status de entrega da mensagem que está associada ao evento. Os possíveis valores incluem:

  • SUCCESS: a mensagem foi enviada com êxito para o endpoint.

  • FAILURE: a mensagem não foi enviada para o endpoint porque ocorreu um erro.

  • CUSTOM_DELIVERY_FAILURE: falha na entrega personalizada.

  • FAILURE_PERMANENT: ocorreu uma falha permanente ao enviar para o endpoint.

    dica

    Você pode filtrar os eventos com o status FAILURE_PERMANENT e journey_send_status_code definir como 403 para determinar se há uma violação de política de acesso e perfil. Para campanhas externas com voz, essas exceções são típicas das instâncias em que o perfil de execução da campanha do Connect que vincula as jornadas do Amazon Pinpoint às campanhas do Amazon Connect é excluído acidentalmente para execuções de jornada em trânsito.

  • THROTTLED: o envio foi limitado.

  • UNSUPPORTED_CHANNEL: o canal não é compatível.

  • DAILY_CAP: a mensagem não foi enviada para o endpoint porque o envio da mensagem excederia o número máximo de mensagens que a jornada ou o projeto pode enviar para um único endpoint durante um período de 24 horas.

  • QUIET_TIME: a mensagem não foi enviada devido às restrições de tempo de silêncio para a jornada ou projeto.

  • QUIET_TIME_MISSING_TIMEZONE: a mensagem não foi enviada porque não foi possível estimar um fuso horário para o endpoint e o horário de silêncio está ativado.
journey_id

O ID exclusivo da jornada que gerou o evento.
journey_activity_id

O ID exclusivo da atividade de jornada que gerou o evento.
journey_activity_type

O tipo de atividade de jornada do evento. Isso pode ser EMAIL, SMS, PUSH, CONTACT_CENTER ou CUSTOM.

nota

VOICE não é um tipo de atividade de jornada compatível.

journey_send_status_message

 A descrição do status do evento de envio.
journey_send_status_code O código do status HTTP da solicitação.