Consultar dados de análise do Amazon Pinpoint - Amazon Pinpoint
Consultar métricas no Amazon Pinpoint

Aviso de fim do suporte: em 30 de outubro de 2026, AWS encerrará o suporte para o Amazon Pinpoint. Depois de 30 de outubro de 2026, você não poderá mais acessar o console do Amazon Pinpoint ou os recursos do Amazon Pinpoint (endpoints, segmentos, campanhas, viagens e análises). Para obter mais informações, consulte Fim do suporte do Amazon Pinpoint. Observação: APIs relacionados a SMS, voz, push móvel, OTP e validação de número de telefone não são afetados por essa alteração e são compatíveis com o AWS End User Messaging.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Consultar dados de análise do Amazon Pinpoint

Além de usar as páginas de análise no console do Amazon Pinpoint, você pode usar o Amazon Pinpoint APIs Analytics para consultar dados analíticos de um subconjunto de métricas padrão que fornecem informações sobre tendências relacionadas ao engajamento do usuário, ao alcance da campanha e muito mais. Essas métricas, também chamadas de indicadores-chave de desempenho (KPIs), são valores mensuráveis que podem ajudá-lo a monitorar e avaliar o desempenho de seus projetos, campanhas e jornadas.

Se você usar o APIs para consultar dados analíticos, poderá analisar os dados usando a ferramenta de relatórios de sua escolha, sem precisar fazer login no console do Amazon Pinpoint ou analisar dados brutos de eventos de fontes como streams do Amazon Kinesis. Por exemplo, você pode criar um painel personalizado que exiba resultados semanais da campanha ou forneça análises detalhadas sobre as taxas de entrega para suas campanhas.

Você pode consultar os dados usando a API REST do Amazon Pinpoint, o AWS Command Line Interface (AWS CLI) ou um AWS SDK. Para consultar os dados, envie uma solicitação para a API do Amazon Pinpoint e use parâmetros compatíveis para especificar os dados que deseja e quaisquer filtros que deseja aplicar. Depois de enviar sua consulta, o Amazon Pinpoint retorna os resultados dela em uma resposta JSON. Em seguida, você pode passar os resultados para outro serviço ou aplicativo para uma análise mais aprofundada, armazenamento ou relatórios.

O Amazon Pinpoint coleta e agrega dados automaticamente para todas as métricas compatíveis e para todos os seus projetos, campanhas e jornadas. Além disso, os dados são atualizados continuamente, o que resulta em um período de latência de dados que é limitado a cerca de duas horas. Observe, no entanto, que pode haver latência de dados adicional para determinadas métricas. Isso ocorre porque os dados de algumas métricas são baseados em informações que recebemos dos provedores de e-mail dos destinatários. Alguns provedores nos enviam essas informações imediatamente, enquanto outros enviam com menos frequência.

O Amazon Pinpoint armazena os dados por 90 dias. Para armazenar os dados por mais de 90 dias ou para acessar dados de análise brutos em tempo real, você pode configurar um projeto do Amazon Pinpoint para transmitir dados de eventos para o Amazon Kinesis Data Streams ou o Amazon Kinesis Data Firehose. Para obter informações sobre como configurar fluxos de eventos, consulte Transmitir dados de eventos do aplicativo por meio do Kinesis e do Firehose usando o Amazon Pinpoint.

Consultar componentes e parâmetros para métricas no Amazon Pinpoint

Para consultar os dados de uma métrica, você envia uma solicitação get para o recurso de métricas apropriado da API do Amazon Pinpoint. Na solicitação, você define sua consulta usando parâmetros compatíveis para os seguintes componentes de consulta:

  • Projeto: especifique um projeto fornecendo o ID do projeto como o valor do parâmetro application-id. Esse parâmetro é necessário para todas as métricas.

  • Campanha: especifique uma campanha fornecendo o ID da campanha como o valor do parâmetro campaign-id. Esse parâmetro é obrigatório somente para métricas de campanha.

  • Jornada: especifique uma jornada fornecendo o ID da jornada como o valor do parâmetro journey-id. Esse parâmetro é necessário somente para métricas de engajamento e execução da jornada e métricas de execução de atividades da jornada.

  • Atividade da jornada: especifique uma atividade da jornada fornecendo o ID da atividade da jornada como o valor do parâmetro journey-activity-id. Esse parâmetro é obrigatório somente para métricas de execução de atividades da jornada.

  • Intervalo de datas: para filtrar opcionalmente os dados por intervalo de datas, forneça a primeira e última data e hora do intervalo de datas usando os parâmetros de hora inicial e final compatíveis. Os valores devem estar no formato ISO 8601 estendido e usar o Tempo Universal Coordenado (UTC), por exemplo, 2019-07-19T20:00:00Z para 20h UTC 19 de julho de 2019.

    Os intervalos de datas são inclusivos e devem estar limitados a 31 dias ou menos. Adicionalmente, a primeira data e hora devem ser inferiores a 90 dias a partir do dia atual. Se você não especificar um intervalo de datas, o Amazon Pinpoint retornará os dados para os 31 dias corridos anteriores. Os parâmetros de intervalo de datas são suportados por todas as métricas, exceto métricas de execução de jornada e métricas de execução de atividades da jornada.

  • Métrica: especifique a métrica fornecendo o nome da métrica como o valor do parâmetro kpi-name. Esse valor descreve a métrica associada e consiste em dois ou mais termos, que são compostos por caracteres alfanuméricos minúsculos, separados por um hífen. Os exemplos são email-open-rate e successful-delivery-rate. Esse parâmetro é necessário para todas as métricas, exceto métricas de execução de jornada e métricas de execução de atividades da jornada. Para obter uma lista completa das métricas compatíveis e o valor de kpi-name a ser usado para cada uma, consulte Métricas padrão para projetos, campanhas e jornadas.

Depois de enviar sua consulta, o Amazon Pinpoint retorna os resultados dela em uma resposta JSON. Na resposta, a estrutura dos resultados varia dependendo da métrica consultada.

Algumas métricas fornecem apenas um valor, por exemplo, o número de mensagens que foram entregues por uma campanha. Outras métricas fornecem vários valores e normalmente agrupam esses valores por um campo relevante, por exemplo, o número de mensagens que foram entregues em cada execução de uma campanha, agrupado por execução da campanha. Se uma métrica fornecer e agrupar vários valores, a resposta JSON incluirá um campo que indica qual campo foi usado para agrupar os dados. Para saber mais sobre a estrutura dos resultados da consulta, consulte Usar resultados da consulta JSON.