**Aviso de fim do suporte:** em 30 de outubro de 2026, AWS encerrará o suporte para o Amazon Pinpoint. Após 30 de outubro de 2026, você não poderá mais acessar o console do Amazon Pinpoint nem seus recursos (endpoints, segmentos, campanhas, jornadas e analytics). Para obter mais informações, consulte [Fim do suporte do Amazon Pinpoint](https://docs.aws.amazon.com/console/pinpoint/migration-guide). **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](event-streams.md).
## 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](analytics-standard-metrics.md).
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](analytics-query-results.md).
# Políticas do IAM para consulta de dados de análise do Amazon Pinpoint
Ao usar a API do Amazon Pinpoint, você pode consultar dados analíticos para um subconjunto de métricas padrão, também chamadas de *indicadores-chave de desempenho (KPIs)* que se aplicam aos projetos, campanhas e jornadas do Amazon Pinpoint. Essas métricas podem ajudá-lo a monitorar e avaliar o desempenho de projetos, campanhas e jornadas.
Para gerenciar o acesso a esses dados, você pode criar políticas AWS Identity and Access Management (IAM) que definam permissões para funções do IAM ou usuários autorizados a acessar os dados. Para oferecer suporte ao controle granular de acesso a esses dados, o Amazon Pinpoint fornece várias ações distintas que você pode especificar em políticas do IAM. Há uma ação distinta para visualizar dados analíticos no console do Amazon Pinpoint (`mobiletargeting:GetReports`) e há outras ações para acessar dados analíticos programaticamente usando a API do Amazon Pinpoint.
Para criar políticas do IAM que gerenciam o acesso aos dados de análise, você pode usar a Console de gerenciamento da AWS API AWS CLI, a ou a API IAM. Observe que a guia **Editor visual** no Console de gerenciamento da AWS atualmente não inclui ações para visualização ou consulta de dados analíticos do Amazon Pinpoint. No entanto, você pode adicionar as ações necessárias às políticas do IAM manualmente usando a guia **JSON** no console.
Por exemplo, a política a seguir permite acesso programático a todos os dados analíticos de todos os seus projetos, campanhas e jornadas em todas as AWS regiões:
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "QueryAllAnalytics",
"Effect": "Allow",
"Action": [
"mobiletargeting:GetApplicationDateRangeKpi",
"mobiletargeting:GetCampaignDateRangeKpi",
"mobiletargeting:GetJourneyDateRangeKpi",
"mobiletargeting:GetJourneyExecutionMetrics",
"mobiletargeting:GetJourneyExecutionActivityMetrics"
],
"Resource": [
"arn:aws:mobiletargeting:*:111122223333:apps/*/kpis/*",
"arn:aws:mobiletargeting:*:111122223333:apps/*/campaigns/*/kpis/*",
"arn:aws:mobiletargeting:*:111122223333:apps/*/journeys/*/kpis/*",
"arn:aws:mobiletargeting:*:111122223333:apps/*/journeys/*/execution-metrics",
"arn:aws:mobiletargeting:*:111122223333:apps/*/journeys/*/activities/*/execution-metrics"
]
}
]
}
```
------
Onde *accountId* está o ID AWS da sua conta.
No entanto, como prática recomendada, você deve criar políticas que sigam o princípio de *privilégio mínimo*. Em outras palavras, é necessário criar políticas que incluem somente as permissões necessárias para executar uma tarefa específica. Para apoiar essa prática e implementar um controle mais granular, você pode restringir o acesso programático aos dados analíticos somente para um projeto específico em uma AWS região específica, por exemplo:
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "QueryProjectAnalytics",
"Effect": "Allow",
"Action": [
"mobiletargeting:GetApplicationDateRangeKpi",
"mobiletargeting:GetCampaignDateRangeKpi",
"mobiletargeting:GetJourneyDateRangeKpi",
"mobiletargeting:GetJourneyExecutionMetrics",
"mobiletargeting:GetJourneyExecutionActivityMetrics"
],
"Resource": [
"arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/kpis/*",
"arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/campaigns/*/kpis/*",
"arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/*/kpis/*",
"arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/*/execution-metrics",
"arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/*/activities/*/execution-metrics"
]
}
]
}
```
------
Em que:
+ *region*é o nome da AWS região que hospeda o projeto.
+ *accountId*é o ID AWS da sua conta.
+ *projectId*é o identificador do projeto ao qual você deseja fornecer acesso.
Da mesma forma, a política de exemplo a seguir permite acesso programático aos dados analíticos apenas para uma campanha específica:
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "QueryCampaignAnalytics",
"Effect": "Allow",
"Action": "mobiletargeting:GetCampaignDateRangeKpi",
"Resource": "arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/campaigns/campaignId/kpis/*"
}
]
}
```
------
Em que:
+ *region*é o nome da AWS região que hospeda o projeto.
+ *accountId*é sua Conta da AWS identidade.
+ *projectId*é o identificador do projeto associado à campanha.
+ *campaignId*é o identificador da campanha à qual você deseja fornecer acesso.
E a política de exemplo a seguir permite o acesso programático a todos os dados analíticos, tanto de engajamento quanto de execução, para uma determinada jornada e as atividades que compõem essa jornada:
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "QueryJourneyAnalytics",
"Effect": "Allow",
"Action": [
"mobiletargeting:GetJourneyDateRangeKpi",
"mobiletargeting:GetJourneyExecutionMetrics",
"mobiletargeting:GetJourneyExecutionActivityMetrics"
],
"Resource": [
"arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/journeyId/kpis/*",
"arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/journeyId/execution-metrics",
"arn:aws:mobiletargeting:us-east-1:111122223333:apps/projectId/journeys/journeyId/activities/*/execution-metrics"
]
}
]
}
```
------
Em que:
+ *region*é o nome da AWS região que hospeda o projeto.
+ *accountId*é o ID AWS da sua conta.
+ *projectId*é o identificador do projeto associado à jornada.
+ *journeyId*é o identificador da viagem à qual você deseja fornecer acesso.
Para obter uma lista completa de ações da API do Amazon Pinpoint que você pode usar em políticas do IAM, consulte [Ações do Amazon Pinpoint para políticas do IAM](permissions-actions.md). Para obter informações detalhadas sobre como criar e gerenciar políticas do IAM, consulte o [Guia do usuário do IAM](https://docs.aws.amazon.com/IAM/latest/UserGuide/).
# Métricas padrão que se aplicam a projetos, campanhas e jornadas do Amazon Pinpoint
Você pode usar o Amazon Pinpoint Analytics APIs para consultar dados analíticos de um subconjunto de métricas padrão que se aplicam aos projetos, campanhas e jornadas do Amazon Pinpoint. 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 projetos, campanhas e jornadas.
O Amazon Pinpoint fornece acesso programático aos dados analíticos para diversos tipos de métricas padrão:
+ **Métricas de aplicativo**: essas métricas fornecem informações sobre tendências para todas as campanhas e mensagens transacionais associadas a um projeto, também conhecido como um *aplicativo*. Por exemplo, você pode usar uma métrica de aplicativo para ver um detalhamento do número de mensagens que foram abertas pelos destinatários para cada campanha associada a um projeto.
+ **Métricas de campanha**: essas métricas fornecem informações sobre o desempenho de campanhas individuais. Por exemplo, você pode usar uma métrica de campanha para determinar para quantos endpoints uma mensagem de campanha foi enviada ou quantas dessas mensagens foram entregues nos endpoints desejados.
+ **Métricas de engajamento de jornada**: essas métricas fornecem informações sobre o desempenho de jornadas individuais. Por exemplo, você pode usar uma métrica de engajamento de jornada para obter um detalhamento do número de mensagens que foram abertas pelos participantes em cada atividade de uma jornada.
+ **Métricas de execução de jornada**: essas métricas fornecem informações sobre as tendências de participação para jornadas individuais. Por exemplo, você pode usar uma métrica de execução de jornada para determinar quantos participantes iniciaram uma jornada.
+ **Métricas de execução de atividades da jornada**: essas métricas fornecem informações sobre as tendências de participação para atividades individuais de uma jornada. Por exemplo, você pode usar uma métrica de execução de atividades da jornada para determinar quantos participantes iniciaram uma atividade e quantos participantes concluíram cada caminho em uma atividade.
Os tópicos desta seção listam e descrevem as métricas individuais que você pode consultar para cada tipo de métrica.
**Topics**
+ [Métricas da aplicação Amazon Pinpoint para campanhas](application-metrics-campaigns.md)
+ [Métricas de aplicação Amazon Pinpoint para mensagens de e-mail transacionais](application-metrics-txn-email.md)
+ [Métricas da aplicação Amazon Pinpoint para mensagens SMS transacionais](application-metrics-txn-sms.md)
+ [Métricas da campanha do Amazon Pinpoint](campaign-metrics.md)
+ [Métricas de engajamento da jornada do Amazon Pinpoint](journey-metrics-engagement-email.md)
+ [Métricas de execução da jornada do Amazon Pinpoint](journey-metrics-execution.md)
+ [Métricas de execução da atividade da jornada do Amazon Pinpoint](journey-metrics-activity-execution.md)
+ [Métricas de execução da campanha e jornada do Amazon Pinpoint](journey-run-metrics-activity-execution.md)
# Métricas da aplicação Amazon Pinpoint para campanhas
A tabela a seguir lista e descreve as métricas de aplicativo padrão que você pode consultar para avaliar o desempenho de todas as campanhas associadas a um projeto do Amazon Pinpoint. Para consultar dados dessas métricas, use o recurso [Métricas de aplicativo](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) da API do Amazon Pinpoint. A coluna **kpi-name** da tabela indica o valor a ser usado para o parâmetro `kpi-name` na consulta.
| Métrica | Kpi-name | Description |
| --- | --- | --- |
| Taxa de entrega | `successful-delivery-rate` | Para todas as campanhas que estão associadas a um projeto, a porcentagem de mensagens que foram entregues aos destinatários. Essa métrica é calculada como o número de mensagens que foram enviadas por todas as campanhas para um projeto e entregues aos destinatários, dividido pelo número de mensagens que foram enviadas por todas essas campanhas. |
| Taxa de entrega, agrupada por data | `successful-delivery-rate-grouped-by-date` | Para todas as campanhas que estão associadas a um projeto, a porcentagem de mensagens que foram entregues aos destinatários para cada dia no intervalo de datas especificado. Essa métrica é calculada como o número de mensagens que foram enviadas por todas as campanhas para um projeto e entregue aos destinatários, dividido pelo número de mensagens que foram enviadas por todas essas campanhas, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Taxa de e-mails abertos | `email-open-rate` | Para todas as campanhas que estão associadas a um projeto, a porcentagem de mensagens de e-mail que foram abertas pelos destinatários. Essa métrica é calculada como o número de mensagens de e-mail que foram enviadas por todas as campanhas para um projeto e abertas pelos destinatários, dividido pelo número de mensagens de e-mail que foram enviadas por todas essas campanhas e entregues aos destinatários. |
| Taxa de abertura de e-mail, agrupados por campanha | `email-open-rate-grouped-by-campaign` | Para cada campanha que está associada a um projeto, a porcentagem de mensagens de e-mail que foram abertas pelos destinatários. Essa métrica é calculada como o número de mensagens de e-mail que foram enviadas por uma campanha e aberta pelos destinatários, dividido pelo número de mensagens de e-mail que foram enviadas pela campanha e entregues aos destinatários. Os resultados da consulta para essa métrica são agrupados por ID de campanha (`CampaignId`), que é uma string que identifica exclusivamente uma campanha. |
| Entregas de endpoint | `unique-deliveries` | Para todas as campanhas associadas a um projeto, o número de endpoints exclusivos para os quais as mensagens foram enviadas. |
| Entregas de endpoint, agrupadas por campanha | `unique-deliveries-grouped-by-campaign` | Para cada campanha associada a um projeto, o número de endpoints exclusivos para os quais as mensagens foram enviadas. Os resultados da consulta para essa métrica são agrupados por ID de campanha (`CampaignId`), que é uma string que identifica exclusivamente uma campanha. |
| Entregas de endpoint, agrupadas por data | `unique-deliveries-grouped-by-date` | Para todas as campanhas associadas a um projeto, o número de endpoints exclusivos para os quais as mensagens foram enviadas, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Mensagens entregues, agrupadas por campanha | `successful-deliveries-grouped-by-campaign` | Para cada campanha que está associada a um projeto, o número de mensagens que foram entregues aos destinatários. Essa métrica é calculada como o número de mensagens que foram enviadas por uma campanha, menos o número de mensagens que foram enviadas pela campanha e não puderam ser entregues aos destinatários devido a uma devolução definitiva. Os resultados da consulta para essa métrica são agrupados por ID de campanha (`CampaignId`), que é uma string que identifica exclusivamente uma campanha. |
| Taxa de abertura de push | `push-open-rate` | Para todas as campanhas que estão associadas a um projeto, a porcentagem de notificações por push que foram abertas pelos destinatários. Essa métrica é calculada como o número de notificações por push que foram enviadas por todas as campanhas para um projeto e abertas pelos destinatários, dividido pelo número de notificações por push que foram enviadas por todas essas campanhas e entregues aos destinatários. |
| Taxa de abertura de notificações por push, agrupada por campanha | `push-open-rate-grouped-by-campaign` | Para cada campanha que está associada a um projeto, a porcentagem de notificações por push que foram abertas pelos destinatários. Essa métrica é calculada como o número de notificações por push que foram enviadas por uma campanha e abertas pelos destinatários, dividido pelo número de notificações por push que foram enviadas pela campanha e entregues aos destinatários. Os resultados da consulta para essa métrica são agrupados por ID de campanha (`CampaignId`), que é uma string que identifica exclusivamente uma campanha. |
# Métricas de aplicação Amazon Pinpoint para mensagens de e-mail transacionais
A tabela a seguir lista e descreve métricas de aplicativo padrão que você pode consultar para monitorar as tendências de todas as mensagens de e-mail transacionais associadas a um projeto do Amazon Pinpoint. Para consultar dados dessas métricas, use o recurso [Métricas de aplicativo](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) da API do Amazon Pinpoint. A coluna **kpi-name** da tabela indica o valor a ser usado para o parâmetro `kpi-name` na consulta.
Observe que essas métricas não fornecem dados sobre mensagens de e-mail que foram enviadas por campanhas. Elas fornecem dados somente sobre mensagens de e-mail transacionais. Para consultar dados de mensagens que foram enviadas por uma ou mais campanhas, use uma [métrica de campanha](campaign-metrics.md) ou uma [métrica de aplicativo para campanhas](application-metrics-campaigns.md).
| Métrica | Kpi-name | Description |
| --- | --- | --- |
| Cliques | `txn-emails-clicked` | O número de vezes que os destinatários clicaram em links nas mensagens: Se um único destinatário clicou em vários links em uma mensagem, ou clicou no mesmo link mais de uma vez, cada clique será incluído na contagem. |
| Cliques, agrupados por data | `txn-emails-clicked-grouped-by-date` | O número de vezes que os destinatários clicaram em links nas mensagens, para cada dia no intervalo de datas especificado. Se um único destinatário clicou em vários links em uma mensagem, ou clicou no mesmo link mais de uma vez, cada clique será incluído na contagem. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Taxa de reclamações | `txn-emails-complaint-rate` | A porcentagem de mensagens que foram relatadas pelos destinatários como e-mails não solicitados ou indesejados. Essa métrica é calculada como o número de mensagens que foram relatadas pelos destinatários como e-mails não solicitados ou indesejados, dividido pelo número de mensagens que foram enviadas. |
| Taxa de reclamações, agrupada por data | `txn-emails-complaint-rate-grouped-by-date` | A porcentagem de mensagens que foram relatadas pelos destinatários como e-mails não solicitados ou indesejados, para cada dia no intervalo de datas especificado. Essa métrica é calculada como o número de mensagens que foram relatadas pelos destinatários como e-mails não solicitados ou indesejados, dividido pelo número de mensagens que foram enviadas, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Reclamações | `txn-emails-with-complaints` | O número de mensagens que foram relatadas pelos destinatários como e-mail não solicitado ou indesejado. |
| Reclamações, agrupadas por data | `txn-emails-with-complaints-grouped-by-date` | O número de mensagens que foram relatadas pelos destinatários como e-mail não solicitado ou indesejado, para cada dia no intervalo de datas especificado.Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Entregas | `txn-emails-delivered` | O número de mensagens entregues aos destinatários: Essa métrica é calculada como o número de mensagens que foram enviadas, menos o número de mensagens que não puderam ser entregues devido a uma devolução flexível ou definitiva ou porque foram rejeitadas. Uma mensagem será rejeitada se o Amazon Pinpoint determinar que a mensagem contém malware. O Amazon Pinpoint não tenta enviar mensagens rejeitadas. |
| Entregas, agrupadas por data | `txn-emails-delivered-grouped-by-date` | O número de mensagens que foram entregues aos destinatários, para cada dia no intervalo de datas especificado. Essa métrica é calculada como o número de mensagens que foram enviadas, menos o número de mensagens que não puderam ser entregues devido a uma devolução flexível ou definitiva ou porque foram rejeitadas, para cada dia no intervalo de datas especificado. Uma mensagem será rejeitada se o Amazon Pinpoint determinar que a mensagem contém malware. O Amazon Pinpoint não tenta enviar mensagens rejeitadas. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Taxa de entrega | `txn-emails-delivery-rate` | A porcentagem de mensagens que foram entregues aos destinatários. Essa métrica é calculada como o número de mensagens que foram enviadas e entregues aos destinatários, dividido pelo número de mensagens que foram enviadas. |
| Taxa de entrega, agrupada por data | `txn-emails-delivery-rate-grouped-by-date` | A porcentagem de mensagens que foram entregues aos destinatários, para cada dia no intervalo de datas especificado. Essa métrica é calculada como o número de mensagens que foram enviadas e entregues aos destinatários, dividido pelo número de mensagens que foram enviadas, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Devoluções definitivas | `txn-emails-hard-bounced` | O número de mensagens que não puderam ser entregues aos destinatários devido a uma devolução definitiva. Uma devolução definitiva ocorre quando um problema persistente impede que uma mensagem seja entregue, por exemplo, se o endereço de e-mail do destinatário não existir. |
| Devoluções definitivas, agrupadas por data | `txn-emails-hard-bounced-grouped-by-date` | O número de mensagens que não puderam ser entregues aos destinatários devido a uma devolução definitiva, para cada dia no intervalo de datas especificado. Uma devolução definitiva ocorre quando um problema persistente impede que uma mensagem seja entregue, por exemplo, se o endereço de e-mail do destinatário não existir. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Aberturas | `txn-emails-opened` | O número de mensagens que foram abertas pelos destinatários. |
| Aberturas, agrupadas por data | `txn-emails-opened-grouped-by-date` | O número de mensagens que foram abertas pelos destinatários, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Envios | `txn-emails-sent` | O número de mensagens enviadas. |
| Envios, agrupados por data | `txn-emails-sent-grouped-by-date` | O número de mensagens que foram enviadas, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Devoluções flexíveis | `txn-emails-soft-bounced` | O número de mensagens que não puderam ser entregues aos destinatários devido a uma devolução flexível. Uma devolução flexível ocorre se um problema temporário impede que uma mensagem seja entregue, por exemplo, se a caixa de entrada do destinatário está cheia ou o servidor receptor está temporariamente indisponível. |
| Devoluções flexíveis, agrupadas por data | `txn-emails-soft-bounced-grouped-by-date` | O número de mensagens que não puderam ser entregues aos destinatários devido a uma devolução flexível, para cada dia no intervalo de datas especificado. Uma devolução flexível ocorre se um problema temporário impede que uma mensagem seja entregue, por exemplo, se a caixa de entrada do destinatário está cheia ou o servidor receptor está temporariamente indisponível. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Eventos exclusivos de clique de usuário | `txn-emails-unique-clicks` | O número de destinatários exclusivos (endpoints) que clicaram em links nas mensagens. Ao contrário da métrica **Clicks (Cliques)**, essa métrica informa o número de destinatários exclusivos que clicaram em links, e não o número de eventos de clique que ocorreram. Por exemplo, se um único destinatário clicou em vários links na mesma mensagem ou clicou no mesmo link mais de uma vez, essa métrica relatará apenas um evento de clique para esse destinatário. |
| Eventos exclusivos de clique de usuário, agrupados por data | `txn-emails-unique-clicks-grouped-by-date` | O número de destinatários exclusivos (endpoints) que clicaram em links em mensagens, para cada dia no intervalo de datas especificado. Ao contrário da métrica **Clicks, grouped by date (Cliques, agrupados por data)** essa métrica informa o número de destinatários exclusivos que clicaram em links, e não o número de eventos de clique que ocorreram. Por exemplo, se um único destinatário clicou em vários links na mesma mensagem ou clicou no mesmo link mais de uma vez, essa métrica relatará apenas um evento de clique para esse destinatário. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Eventos de abertura de usuário exclusivos | `txn-emails-unique-opens` | O número de destinatários exclusivos (endpoints) que abriram mensagens. Ao contrário da métrica **Opens (Aberturas)**, essa métrica informa o número de destinatários exclusivos que abriram mensagens, não o número de eventos de abertura que ocorreram. Por exemplo, se um único destinatário abrir a mesma mensagem várias vezes, essa métrica relatará apenas um evento de abertura para esse destinatário. |
| Eventos de abertura de usuário exclusivos, agrupados por data | `txn-emails-unique-opens-grouped-by-date` | O número de destinatários exclusivos (endpoints) que abriram mensagens, para cada dia no intervalo de datas especificado. Ao contrário da métrica **Opens, grouped by date (Aberturas, agrupadas por data)**, essa métrica informa o número de destinatários exclusivos que abriram mensagens, não o número de eventos de abertura que ocorreram. Por exemplo, se um único destinatário abrir a mesma mensagem várias vezes, essa métrica relatará apenas um evento de abertura para esse destinatário. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
# Métricas da aplicação Amazon Pinpoint para mensagens SMS transacionais
A tabela a seguir lista e descreve métricas de aplicativo padrão que você pode consultar para monitorar as tendências de todas as mensagens SMS transacionais associadas a um projeto do Amazon Pinpoint. Para consultar dados dessas métricas, use o recurso [Métricas de aplicativo](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) da API do Amazon Pinpoint. A coluna **kpi-name** da tabela indica o valor a ser usado para o parâmetro `kpi-name` na consulta.
Observe que essas métricas não fornecem dados sobre mensagens SMS que foram enviadas por campanhas. Elas fornecem dados somente sobre mensagens SMS transacionais. Para consultar dados de mensagens que foram enviadas por uma ou mais campanhas, use uma [métrica de campanha](campaign-metrics.md) ou uma [métrica de aplicativo para campanhas](application-metrics-campaigns.md).
| Métrica | Kpi-name | Description |
| --- | --- | --- |
| Preço médio por mensagem, agrupado por país | `txn-sms-average-price-grouped-by-country` | O custo médio para o envio de cada mensagem, para cada país ou região de destino das mensagens. Esse preço é mostrado em milésimos de um centavo dos Estados Unidos. Por exemplo, se o valor desse atributo for 645, cobraremos 0,645 para enviar a mensagem (645/1000 = 0,645 = 0,00645). Essa métrica é calculada como o custo total de todas as mensagens enviadas aos destinatários em cada país ou região, dividido pelo número de mensagens enviadas aos destinatários em cada um desses países e regiões. Os resultados da consulta dessa métrica são agrupados por país ou região, no formato ISO 3166-1 alfa-2. |
| Preço médio por parte da mensagem, agrupado por país | `txn-sms-average-price-by-parts-grouped-by-country` | O custo médio para o envio de cada parte da mensagem, para cada país ou região de destino das mensagens. Uma parte da mensagem é uma parte de uma mensagem SMS. Esse preço é mostrado em milésimos de um centavo dos Estados Unidos. Por exemplo, se o valor desse atributo for 645, cobraremos 0,645 para enviar a mensagem (645/1000 = 0,645 = 0,00645). Essa métrica é calculada como o custo total de todas as partes das mensagens enviadas aos destinatários em cada país ou região, dividido pelo número de partes das mensagens enviadas aos destinatários em cada um desses países e regiões. Os resultados da consulta dessa métrica são agrupados por país ou região, no formato ISO 3166-1 alfa-2. |
| Entregas | `txn-sms-delivered` | O número de mensagens entregues aos destinatários: |
| Entregas, agrupadas por país | `txn-sms-delivered-grouped-by-country` | O número de mensagens que foram entregues aos destinatários, para cada país ou região de destino das mensagens. Os resultados da consulta dessa métrica são agrupados por país ou região, no formato ISO 3166-1 alfa-2. |
| Entregas, agrupadas por data | `txn-sms-delivered-grouped-by-date` | O número de mensagens que foram entregues aos destinatários, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Erros de entrega | `txn-sms-error-distribution` | O número de vezes que um erro ocorreu durante a tentativa de entrega das mensagens, para cada tipo de erro ocorrido. Os resultados da consulta dessa métrica são agrupados por código de erro, para cada tipo de erro ocorrido. |
| Taxa de entrega | `txn-sms-delivery-rate` | A porcentagem de mensagens que foram entregues aos destinatários. Essa métrica é calculada como o número de mensagens que foram enviadas e entregues aos destinatários, dividido pelo número de mensagens que foram enviadas. |
| Taxa de entrega, agrupada por data | `txn-sms-delivery-rate-grouped-by-date` | A porcentagem de mensagens que foram entregues aos destinatários, para cada dia no intervalo de datas especificado. Essa métrica é calculada como o número de mensagens que foram enviadas e entregues aos destinatários, dividido pelo número de mensagens que foram enviadas, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Partes da mensagem entregues | `txn-sms-delivered-by-parts` | O número de partes das mensagens entregues. Uma *parte da mensagem* é uma parte de uma mensagem SMS. Se uma mensagem SMS contiver mais caracteres do que o permitido pelo protocolo SMS, o Amazon Pinpoint dividirá a mensagem em quantas partes forem necessárias para enviá-la ao destinatário. |
| Partes da mensagem entregues, agrupadas por país | `txn-sms-delivered-by-parts-grouped-by-country` | O número de mensagens que foram entregues aos destinatários, para cada país ou região de destino das mensagens. Uma *parte da mensagem* é uma parte de uma mensagem SMS. Os resultados da consulta dessa métrica são agrupados por país ou região, no formato ISO 3166-1 alfa-2. |
| Partes da mensagem enviadas | `txn-sms-sent-by-parts` | O número de partes das mensagens enviadas. Uma *parte da mensagem* é uma parte de uma mensagem SMS. Se uma mensagem SMS contiver mais caracteres do que o permitido pelo protocolo SMS, o Amazon Pinpoint dividirá a mensagem em quantas partes forem necessárias para enviá-la ao destinatário. |
| Partes da mensagem enviadas, agrupadas por país | `txn-sms-sent-by-parts-grouped-by-country` | O número de partes das mensagens que foram enviadas, para cada país ou região de destino das mensagens. Uma *parte da mensagem* é uma parte de uma mensagem SMS. Os resultados da consulta dessa métrica são agrupados por país ou região, no formato ISO 3166-1 alfa-2. |
| Mensagens enviadas | `txn-sms-sent` | O número de mensagens enviadas. |
| Mensagens entregues, agrupadas por país | `txn-sms-sent-grouped-by-country` | O número de mensagens que foram enviadas, para cada país ou região de destino das mensagens. Os resultados da consulta dessa métrica são agrupados por país ou região, no formato ISO 3166-1 alfa-2. |
| Mensagens enviadas, agrupadas por país | `txn-sms-sent-grouped-by-date` | O número de mensagens que foram enviadas, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Preço total, agrupado por país | `txn-sms-total-price-grouped-by-country` | O custo total do envio das mensagens, para cada país ou região de destino das mensagens. Esse preço é mostrado em milésimos de um centavo dos Estados Unidos. Por exemplo, se o valor desse atributo for 645, cobraremos 0,645 para enviar a mensagem (645/1000 = 0,645 = 0,00645). Os resultados da consulta dessa métrica são agrupados por país ou região, no formato ISO 3166-1 alfa-2. |
# Métricas da campanha do Amazon Pinpoint
A tabela a seguir lista e descreve métricas de campanha padrão que você pode consultar para avaliar o desempenho de uma campanha individual. Para consultar dados para essas métricas, use o recurso [Métricas de campanha](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html) da API do Amazon Pinpoint. A coluna **kpi-name** da tabela indica o valor a ser usado para o parâmetro `kpi-name` na consulta.
| Métrica | Kpi-name | Description |
| --- | --- | --- |
| Taxa de devolução | `hard-bounce-rate` | Para todas as execuções de campanha, a porcentagem de mensagens de e-mail que não puderam ser entregues aos destinatários. Essa métrica calcula apenas devoluções definitivas, ou seja, o endereço de e-mail do destinatário tinha um problema permanente que impediu a entrega da mensagem. Essa métrica é calculada como o número de mensagens de e-mail devolvidas que foram enviadas por todas as execuções de campanha, dividido pelo número de mensagens de e-mail que foram enviadas por todas essas execuções de campanha. |
| Taxa de devolução, agrupada por execução de campanha | `hard-bounce-rate-grouped-by-campaign-activity` | Para cada execução de campanha, a porcentagem de mensagens de e-mail que não puderam ser entregues ao destinatários. Essa métrica calcula apenas devoluções definitivas, ou seja, o endereço de e-mail do destinatário tinha um problema permanente que impediu a entrega da mensagem. Essa métrica é calculada como o número de mensagens de e-mail devolvidas que foram enviadas por uma execução de campanha, dividido pelo número de mensagens de e-mail que foram enviadas pela execução de campanha. Os resultados da consulta para essa métrica são agrupados por ID de atividade de campanha (`CampaignActivityId`), que é uma string que identifica exclusivamente uma execução de campanha. |
| Taxa de entrega | `successful-delivery-rate` | Para todas as execuções de campanha, a porcentagem de mensagens que foram entregues aos destinatários. Essa métrica é calculado como o número de mensagens que foram enviadas por todas as execuções de campanha e entregues aos destinatários, dividido pelo número de mensagens que foram enviados por todas essas execuções de campanha. |
| Taxa de entrega, agrupada por execução de campanha | `successful-delivery-rate-grouped-by-campaign-activity` | Para cada execução de campanha, a porcentagem de mensagens que foram entregues aos destinatários. Essa métrica é calculado como o número de mensagens que foram enviadas por uma execução de campanha e entregues aos destinatários, dividido pelo número de mensagens que foram enviadas pela execução de campanha. Os resultados da consulta para essa métrica são agrupados por ID de atividade de campanha (`CampaignActivityId`), que é uma string que identifica exclusivamente uma execução de campanha. |
| Taxa de entrega, agrupada por data | `successful-delivery-rate-grouped-by-date` | Para todas as execuções de campanha, a porcentagem de mensagens que foram entregues aos destinatários para cada dia no intervalo de datas especificado. Essa métrica é calculada como o número de mensagens que foram enviadas por todas as execuções de campanha e entregues aos destinatários, dividido pelo número de mensagens que foram enviadas por todas essas execuções de campanha, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Taxa de e-mails abertos | `email-open-rate` | Para todas as execuções de campanha, a porcentagem de mensagens de e-mail que foram abertas pelos destinatários.Essa métrica é calculada como o número de mensagens de e-mail que foram enviadas por todas as execuções de campanha e abertas pelos destinatários, dividido pelo número de mensagens de e-mail que foram enviadas por todas essas execuções de campanha e entregues aos destinatários. |
| Taxa de abertura de e-mail, agrupada por execução de campanha | `email-open-rate-grouped-by-campaign-activity` | Para cada execução de campanha, a porcentagem de mensagens de e-mail que foram abertas pelos destinatários. Essa métrica é calculado como o número de mensagens de e-mail que foram enviadas por uma execução de campanha e abertas pelos destinatários, dividido pelo número de mensagens de e-mail que foram enviadas pela execução de campanha e entregues aos destinatários. Os resultados da consulta para essa métrica são agrupados por ID de atividade de campanha (`CampaignActivityId`), que é uma string que identifica exclusivamente uma execução de campanha. |
| E-mails abertos, agrupados por execução de campanha | `direct-email-opens-grouped-by-campaign-activity` | Para cada execução de campanha, o número de mensagens de e-mail que foram abertas pelos destinatários. Os resultados da consulta para essa métrica são agrupados por ID de atividade de campanha (`CampaignActivityId`), que é uma string que identifica exclusivamente uma execução de campanha. |
| Entregas de endpoint | `unique-deliveries` | Para todas as execuções de campanha, o número de endpoints exclusivos aos quais as mensagens foram entregues. |
| Entregas de endpoint, agrupadas por execução de campanha | `unique-deliveries-grouped-by-campaign-activity` | Para cada execução de campanha, o número de endpoints exclusivos aos quais as mensagens foram entregues. Os resultados da consulta para essa métrica são agrupados por ID de atividade de campanha (`CampaignActivityId`), que é uma string que identifica exclusivamente uma execução de campanha. |
| Entregas de endpoint, agrupadas por data | `unique-deliveries-grouped-by-date` | Para todas as execuções de campanha, o número de endpoints exclusivos aos quais as mensagens foram entregues, para cada dia no intervalo de datas especificado. Os resultados da consulta para essa métrica são agrupados por dia corrido, no formato estendido ISO 8601. |
| Links clicados, agrupados por execução de campanha | `clicks-grouped-by-campaign-activity` | Para cada execução de campanha, o número de vezes que os destinatários clicaram nos links na mensagem de e-mail. Se um único destinatário clicou em vários links na mensagem, ou clicou no mesmo link mais de uma vez, cada clique será incluído na contagem. Os resultados da consulta para essa métrica são agrupados por ID de atividade de campanha (`CampaignActivityId`), que é uma string que identifica exclusivamente uma execução de campanha. |
| Mensagens entregues, agrupadas por execução de campanha | `successful-deliveries-grouped-by-campaign-activity` | Para cada execução de campanha, o número de mensagens que foram entregues aos destinatários. Essa métrica é calculada como o número de mensagens que foram enviadas por uma execução de campanha, menos o número de mensagens que não puderam ser entregues aos destinatários da execução devido a uma devolução definitiva. Os resultados da consulta para essa métrica são agrupados por ID de atividade de campanha (`CampaignActivityId`), que é uma string que identifica exclusivamente uma execução de campanha. |
| Mensagens enviadas, agrupadas por execução de campanha | `attempted-deliveries-grouped-by-campaign-activity` | Para cada execução de campanha, o número de mensagens que foram enviadas. Os resultados da consulta para essa métrica são agrupados por ID de atividade de campanha (`CampaignActivityId`), que é uma string que identifica exclusivamente uma execução de campanha. |
| Taxa de abertura de push | `push-open-rate` | Para todas as execuções de campanha, a porcentagem de notificações por push que foram abertas pelos destinatários. Essa métrica é calculada como o número de notificações por push que foram enviadas por todas as execuções de campanha e abertas pelos destinatários, dividido pelo número de notificações por push que foram enviadas por todas essas execuções de campanha e entregues aos destinatários. |
| Taxa de abertura de notificações por push, agrupada por execução de campanha | `push-open-rate-grouped-by-campaign-activity` | Para cada execução de campanha, a porcentagem de notificações por push que foram abertas pelos destinatários. Essa métrica é calculada como o número de notificações por push que foram enviadas por uma execução de campanha e abertas pelos destinatários, dividido pelo número de notificações por push que foram enviadas pela execução de campanha e entregues aos destinatários. Os resultados da consulta para essa métrica são agrupados por ID de atividade de campanha (`CampaignActivityId`), que é uma string que identifica exclusivamente uma execução de campanha. |
| Total de notificações por push abertas, agrupadas por execução de campanha | `direct-push-opens-grouped-by-campaign-activity` | Para cada execução de campanha, o número de notificações por push que foram abertas pelos destinatários. Os resultados da consulta para essa métrica são agrupados por ID de atividade de campanha (`CampaignActivityId`), que é uma string que identifica exclusivamente uma execução de campanha. |
| Total SMS spend (Total de SMS gastas) | sms-spend | Para todas as campanhas, a quantidade total de dinheiro, em milésimos de centavos, gasto no envio de SMS. |
# Métricas de engajamento da jornada do Amazon Pinpoint
A tabela a seguir lista e descreve métricas de engajamento de jornada padrão que você pode consultar para monitorar tendências de todas as mensagens de e-mail enviadas por uma jornada do Amazon Pinpoint. Para consultar dados dessas métricas, use o recurso [Métricas de engajamento de jornada](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-journeys-journey-id-kpis-daterange-kpi-name.html) da API do Amazon Pinpoint. A coluna **kpi-name** da tabela indica o valor a ser usado para o parâmetro `kpi-name` na consulta.
| Métrica | Kpi-name | Description |
| --- | --- | --- |
| Cliques | `journey-emails-clicked` | O número de vezes que os participantes clicaram em links nas mensagens. Se um único participante clicou em vários links em uma mensagem, ou clicou no mesmo link mais de uma vez, cada clique será incluído na contagem. |
| Cliques, agrupados por atividade | `emails-clicked-grouped-by-journey-activity` | Para cada atividade na jornada, o número de vezes que os participantes clicaram nos links nas mensagens. Se um único participante clicou em vários links em uma mensagem, ou clicou no mesmo link mais de uma vez, cada clique será incluído na contagem. Os resultados da consulta para essa métrica são agrupados por ID de atividade (`JourneyActivityId`), que é uma string que identifica exclusivamente uma atividade. |
| Reclamações | `journey-emails-complained` | O número de mensagens que foram relatadas pelos participantes como e-mail não solicitado ou indesejado. |
| Reclamações, agrupadas por atividade | `emails-complained-grouped-by-journey-activity` | Para cada atividade na jornada, o número de mensagens que foram relatadas pelos participantes como e-mail não solicitado ou indesejado.Os resultados da consulta para essa métrica são agrupados por ID de atividade (`JourneyActivityId`), que é uma string que identifica exclusivamente uma atividade. |
| Entregas | `journey-emails-delivered` | O número de mensagens entregues aos participantes. Essa métrica é calculada como o número de mensagens que foram enviadas, menos o número de mensagens que não puderam ser entregues devido a uma devolução flexível ou definitiva ou porque foram rejeitadas. |
| Entregas, agrupadas por atividade | `emails-delivered-grouped-by-journey-activity` | Para cada atividade na jornada, o número de mensagens que foram entregues aos participantes. Essa métrica é calculada como o número de mensagens que foram enviadas, menos o número de mensagens que não puderam ser entregues devido a uma devolução flexível ou definitiva ou porque foram rejeitadas, para cada atividade na jornada. Os resultados da consulta para essa métrica são agrupados por ID de atividade (`JourneyActivityId`), que é uma string que identifica exclusivamente uma atividade. |
| Devoluções definitivas | `journey-emails-hardbounced` | O número de mensagens que não puderam ser entregues aos participantes devido a uma devolução definitiva. Uma devolução definitiva ocorre quando um problema persistente impede que uma mensagem seja entregue, por exemplo, se o endereço de e-mail do participante não existir. |
| Devoluções definitivas, agrupadas por atividade | `emails-hardbounced-grouped-by-journey-activity` | Para cada atividade na jornada, o número de mensagens que não puderam ser entregues aos participantes devido a uma devolução definitiva. Uma devolução definitiva ocorre quando um problema persistente impede que uma mensagem seja entregue, por exemplo, se o endereço de e-mail do participante não existir. Os resultados da consulta para essa métrica são agrupados por ID de atividade (`JourneyActivityId`), que é uma string que identifica exclusivamente uma atividade. |
| Aberturas | `journey-emails-opened` | O número de mensagens que foram abertas pelos participantes. |
| Aberturas, agrupadas por atividade | `emails-opened-grouped-by-journey-activity` | Para cada atividade na jornada, o número de mensagens que foram abertas pelos participantes. Os resultados da consulta para essa métrica são agrupados por ID de atividade (`JourneyActivityId`), que é uma string que identifica exclusivamente uma atividade. |
| Rejeições | `journey-emails-rejected` | O número de mensagens que não foram enviadas aos participantes porque foram rejeitadas. Uma mensagem será rejeitada se o Amazon Pinpoint determinar que a mensagem contém malware. O Amazon Pinpoint não tenta enviar mensagens rejeitadas. |
| Rejeições, agrupadas por atividade | `emails-rejected-grouped-by-journey-activity` | Para cada atividade na jornada, o número de mensagens que não foram enviadas aos participantes porque foram rejeitadas. Uma mensagem será rejeitada se o Amazon Pinpoint determinar que a mensagem contém malware. O Amazon Pinpoint não tenta enviar mensagens rejeitadas. Os resultados da consulta para essa métrica são agrupados por ID de atividade (`JourneyActivityId`), que é uma string que identifica exclusivamente uma atividade. |
| Envios | `journey-emails-sent` | O número de mensagens enviadas. |
| Envios, agrupados por atividade | `emails-sent-grouped-by-journey-activity` | Para cada atividade na jornada, o número de mensagens enviadas. Os resultados da consulta para essa métrica são agrupados por ID de atividade (`JourneyActivityId`), que é uma string que identifica exclusivamente uma atividade. |
| Devoluções flexíveis | `journey-emails-softbounced` | O número de mensagens que não puderam ser entregues aos participantes devido a uma devolução flexível. Uma devolução flexível ocorre se um problema temporário impede que uma mensagem seja entregue, por exemplo, se a caixa de entrada do participante está cheia ou o servidor receptor está temporariamente indisponível. |
| Devoluções flexíveis, agrupadas por atividade | `emails-softbounced-grouped-by-journey-activity` | Para cada atividade na jornada, o número de mensagens que não puderam ser entregues aos participantes devido a uma devolução flexível. Uma devolução flexível ocorre se um problema temporário impede que uma mensagem seja entregue, por exemplo, se a caixa de entrada do participante está cheia ou o servidor receptor está temporariamente indisponível. Os resultados da consulta para essa métrica são agrupados por ID de atividade (`JourneyActivityId`), que é uma string que identifica exclusivamente uma atividade. |
| Cancelamento de assinaturas | `journey-emails-unsubscribed` | O número de vezes que os participantes clicaram em links de cancelamento de assinatura nas mensagens. Se um único participante clicou no mesmo link de cancelamento de assinatura mais de uma vez, cada clique será incluído na contagem. |
| Cancelamentos de assinatura, agrupados por atividade | `emails-unsubscribed-grouped-by-journey-activity` | Para cada atividade na jornada, o número de vezes que os participantes clicaram nos links de cancelamento de assinatura nas mensagens. Se um único participante clicou no mesmo link de cancelamento de assinatura mais de uma vez, cada clique será incluído na contagem. Os resultados da consulta para essa métrica são agrupados por ID de atividade (`JourneyActivityId`), que é uma string que identifica exclusivamente uma atividade. |
# Métricas de execução da jornada do Amazon Pinpoint
A tabela a seguir lista e descreve métricas de execução padrão que você pode consultar para avaliar o status dos participantes em uma jornada do Amazon Pinpoint. Para consultar dados dessas métricas, use o recurso [Métricas de execução de jornada](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-journeys-journey-id-execution-metrics.html) da API do Amazon Pinpoint. A coluna **Campo** na tabela identifica o nome do campo que aparece nos resultados da consulta para cada métrica.
| Métrica | Campo | Description |
| --- | --- | --- |
| Participantes ativos | `ENDPOINT_ACTIVE` | O número de participantes que estão ativamente realizando as atividades na jornada. Esta métrica é calculada como o número de participantes que iniciaram a jornada, menos o número de participantes que saíram da jornada e o número de participantes que foram removidos da jornada. |
| Cancelamentos de participantes | `CANCELLED` | O número de participantes que não concluíram a jornada porque a jornada foi cancelada. |
| Partidas de participantes | `ENDPOINT_LEFT` | O número de participantes que saíram da jornada. |
| Entradas de participantes | `ENDPOINT_ENTERED` | O número de participantes que iniciaram a jornada. |
| Exceções dos participantes, limites de reentrada | `REENTRY_CAP_EXCEEDED` | O número de participantes que não concluíram a jornada porque teriam excedido o número máximo de vezes que um único participante pode entrar novamente na jornada. |
| Exceções de participantes, rejeições | `ACTIVE_ENDPOINT_REJECTED` | O número de participantes que não podem iniciar a jornada porque já são participantes ativos da jornada. Um participante será rejeitado se iniciar uma jornada e, posteriormente, você atualizar a definição do endpoint do participante de tal maneira que afete a inclusão de participantes em um segmento (com base em critérios de segmento) ou na jornada (com base nas condições da atividade). |
# Métricas de execução da atividade da jornada do Amazon Pinpoint
A tabela a seguir lista e descreve métricas de execução padrão que você pode consultar para avaliar o status dos participantes em cada tipo de atividade individual para uma jornada do Amazon Pinpoint. Para consultar dados dessas métricas, use o recurso [Métricas de execução de jornada](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-journeys-journey-id-activities-journey-activity-id-execution-metrics.html) da API do Amazon Pinpoint. A coluna **Métricas** na tabela lista os campos que aparecem nos resultados da consulta para cada tipo de atividade. Ela também fornece uma breve descrição de cada campo.
| Tipo de atividade | Metrics |
| --- | --- |
| Divisão Sim/Não (`CONDITIONAL_SPLIT`) | As métricas são: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/pinpoint/latest/developerguide/journey-metrics-activity-execution.html) Para cada caminho na atividade, há métricas adicionais disponíveis. Para obter informações sobre essas métricas, consulte a linha desta tabela para esse tipo de atividade. |
| Retenção (`HOLDOUT`) | As métricas são: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/pinpoint/latest/developerguide/journey-metrics-activity-execution.html) |
| E-mail (`MESSAGE`) | As métricas são: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/pinpoint/latest/developerguide/journey-metrics-activity-execution.html) |
| Divisão multivariada (`MULTI_CONDITIONAL_SPLIT`) | Para cada caminho da atividade, o número de participantes que foram para a atividade no caminho. Os resultados da consulta dessa métrica são agrupados por caminho, `Branch_#` onde *\$1* está o identificador numérico de um caminho, por exemplo, `Branch_1` para o primeiro caminho da atividade. Para cada caminho na atividade, há métricas adicionais disponíveis. Para obter informações sobre essas métricas, consulte a linha desta tabela para esse tipo de atividade. |
| Divisão aleatória (`RANDOM_SPLIT`) | Para cada caminho da atividade, o número de participantes que foram para a atividade no caminho. Os resultados da consulta dessa métrica são agrupados por caminho, `Branch_#` onde *\$1* está o identificador numérico de um caminho, por exemplo, `Branch_1` para o primeiro caminho da atividade. Para cada caminho na atividade, há métricas adicionais disponíveis. Para obter informações sobre essas métricas, consulte a linha desta tabela para esse tipo de atividade. |
| Aguardar (`WAIT`) | As métricas são: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/pinpoint/latest/developerguide/journey-metrics-activity-execution.html) |
| Central de atendimento (`CONTACT_CENTER`) | As métricas são: [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/pt_br/pinpoint/latest/developerguide/journey-metrics-activity-execution.html) |
# Métricas de execução da campanha e jornada do Amazon Pinpoint
A tabela a seguir lista e descreve métricas de execução padrão para avaliar o status dos participantes em cada tipo de atividade individual para uma jornada ou campanha do Amazon Pinpoint. Para consultar dados dessas métricas, use o recurso [Métricas de execução de jornada](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-journeys-journey-id-runs-run-id-activities-journey-activity-id-execution-metrics.html) ou [Métricas da campanha](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html) da API do Amazon Pinpoint. A tabela a seguir lista os campos que aparecem nos resultados da consulta para cada tipo de atividade.
****
| Nome da métrica | Aplica-se a jornadas, campanhas ou ambas | Description |
| --- | --- | --- |
| ENDPOINT\$1PRODUCED | Ambos | O número de endpoints produzidos inicialmente a partir do segmento ou evento antes de qualquer filtragem. |
| ENDPOINTS\$1FROM\$1USER | Ambos | Se o cliente tiver um segmento somente com ID de usuário, todos os endpoints desses usuários serão adicionados. Essa métrica mede o número de endpoints adicionados dessa forma. |
| ENDPOINT\$1OPT\$1OUT | Ambos | O endpoint foi excluído e não entrou na campanha ou na jornada. |
| ENDPOINT\$1INACTIVE | Ambos | O endpoint estava inativo e não entrou na campanha ou na jornada. |
| FILTERED\$1OUT\$1BY\$1SEGMENT | Ambos | O endpoint não correspondeu aos filtros do segmento e não entrou na campanha ou na jornada. |
| ENDPOINT\$1MISSING\$1ADDRESS | Ambos | O endpoint não tinha um endereço e não entrou na campanha ou na jornada. |
| ENDPOINT\$1MISSING\$1CHANNEL | Ambos | O endpoint não tinha um canal e não entrou na campanha ou na jornada. |
| ENDPOINT\$1MISSING\$1TIMEZONE | Ambos | O endpoint não tinha um valor para o fuso horário e foi filtrado. Isso só acontece quando um valor de fuso horário é necessário. |
| ENDPOINT\$1TIMEZONE\$1MISMATCH | Ambos | O endpoint estava em um fuso horário que não estava incluído na execução naquele momento. |
| ENDPOINT\$1CHANNEL\$1MISMATCH | Campanhas | A campanha não tem uma mensagem configurada para o tipo de canal desse endpoint. |
| DUPLICATE\$1ENDPOINT | Ambos | Endpoints duplicados foram encontrados e as cópias eliminadas. |
| DUPLICATE\$1USER | Ambos | Usuários duplicados foram encontrados e as cópias foram eliminadas de um segmento somente com ID de usuário. Se eles tiverem o mesmo ID de usuário, uma métrica de 1 será emitida. |
| PAUSED | Jornadas | Removido da execução porque a jornada foi interrompida. |
| ENDED | Jornadas | Removido da execução porque a jornada foi encerrada. |
| TREATMENT\$1HOLDOUT | Campanhas | Isso é emitido em A/B campanhas, para endpoints cujas coortes não correspondem ao tratamento atual. Por exemplo, em uma A/B divisão 50/50, 50% dos endpoints emitirão essa métrica para cada tratamento |
| ENDPOINT\$1ESTIMATED\$1TIMEZONE | Jornadas | A estimativa do fuso horário foi capaz de estimar um fuso horário para o endpoint. |
# Consultar dados de análise do Amazon Pinpoint para campanhas
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 de entrega e engajamento de campanhas.
Cada métrica é um valor mensurável, também chamado de *indicador-chave de desempenho (KPI)*, que pode ajudá-lo a monitorar e avaliar o desempenho de uma ou mais campanhas. Por exemplo, você pode usar uma métrica a fim de descobrir para quantos endpoints uma mensagem de campanha foi enviada ou quantas dessas mensagens foram entregues nos endpoints desejados.
O Amazon Pinpoint coleta e agrega automaticamente esses dados para todas as suas campanhas. Os dados são armazenados por 90 dias. Se você integrou um aplicativo móvel ao Amazon Pinpoint usando um SDK AWS móvel, o Amazon Pinpoint estende esse suporte para incluir métricas adicionais, como a porcentagem de notificações push que foram abertas pelos destinatários. Para obter informações sobre como integrar um aplicativo móvel, consulte [Integrar o Amazon Pinpoint à sua aplicação](integrate.md).
Se você usa o Amazon Pinpoint Analytics APIs para consultar dados, você pode escolher várias opções que definem o escopo, os dados, o agrupamento e os filtros para sua consulta. Faça isso usando parâmetros que especificam o projeto, a campanha e a métrica que você deseja consultar, além de qualquer filtro baseado em datas que você deseja aplicar.
Este tópico explica e fornece exemplos de como escolher essas opções e consultar os dados de uma ou mais campanhas.
## Pré-requisitos
Antes de consultar dados de análise para uma ou mais campanhas, é útil reunir as seguintes informações, usadas para definir a consulta:
+ **ID do projeto**: o identificador exclusivo do projeto associado à campanha ou às campanhas. Na API do Amazon Pinpoint, esse valor é armazenado na propriedade `application-id`. No console do Amazon Pinpoint, esse valor é exibido como o **ID do projeto** na página **Todos os projetos**.
+ **ID da campanha**: o identificador exclusivo da campanha, se você quiser consultar os dados de apenas uma campanha. Na API do Amazon Pinpoint, esse valor é armazenado na propriedade `campaign-id`. Esse valor não é exibido no console.
+ **Intervalo de datas**: opcionalmente, a primeira e a última data e hora do intervalo de datas para o qual consultar dados. Os intervalos de datas são inclusivos e devem estar limitados a 31 dias ou menos. Além disso, eles devem começar em menos de 90 dias a partir do dia atual. Se você não especificar um intervalo de datas, o Amazon Pinpoint consultará automaticamente os dados dos 31 dias corridos anteriores.
+ **Tipo de métrica**: o tipo de métrica a consultar. Existem dois tipos: *métricas de aplicativo* e *métricas de campanha*. Uma *métrica de aplicativo* fornece dados para todas as campanhas associadas a um projeto, também chamadas de *aplicativo*. Uma *métrica de campanha* fornece dados para apenas uma campanha.
+ **Métrica**: o nome da métrica a ser consultada, mais especificamente o valor `kpi-name` da métrica. Para obter uma lista completa das métricas compatíveis e o valor `kpi-name` de cada uma, consulte [Métricas padrão para projetos, campanhas e jornadas](analytics-standard-metrics.md).
Também ajuda determinar se você deseja agrupar os dados por um campo relevante. Se o fizer, poderá simplificar a análise e a emissão de relatórios escolhendo uma métrica projetada para agrupar dados automaticamente para você. Por exemplo, o Amazon Pinpoint fornece várias métricas padrão que relatam a porcentagem de mensagens que foram entregues aos destinatários de uma campanha. Uma dessas métricas agrupa automaticamente os dados por data (`successful-delivery-rate-grouped-by-date`). Outra métrica agrupa automaticamente os dados por execução de campanha (`successful-delivery-rate-grouped-by-campaign-activity`). Uma terceira métrica simplesmente retorna um único valor: a porcentagem de mensagens que foram entregues aos destinatários por todas as execuções de campanha (`successful-delivery-rate`).
Se você não conseguir encontrar uma métrica padrão que agrupe dados da maneira desejada, poderá desenvolver uma série de consultas que retornem os dados desejados. Depois, é possível dividir manualmente ou combinar os resultados da consulta em grupos personalizados criados.
Por fim, é importante verificar se você está autorizado a acessar os dados que deseja consultar. Para obter mais informações, consulte [Políticas do IAM para consulta de dados de análise do Amazon Pinpoint](analytics-permissions.md).
# Consultar dados do Amazon Pinpoint para uma campanha
Para consultar os dados para uma campanha, use a API de [Métricas de campanha](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html) e especifique valores para os seguintes parâmetros necessários:
+ **application-id**: o ID do projeto, que é o identificador exclusivo do projeto associado à campanha. No Amazon Pinpoint, os termos *projeto* e *aplicativo* têm o mesmo significado.
+ **campaign-id**: o identificador exclusivo da campanha.
+ **kpi-name**: o nome da métrica a ser consultada. 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. Para obter uma lista completa das métricas compatíveis e o valor `kpi-name` de cada uma, consulte [Métricas padrão para projetos, campanhas e jornadas](analytics-standard-metrics.md).
Também é possível aplicar um filtro que consulta os dados para um intervalo de datas específico. Se você não especificar um intervalo de datas, o Amazon Pinpoint retornará os dados para os 31 dias corridos anteriores. Para filtrar os dados por datas diferentes, use os parâmetros de intervalo de datas compatíveis para especificar a primeira e a última data e hora do intervalo de datas. 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.
Os exemplos a seguir mostram como consultar dados analíticos de uma campanha usando a API REST do Amazon Pinpoint AWS CLI, o e o. AWS SDK para Java Você pode usar qualquer AWS SDK compatível para consultar dados analíticos de uma campanha. Os AWS CLI exemplos são formatados para o Microsoft Windows. Para Unix, Linux e macOS, substitua o caractere de continuação de linha circunflexo (^) por uma barra invertida (\$1).
------
#### [ REST API ]
Para consultar dados de análise para uma campanha usando a API REST do Amazon Pinpoint, envie uma solicitação HTTP(S) GET para o URI de [Métricas de campanha](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html). No URI, especifique os valores apropriados para os parâmetros de caminho necessários:
```
https://endpoint/v1/apps/application-id/campaigns/campaign-id/kpis/daterange/kpi-name
```
Em que:
+ *endpoint*é o endpoint do Amazon Pinpoint para a AWS região que hospeda o projeto associado à campanha.
+ *application-id* é o identificador exclusivo do projeto associado à campanha.
+ *campaign-id* é o identificador exclusivo da campanha.
+ *kpi-name*é o `kpi-name` valor da métrica a ser consultada.
Todos os parâmetros devem ser codificados por URL.
Para aplicar um filtro que consulta os dados de um intervalo de datas específico, acrescente os valores e parâmetros de consulta `start-time` e `end-time` ao URI. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Use um "e" comercial (&) para separar os parâmetros.
Por exemplo, a seguinte solicitação recupera o número de endpoints exclusivos aos quais as mensagens foram entregues, por todas as execuções de uma campanha, de 19 de julho de 2019 até 26 de julho de 2019:
```
https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/campaigns/80b8efd84042ff8d9c96ce2f8example/kpis/daterange/unique-deliveries?start-time=2019-07-19T00:00:00Z&end-time=2019-07-26T23:59:59Z
```
Em que:
+ `pinpoint.us-east-1.amazonaws.com` é o endpoint do Amazon Pinpoint da Região da AWS que hospeda o projeto.
+ `1234567890123456789012345example` é o identificador exclusivo do projeto associado à campanha.
+ `80b8efd84042ff8d9c96ce2f8example` é o identificador exclusivo da campanha.
+ `unique-deliveries` é o valor `kpi-name` da métrica de *entregas de endpoint* da campanha, que é a métrica que relata o número de endpoints exclusivos aos quais as mensagens foram entregues, por todas as execuções de uma campanha.
+ `2019-07-19T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-07-26T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
#### [ AWS CLI ]
Para consultar dados de análise de uma campanha usando o AWS CLI, use o **get-campaign-date-range-kpi** comando e especifique os valores apropriados para os parâmetros necessários:
```
C:\> aws pinpoint get-campaign-date-range-kpi ^
--application-id application-id ^
--campaign-id campaign-id ^
--kpi-name kpi-name
```
Em que:
+ *application-id* é o identificador exclusivo do projeto associado à campanha.
+ *campaign-id* é o identificador exclusivo da campanha.
+ *kpi-name*é o `kpi-name` valor da métrica a ser consultada.
Para aplicar um filtro que consulta os dados de um intervalo de datas específico, adicione os valores e parâmetros `start-time` e `end-time` à consulta. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Por exemplo, a seguinte solicitação recupera o número de endpoints exclusivos aos quais as mensagens foram entregues, por todas as execuções de uma campanha, de 19 de julho de 2019 até 26 de julho de 2019:
```
C:\> aws pinpoint get-campaign-date-range-kpi ^
--application-id 1234567890123456789012345example ^
--campaign-id 80b8efd84042ff8d9c96ce2f8example ^
--kpi-name unique-deliveries ^
--start-time 2019-07-19T00:00:00Z ^
--end-time 2019-07-26T23:59:59Z
```
Em que:
+ `1234567890123456789012345example` é o identificador exclusivo do projeto associado à campanha.
+ `80b8efd84042ff8d9c96ce2f8example` é o identificador exclusivo da campanha.
+ `unique-deliveries` é o valor `kpi-name` da métrica de *entregas de endpoint* da campanha, que é a métrica que relata o número de endpoints exclusivos aos quais as mensagens foram entregues, por todas as execuções de uma campanha.
+ `2019-07-19T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-07-26T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
#### [ SDK for Java ]
Para consultar dados de análise de uma campanha usando o AWS SDK para Java, use o **GetCampaignDateRangeKpiRequest** método da API de [métricas de campanha](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html). Especifique os valores apropriados para os parâmetros necessários:
```
GetCampaignDateRangeKpiRequest request = new GetCampaignDateRangeKpiRequest()
.withApplicationId("applicationId")
.withCampaignId("campaignId")
.withKpiName("kpiName")
```
Em que:
+ *applicationId* é o identificador exclusivo do projeto associado à campanha.
+ *campaignId* é o identificador exclusivo da campanha.
+ *kpiName*é o `kpi-name` valor da métrica a ser consultada.
Para aplicar um filtro que consulta os dados de um intervalo de datas específico, inclua os valores e parâmetros `startTime` e `endTime` na consulta. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Por exemplo, a seguinte solicitação recupera o número de endpoints exclusivos aos quais as mensagens foram entregues, por todas as execuções de uma campanha, de 19 de julho de 2019 até 26 de julho de 2019:
```
GetCampaignDateRangeKpiRequest request = new GetCampaignDateRangeKpiRequest()
.withApplicationId("1234567890123456789012345example")
.withCampaignId("80b8efd84042ff8d9c96ce2f8example")
.withKpiName("unique-deliveries")
.withStartTime(Date.from(Instant.parse("2019-07-19T00:00:00Z")))
.withEndTime(Date.from(Instant.parse("2019-07-26T23:59:59Z")));
```
Em que:
+ `1234567890123456789012345example` é o identificador exclusivo do projeto associado à campanha.
+ `80b8efd84042ff8d9c96ce2f8example` é o identificador exclusivo da campanha.
+ `unique-deliveries` é o valor `kpi-name` da métrica de *entregas de endpoint* da campanha, que é a métrica que relata o número de endpoints exclusivos aos quais as mensagens foram entregues, por todas as execuções de uma campanha.
+ `2019-07-19T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-07-26T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
Depois de enviar sua consulta, o Amazon Pinpoint retorna os resultados dela em uma resposta JSON. A estrutura dos resultados varia dependendo da métrica consultada. Algumas métricas retornam apenas um valor. Por exemplo, a métrica de *entregas de endpoint* (`unique-deliveries`) da campanha, usada nos exemplos anteriores, retorna um valor: o número de endpoints exclusivos aos quais as mensagens foram entregues, por todas as execuções de uma campanha. Nesse caso, a resposta JSON é a seguinte:
```
{
"CampaignDateRangeKpiResponse":{
"ApplicationId":"1234567890123456789012345example",
"CampaignId":"80b8efd84042ff8d9c96ce2f8example",
"EndTime":"2019-07-26T23:59:59Z",
"KpiName":"unique-deliveries",
"KpiResult":{
"Rows":[
{
"Values":[
{
"Key":"UniqueDeliveries",
"Type":"Double",
"Value":"123.0"
}
]
}
]
},
"StartTime":"2019-07-19T00:00:00Z"
}
}
```
Outras métricas retornam vários valores e agrupam os valores por um campo relevante. Se uma métrica retornar 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](analytics-query-results.md).
# Consultar dados do Amazon Pinpoint para várias campanhas
Há duas maneiras de consultar os dados para várias campanhas. A melhor maneira depende se você deseja consultar os dados para campanhas associadas ao mesmo projeto. Fazer isso também depende de se você deseja consultar os dados para todas ou somente ou subconjunto dessas campanhas.
Para consultar os dados de campanhas associadas a projetos diferentes ou apenas para um subconjunto das campanhas associadas ao mesmo projeto, a melhor abordagem é criar e executar uma série de consultas individuais, uma para cada campanha para a qual você deseja consultar os dados. A seção anterior explica como consultar os dados de apenas uma campanha.
Para consultar os dados de todas as campanhas associadas ao mesmo projeto, é possível usar a API de [Métricas de aplicativo](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html). Especifique valores para os seguintes parâmetros necessários:
+ **application-id**: o ID do projeto, que é o identificador exclusivo do projeto. No Amazon Pinpoint, os termos *projeto* e *aplicativo* têm o mesmo significado.
+ **kpi-name**: o nome da métrica a ser consultada. 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. Para obter uma lista completa das métricas compatíveis e o valor `kpi-name` de cada uma, consulte [Métricas padrão para projetos, campanhas e jornadas](analytics-standard-metrics.md).
Também é possível filtrar os dados por intervalo de datas. Se você não especificar um intervalo de datas, o Amazon Pinpoint retornará os dados para os 31 dias corridos anteriores. Para filtrar os dados por datas diferentes, use os parâmetros de intervalo de datas compatíveis para especificar a primeira e a última data e hora do intervalo de datas. 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.
Os exemplos a seguir mostram como consultar dados analíticos de uma campanha usando a API REST do Amazon Pinpoint AWS CLI, o e o. AWS SDK para Java Você pode usar qualquer AWS SDK compatível para consultar dados analíticos de uma campanha. Os AWS CLI exemplos são formatados para o Microsoft Windows. Para Unix, Linux e macOS, substitua o caractere de continuação de linha circunflexo (^) por uma barra invertida (\$1).
------
#### [ REST API ]
Para consultar dados de análise de várias campanhas usando a API REST do Amazon Pinpoint, envie uma solicitação HTTP(S) GET para o URI de [Métricas de aplicativo](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html). No URI, especifique os valores apropriados para os parâmetros de caminho necessários:
```
https://endpoint/v1/apps/application-id/kpis/daterange/kpi-name
```
Em que:
+ *endpoint*é o endpoint do Amazon Pinpoint para a AWS região que hospeda o projeto associado às campanhas.
+ *application-id* é o identificador exclusivo do projeto associado às campanhas.
+ *kpi-name*é o `kpi-name` valor da métrica a ser consultada.
Todos os parâmetros devem ser codificados por URL.
Para aplicar um filtro que recupera os dados de um intervalo de datas específico, acrescente os valores e parâmetros de consulta `start-time` e `end-time` ao URI. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Use um "e" comercial (&) para separar os parâmetros.
Por exemplo, a solicitação a seguir recupera o número de endpoints exclusivos aos quais as mensagens foram entregues, por cada uma das campanhas de um projeto, de 19 de julho de 2019 até 26 de julho de 2019:
```
https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/kpis/daterange/unique-deliveries-grouped-by-campaign?start-time=2019-07-19T00:00:00Z&end-time=2019-07-26T23:59:59Z
```
Em que:
+ `pinpoint.us-east-1.amazonaws.com` é o endpoint do Amazon Pinpoint da Região da AWS que hospeda o projeto.
+ `1234567890123456789012345example` é o identificador exclusivo do projeto associado às campanhas.
+ `unique-deliveries-grouped-by-campaign` é o valor `kpi-name` da métrica de aplicativo de *entregas de endpoint, agrupadas por campanha*, que é a métrica que retorna o número de endpoints exclusivos aos quais as mensagens foram entregues, por cada campanha.
+ `2019-07-19T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-07-26T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
#### [ AWS CLI ]
Para consultar dados de análise de várias campanhas usando o AWS CLI, use o **get-application-date-range-kpi** comando e especifique os valores apropriados para os parâmetros necessários:
```
C:\> aws pinpoint get-application-date-range-kpi ^
--application-id application-id ^
--kpi-name kpi-name
```
Em que:
+ *application-id* é o identificador exclusivo do projeto associado às campanhas.
+ *kpi-name*é o `kpi-name` valor da métrica a ser consultada.
Para aplicar um filtro que recupera os dados de um intervalo de datas específico, inclua os valores e parâmetros `start-time` e `end-time` na consulta. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Por exemplo, a solicitação a seguir recupera o número de endpoints exclusivos aos quais as mensagens foram entregues, por cada uma das campanhas de um projeto, de 19 de julho de 2019 até 26 de julho de 2019:
```
C:\> aws pinpoint get-application-date-range-kpi ^
--application-id 1234567890123456789012345example ^
--kpi-name unique-deliveries-grouped-by-campaign ^
--start-time 2019-07-19T00:00:00Z ^
--end-time 2019-07-26T23:59:59Z
```
Em que:
+ `1234567890123456789012345example` é o identificador exclusivo do projeto associado à campanha.
+ `unique-deliveries-grouped-by-campaign` é o valor `kpi-name` da métrica de aplicativo de *entregas de endpoint, agrupadas por campanha*, que é a métrica que retorna o número de endpoints exclusivos aos quais as mensagens foram entregues, por cada campanha.
+ `2019-07-19T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-07-26T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
#### [ SDK for Java ]
Para consultar dados de análise de várias campanhas usando o AWS SDK para Java, use o **GetApplicationDateRangeKpiRequest** método da API [Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html). Especifique os valores apropriados para os parâmetros necessários:
```
GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest()
.withApplicationId("applicationId")
.withKpiName("kpiName")
```
Em que:
+ *applicationId* é o identificador exclusivo do projeto associado às campanhas.
+ *kpiName*é o `kpi-name` valor da métrica a ser consultada.
Para aplicar um filtro que recupera os dados de um intervalo de datas específico, inclua os valores e parâmetros `startTime` e `endTime` na consulta. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Por exemplo, a solicitação a seguir recupera o número de endpoints exclusivos aos quais as mensagens foram entregues, por cada uma das campanhas de um projeto, de 19 de julho de 2019 até 26 de julho de 2019:
```
GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest()
.withApplicationId("1234567890123456789012345example")
.withKpiName("unique-deliveries-grouped-by-campaign")
.withStartTime(Date.from(Instant.parse("2019-07-19T00:00:00Z")))
.withEndTime(Date.from(Instant.parse("2019-07-26T23:59:59Z")));
```
Em que:
+ `1234567890123456789012345example` é o identificador exclusivo do projeto associado às campanhas.
+ `unique-deliveries-grouped-by-campaign` é o valor `kpi-name` da métrica de aplicativo de *entregas de endpoint, agrupadas por campanha*, que é a métrica que retorna o número de endpoints exclusivos aos quais as mensagens foram entregues, por cada campanha.
+ `2019-07-19T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-07-26T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
Depois de enviar sua consulta, o Amazon Pinpoint retorna os resultados dela em uma resposta JSON. A estrutura dos resultados varia dependendo da métrica consultada. Algumas métricas retornam apenas um valor. Outras métricas retornam vários valores, e esses valores são agrupados por um campo relevante. Se uma métrica retornar vários valores, a resposta JSON incluirá um campo que indica qual campo foi usado para agrupar os dados.
Por exemplo, a métrica de aplicativo de *entregas de endpoint, agrupadas por campanha* (`unique-deliveries-grouped-by-campaign`), que é usada nos exemplos anteriores, retorna vários valores: o número de endpoints exclusivos aos quais as mensagens foram entregues, para cada campanha associada a um projeto. Nesse caso, a resposta JSON é a seguinte:
```
{
"ApplicationDateRangeKpiResponse":{
"ApplicationId":"1234567890123456789012345example",
"EndTime":"2019-07-26T23:59:59Z",
"KpiName":"unique-deliveries-grouped-by-campaign",
"KpiResult":{
"Rows":[
{
"GroupedBys":[
{
"Key":"CampaignId",
"Type":"String",
"Value":"80b8efd84042ff8d9c96ce2f8example"
}
],
"Values":[
{
"Key":"UniqueDeliveries",
"Type":"Double",
"Value":"123.0"
}
]
},
{
"GroupedBys":[
{
"Key":"CampaignId",
"Type":"String",
"Value":"810c7aab86d42fb2b56c8c966example"
}
],
"Values":[
{
"Key":"UniqueDeliveries",
"Type":"Double",
"Value":"456.0"
}
]
},
{
"GroupedBys":[
{
"Key":"CampaignId",
"Type":"String",
"Value":"42d8c7eb0990a57ba1d5476a3example"
}
],
"Values":[
{
"Key":"UniqueDeliveries",
"Type":"Double",
"Value":"789.0"
}
]
}
]
},
"StartTime":"2019-07-19T00:00:00Z"
}
}
```
Nesse caso, o campo `GroupedBys` indica que os valores são agrupados por ID de campanha (`CampaignId`).
Para saber mais sobre a estrutura dos resultados da consulta, consulte [Usar resultados da consulta JSON](analytics-query-results.md).
# Consultar dados de análise do Amazon Pinpoint para mensagens transacionais
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 as tendências de entrega e engajamento das mensagens transacionais enviadas para um projeto.
Cada métrica é um valor mensurável, também chamado de *indicador-chave de desempenho (KPI)*, que pode ajudá-lo a monitorar e avaliar o desempenho de mensagens transacionais. Por exemplo, você pode usar uma métrica para descobrir quantas mensagens transacionais de e-mail ou SMS você enviou ou quantas dessas mensagens foram entregues aos destinatários. O Amazon Pinpoint coleta e agrega automaticamente esses dados para todas as mensagens transacionais de e-mail e SMS que você envia para um projeto. Os dados são armazenados por 90 dias.
Se você usa o Amazon Pinpoint Analytics APIs para consultar dados, você pode escolher várias opções que definem o escopo, os dados, o agrupamento e os filtros para sua consulta. Faça isso usando parâmetros que especificam o projeto e a métrica que você deseja consultar, além de qualquer filtro baseado em datas que você deseja aplicar.
Este tópico explica e fornece exemplos de como escolher essas opções e consultar dados de mensagens transacionais para um projeto.
## Pré-requisitos
Antes de consultar dados analíticos para mensagens transacionais, ele ajuda a coletar as seguintes informações, usadas para definir sua consulta:
+ **ID do projeto**: o identificador exclusivo do projeto do qual as mensagens foram enviadas. Na API do Amazon Pinpoint, esse valor é armazenado na propriedade `application-id`. No console do Amazon Pinpoint, esse valor é exibido como o **ID do projeto** na página **Todos os projetos**.
+ **Intervalo de datas**: opcionalmente, a primeira e a última data e hora do intervalo de datas para o qual consultar dados. Os intervalos de datas são inclusivos e devem estar limitados a 31 dias ou menos. Além disso, eles devem começar em menos de 90 dias a partir do dia atual. Se você não especificar um intervalo de datas, o Amazon Pinpoint consultará automaticamente os dados dos 31 dias corridos anteriores.
+ **Métrica**: o nome da métrica a ser consultada, mais especificamente o valor `kpi-name` da métrica. Para obter uma lista completa das métricas compatíveis e o valor `kpi-name` de cada uma, consulte [Métricas padrão para projetos, campanhas e jornadas](analytics-standard-metrics.md).
Também ajuda determinar se você deseja agrupar os dados por um campo relevante. Se o fizer, poderá simplificar a análise e a emissão de relatórios escolhendo uma métrica projetada para agrupar dados automaticamente para você. Por exemplo, o Amazon Pinpoint fornece várias métricas padrão que relatam o número de mensagens SMS transacionais que foram entregues aos destinatários. Uma dessas métricas agrupa automaticamente os dados por data (`txn-sms-delivered-grouped-by-date`). Outra métrica agrupa automaticamente os dados por país ou região (`txn-sms-delivered-grouped-by-country`). Uma terceira métrica simplesmente retorna um único valor: a quantidade de mensagens que foram entregues aos destinatários (`txn-sms-delivered`). Se você não conseguir encontrar uma métrica padrão que agrupe dados da maneira desejada, poderá desenvolver uma série de consultas que retornem os dados desejados. Depois, é possível dividir manualmente ou combinar os resultados da consulta em grupos personalizados criados.
Por fim, é importante verificar se você está autorizado a acessar os dados que deseja consultar. Para obter mais informações, consulte [Políticas do IAM para consulta de dados de análise do Amazon Pinpoint](analytics-permissions.md).
# Consultar dados do Amazon Pinpoint para mensagens de e-mail transacionais
Para consultar os dados de mensagens de e-mail transacionais que foram enviadas para um projeto, use a API de [Métricas de aplicativo](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) e especifique valores para os seguintes parâmetros necessários:
+ **application-id**: o ID do projeto, que é o identificador exclusivo do projeto. No Amazon Pinpoint, os termos *projeto* e *aplicativo* têm o mesmo significado.
+ **kpi-name**: o nome da métrica a ser consultada. 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. Para obter uma lista completa das métricas compatíveis e o valor `kpi-name` de cada uma, consulte [Métricas padrão para projetos, campanhas e jornadas](analytics-standard-metrics.md).
Também é possível aplicar um filtro que consulta os dados para um intervalo de datas específico. Se você não especificar um intervalo de datas, o Amazon Pinpoint retornará os dados para os 31 dias corridos anteriores. Para filtrar os dados por datas diferentes, use os parâmetros de intervalo de datas compatíveis para especificar a primeira e a última data e hora do intervalo de datas. Os valores devem estar no formato ISO 8601 estendido e usar o Tempo Universal Coordenado (UTC), por exemplo, `2019-09-06T20:00:00Z` para 20h UTC 6 de setembro 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.
Os exemplos a seguir mostram como consultar dados analíticos para mensagens de e-mail transacionais usando a API REST do Amazon Pinpoint, AWS CLI a e a. AWS SDK para Java Você pode usar qualquer AWS SDK compatível para consultar dados analíticos para mensagens transacionais. Os AWS CLI exemplos são formatados para o Microsoft Windows. Para Unix, Linux e macOS, substitua o caractere de continuação de linha circunflexo (^) por uma barra invertida (\$1).
------
#### [ REST API ]
Para consultar dados de análise de mensagens de e-mail transacionais usando a API REST do Amazon Pinpoint, envie uma solicitação HTTP(S) GET para o URI de [Métricas de aplicativo](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html). No URI, especifique os valores apropriados para os parâmetros de caminho necessários:
```
https://endpoint/v1/apps/application-id/kpis/daterange/kpi-name
```
Em que:
+ *endpoint*é o endpoint do Amazon Pinpoint para a AWS região que hospeda o projeto.
+ *application-id* é o identificador exclusivo do projeto.
+ *kpi-name*é o `kpi-name` valor da métrica a ser consultada.
Todos os parâmetros devem ser codificados por URL.
Para aplicar um filtro que consulta os dados de um intervalo de datas específico, acrescente os valores e parâmetros de consulta `start-time` e `end-time` ao URI. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Use um "e" comercial (&) para separar os parâmetros.
Por exemplo, a seguinte solicitação recupera o número de mensagens de e-mail transacionais que foram enviadas para um projeto de 6 de setembro de 2019 a 13 de setembro de 2019:
```
https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/kpis/daterange/txn-emails-sent?start-time=2019-09-06T00:00:00Z&end-time=2019-09-13T23:59:59Z
```
Em que:
+ `pinpoint.us-east-1.amazonaws.com` é o endpoint do Amazon Pinpoint da Região da AWS que hospeda o projeto.
+ `1234567890123456789012345example` é o identificador exclusivo do projeto.
+ `txn-emails-sent` é o valor `kpi-name` da métrica do aplicativo *envios*, que é a métrica que relata o número de mensagens de e-mail transacionais enviadas para um projeto.
+ `2019-09-06T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-09-13T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
#### [ AWS CLI ]
Para consultar dados analíticos de mensagens de e-mail transacionais usando o AWS CLI, use o **get-application-date-range-kpi** comando e especifique os valores apropriados para os parâmetros necessários:
```
C:\> aws pinpoint get-application-date-range-kpi ^
--application-id application-id ^
--kpi-name kpi-name
```
Em que:
+ *application-id* é o identificador exclusivo do projeto.
+ *kpi-name*é o `kpi-name` valor da métrica a ser consultada.
Para aplicar um filtro que consulta os dados de um intervalo de datas específico, adicione os valores e parâmetros `start-time` e `end-time` à consulta. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Por exemplo, a seguinte solicitação recupera o número de mensagens de e-mail transacionais que foram enviadas para um projeto de 6 de setembro de 2019 a 13 de setembro de 2019:
```
C:\> aws pinpoint get-application-date-range-kpi ^
--application-id 1234567890123456789012345example ^
--kpi-name txn-emails-sent ^
--start-time 2019-09-06T00:00:00Z ^
--end-time 2019-09-13T23:59:59Z
```
Em que:
+ `1234567890123456789012345example` é o identificador exclusivo do projeto.
+ `txn-emails-sent` é o valor `kpi-name` da métrica do aplicativo *envios*, que é a métrica que relata o número de mensagens de e-mail transacionais enviadas para um projeto.
+ `2019-09-06T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-09-13T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
#### [ SDK for Java ]
Para consultar dados analíticos de mensagens de e-mail transacionais usando o AWS SDK para Java, use o **GetApplicationDateRangeKpiRequest** método da API [Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html). Especifique os valores apropriados para os parâmetros necessários:
```
GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest()
.withApplicationId("applicationId")
.withKpiName("kpiName")
```
Em que:
+ *applicationId* é o identificador exclusivo do projeto.
+ *kpiName*é o `kpi-name` valor da métrica a ser consultada.
Para aplicar um filtro que consulta os dados de um intervalo de datas específico, inclua os valores e parâmetros `startTime` e `endTime` na consulta. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Por exemplo, a seguinte solicitação recupera o número de mensagens de e-mail transacionais que foram enviadas para um projeto de 6 de setembro de 2019 a 13 de setembro de 2019:
```
GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest()
.withApplicationId("1234567890123456789012345example")
.withKpiName("txn-emails-sent")
.withStartTime(Date.from(Instant.parse("2019-09-06T00:00:00Z")))
.withEndTime(Date.from(Instant.parse("2019-09-13T23:59:59Z")));
```
Em que:
+ `1234567890123456789012345example` é o identificador exclusivo do projeto.
+ `txn-emails-sent` é o valor `kpi-name` da métrica do aplicativo *envios*, que é a métrica que relata o número de mensagens de e-mail transacionais enviadas para um projeto.
+ `2019-09-06T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-09-13T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
Depois de enviar sua consulta, o Amazon Pinpoint retorna os resultados dela em uma resposta JSON. A estrutura dos resultados varia dependendo da métrica consultada. Algumas métricas retornam apenas um valor. Por exemplo, a métrica do aplicativo *sends* (`txn-emails-sent`), usada nos exemplos anteriores, retorna um valor: o número de mensagens de e-mail transacionais enviadas de um projeto. Nesse caso, a resposta JSON é a seguinte:
```
{
"ApplicationDateRangeKpiResponse":{
"ApplicationId":"1234567890123456789012345example",
"EndTime":"2019-09-13T23:59:59Z",
"KpiName":"txn-emails-sent",
"KpiResult":{
"Rows":[
{
"Values":[
{
"Key":"TxnEmailsSent",
"Type":"Double",
"Value":"62.0"
}
]
}
]
},
"StartTime":"2019-09-06T00:00:00Z"
}
}
```
Outras métricas retornam vários valores e agrupam os valores por um campo relevante. Se uma métrica retornar 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](analytics-query-results.md).
# Consultar dados do Amazon Pinpoint para mensagens SMS transacionais
Para consultar os dados de mensagens SMS transacionais que foram enviadas para um projeto, use a API de [Métricas de aplicativo](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) e especifique valores para os seguintes parâmetros necessários:
+ **application-id**: o ID do projeto, que é o identificador exclusivo do projeto. No Amazon Pinpoint, os termos *projeto* e *aplicativo* têm o mesmo significado.
+ **kpi-name**: o nome da métrica a ser consultada. 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. Para obter uma lista completa das métricas compatíveis e o valor `kpi-name` de cada uma, consulte [Métricas padrão para projetos, campanhas e jornadas](analytics-standard-metrics.md).
Também é possível aplicar um filtro que consulta os dados para um intervalo de datas específico. Se você não especificar um intervalo de datas, o Amazon Pinpoint retornará os dados para os 31 dias corridos anteriores. Para filtrar os dados por datas diferentes, use os parâmetros de intervalo de datas compatíveis para especificar a primeira e a última data e hora do intervalo de datas. Os valores devem estar no formato ISO 8601 estendido e usar o Tempo Universal Coordenado (UTC), por exemplo, `2019-09-06T20:00:00Z` para 20h UTC 6 de setembro 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.
Os exemplos a seguir mostram como consultar dados analíticos para mensagens SMS transacionais usando a API REST do Amazon Pinpoint, AWS CLI a e a. AWS SDK para Java Você pode usar qualquer AWS SDK compatível para consultar dados analíticos para mensagens transacionais. Os AWS CLI exemplos são formatados para o Microsoft Windows. Para Unix, Linux e macOS, substitua o caractere de continuação de linha circunflexo (^) por uma barra invertida (\$1).
------
#### [ REST API ]
Para consultar dados de análise de mensagens SMS transacionais usando a API REST do Amazon Pinpoint, envie uma solicitação HTTP(S) GET para o URI de [Métricas de aplicativo](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html). No URI, especifique os valores apropriados para os parâmetros de caminho necessários:
```
https://endpoint/v1/apps/application-id/kpis/daterange/kpi-name
```
Em que:
+ *endpoint*é o endpoint do Amazon Pinpoint para a AWS região que hospeda o projeto.
+ *application-id* é o identificador exclusivo do projeto.
+ *kpi-name*é o `kpi-name` valor da métrica a ser consultada.
Todos os parâmetros devem ser codificados por URL.
Para aplicar um filtro que recupera os dados de um intervalo de datas específico, acrescente os valores e parâmetros de consulta `start-time` e `end-time` ao URI. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Use um "e" comercial (&) para separar os parâmetros.
Por exemplo, a seguinte solicitação recupera o número de mensagens SMS transacionais que foram enviadas todos os dias de 6 de setembro de 2019 a 8 de setembro de 2019:
```
https://pinpoint.us-east-1.amazonaws.com/v1/apps/1234567890123456789012345example/kpis/daterange/txn-sms-sent-grouped-by-date?start-time=2019-09-06T00:00:00Z&end-time=2019-09-08T23:59:59Z
```
Em que:
+ `pinpoint.us-east-1.amazonaws.com` é o endpoint do Amazon Pinpoint da Região da AWS que hospeda o projeto.
+ `1234567890123456789012345example` é o identificador exclusivo do projeto.
+ `txn-sms-sent-grouped-by-date` é o valor `kpi-name` da métrica do aplicativo *envios, agrupados por data*, que é a métrica que retorna o número de mensagens SMS transacionais que foram enviadas durante cada dia do intervalo de datas.
+ `2019-09-06T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-09-08T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
#### [ AWS CLI ]
Para consultar dados analíticos de mensagens SMS transacionais usando o AWS CLI, use o **get-application-date-range-kpi** comando e especifique os valores apropriados para os parâmetros necessários:
```
C:\> aws pinpoint get-application-date-range-kpi ^
--application-id application-id ^
--kpi-name kpi-name
```
Em que:
+ *application-id* é o identificador exclusivo do projeto.
+ *kpi-name*é o `kpi-name` valor da métrica a ser consultada.
Para aplicar um filtro que recupera os dados de um intervalo de datas específico, inclua os valores e parâmetros `start-time` e `end-time` na consulta. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Por exemplo, a seguinte solicitação recupera o número de mensagens SMS transacionais que foram enviadas todos os dias de 6 de setembro de 2019 a 8 de setembro de 2019:
```
C:\> aws pinpoint get-application-date-range-kpi ^
--application-id 1234567890123456789012345example ^
--kpi-name txn-sms-sent-grouped-by-date ^
--start-time 2019-09-06T00:00:00Z ^
--end-time 2019-09-08T23:59:59Z
```
Em que:
+ `1234567890123456789012345example` é o identificador exclusivo do projeto.
+ `txn-sms-sent-grouped-by-date` é o valor `kpi-name` da métrica do aplicativo *envios, agrupados por data*, que é a métrica que retorna o número de mensagens SMS transacionais que foram enviadas durante cada dia do intervalo de datas.
+ `2019-09-06T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-09-08T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
#### [ SDK for Java ]
Para consultar dados analíticos de mensagens SMS transacionais usando o AWS SDK para Java, use o **GetApplicationDateRangeKpiRequest** método da API [Application Metrics](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-kpis-daterange-kpi-name.html) e especifique os valores apropriados para os parâmetros necessários:
```
GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest()
.withApplicationId("applicationId")
.withKpiName("kpiName")
```
Em que:
+ *applicationId* é o identificador exclusivo do projeto.
+ *kpiName*é o `kpi-name` valor da métrica a ser consultada.
Para aplicar um filtro que recupera os dados de um intervalo de datas específico, inclua os valores e parâmetros `startTime` e `endTime` na consulta. Ao usar esses parâmetros, é possível especificar a primeira e a última data e hora, no formato ISO 8601 estendido, de um intervalo de datas inclusivo para o qual recuperar os dados. Por exemplo, a seguinte solicitação recupera o número de mensagens SMS transacionais que foram enviadas todos os dias de 6 de setembro de 2019 a 8 de setembro de 2019:
```
GetApplicationDateRangeKpiRequest request = new GetApplicationDateRangeKpiRequest()
.withApplicationId("1234567890123456789012345example")
.withKpiName("txn-sms-sent-grouped-by-date")
.withStartTime(Date.from(Instant.parse("2019-09-06T00:00:00Z")))
.withEndTime(Date.from(Instant.parse("2019-09-08T23:59:59Z")));
```
Em que:
+ `1234567890123456789012345example` é o identificador exclusivo do projeto.
+ `txn-sms-sent-grouped-by-date` é o valor `kpi-name` da métrica do aplicativo *envios, agrupados por data*, que é a métrica que retorna o número de mensagens SMS transacionais que foram enviadas durante cada dia do intervalo de datas.
+ `2019-09-06T00:00:00Z` é a primeira data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
+ `2019-09-08T23:59:59Z` é a última data e hora para as quais recuperar dados, como parte de um intervalo de datas inclusivo.
------
Depois de enviar sua consulta, o Amazon Pinpoint retorna os resultados dela em uma resposta JSON. A estrutura dos resultados varia dependendo da métrica consultada. Algumas métricas retornam apenas um valor. Outras métricas retornam vários valores e agrupam esses valores por um campo relevante. Se uma métrica retornar vários valores, a resposta JSON incluirá um campo que indica qual campo foi usado para agrupar os dados.
Por exemplo, a métrica do aplicativo *sends, grouped by date* (`txn-sms-sent-grouped-by-date`), usada nos exemplos anteriores, retorna vários valores: o número de mensagens SMS transacionais enviadas durante cada dia do intervalo de datas especificado. Nesse caso, a resposta JSON é a seguinte:
```
{
"ApplicationDateRangeKpiResponse":{
"ApplicationId":"1234567890123456789012345example",
"EndTime":"2019-09-08T23:59:59Z",
"KpiName":"txn-sms-sent-grouped-by-date",
"KpiResult":{
"Rows":[
{
"GroupedBys":[
{
"Key":"Date",
"Type":"String",
"Value":"2019-09-06"
}
],
"Values":[
{
"Key":"TxnSmsSent",
"Type":"Double",
"Value":"29.0"
}
]
},
{
"GroupedBys":[
{
"Key":"Date",
"Type":"String",
"Value":"2019-09-07"
}
],
"Values":[
{
"Key":"TxnSmsSent",
"Type":"Double",
"Value":"35.0"
}
]
},
{
"GroupedBys":[
{
"Key":"Date",
"Type":"String",
"Value":"2019-09-08"
}
],
"Values":[
{
"Key":"TxnSmsSent",
"Type":"Double",
"Value":"10.0"
}
]
}
]
},
"StartTime":"2019-09-06T00:00:00Z"
}
}
```
Nesse caso, o campo `GroupedBys` indica que os valores são agrupados por dia do calendário (`Date`). Isto significa que:
+ 29 mensagens foram enviadas em 6 de setembro de 2019.
+ 35 mensagens foram enviadas em 7 de setembro de 2019.
+ 10 mensagens foram enviadas em 8 de setembro de 2019.
Para saber mais sobre a estrutura dos resultados da consulta, consulte [Usar resultados da consulta JSON](analytics-query-results.md).
# Usar os resultados da consulta de análise do Amazon Pinpoint
Quando você usa o Amazon Pinpoint Analytics APIs para consultar dados analíticos, o Amazon Pinpoint retorna os resultados em uma resposta JSON. Para métricas de aplicativos, métricas de campanha e métricas de engajamento de jornada, os dados na resposta aderem a um esquema JSON padrão para relatórios de dados analíticos do Amazon Pinpoint.
Isso significa que você pode usar a linguagem de programação ou a ferramenta de sua escolha para implementar uma solução personalizada que consulta os dados de uma ou mais métricas, captura os resultados de cada consulta e, depois, grava os resultados em uma tabela, um objeto ou outro local. Em seguida, você pode trabalhar com os resultados da consulta nesse local usando outro serviço ou aplicativo.
Por exemplo, você pode:
+ Crie um painel personalizado que consulta regularmente um conjunto de métricas e exiba os resultados usando sua estrutura de visualização de dados preferida.
+ Crie um relatório que rastreia as taxas de engajamento consultando as métricas apropriadas e exibindo os resultados em um gráfico ou outro tipo de relatório criado por você.
+ Analise e grave dados analíticos em um formato de armazenamento específico e, em seguida, migre os resultados para uma solução de armazenamento de longo prazo.
Observe que o Amazon Pinpoint Analytics APIs não foi projetado para criar ou armazenar objetos persistentes que você possa ler ou usar posteriormente em um projeto do Amazon Pinpoint ou em sua conta do Amazon Pinpoint. Em vez disso, APIs eles são projetados para ajudá-lo a recuperar dados analíticos e transferi-los para outros serviços e aplicativos para análise, armazenamento ou geração de relatórios adicionais. Elas fazem isso em parte usando a mesma estrutura de resposta JSON e o mesmo esquema para todos os dados analíticos que você pode consultar programaticamente para métricas de aplicativos, métricas de campanha e métricas de engajamento de jornada.
Este tópico explica a estrutura, os objetos e os campos em uma resposta JSON a uma consulta para uma métrica de aplicativo, métrica de campanha ou métrica de engajamento de jornada. Para obter informações sobre os campos em uma resposta JSON a uma consulta para uma métrica de execução de jornada ou métrica de execução de atividade de jornada, consulte [Métricas padrão que se aplicam a projetos, campanhas e jornadas do Amazon Pinpoint](analytics-standard-metrics.md).
## Estrutura JSON
Para ajudá-lo a analisar e usar os resultados da consulta, o Amazon Pinpoint APIs Analytics usa a mesma estrutura de resposta JSON para todos os dados analíticos do Amazon Pinpoint que você pode consultar programaticamente para métricas de aplicativos, métricas de campanha e métricas de engajamento na jornada. Cada resposta JSON especifica os valores que definiram a consulta, como o ID do projeto (`ApplicationId`). A resposta também inclui um (e apenas um) objeto `KpiResult`. O objeto `KpiResult` contém o conjunto geral de resultados para uma consulta.
Cada objeto `KpiResult` contém um objeto `Rows`. Esta é uma matriz de objetos que contêm resultados de consulta e metadados relevantes sobre os valores nesses resultados. A estrutura e o conteúdo de um objeto `Rows` têm as seguintes características gerais:
+ Cada linha de resultados da consulta é um objeto JSON separado, chamado `Values`, no objeto `Rows`. Por exemplo, se uma consulta retornar três valores, o objeto `Rows` conterá três objetos `Values`. Cada objeto `Values` contém um resultado individual para a consulta.
+ Cada coluna de resultados de consulta é uma propriedade do objeto `Values` ao qual ela se aplica. O nome da coluna é armazenado no campo `Key` do objeto `Values`.
+ Para resultados de consulta agrupados, cada objeto `Values` tem um objeto `GroupedBys` associado. O objeto `GroupedBys` indica qual campo foi usado para agrupar os resultados. Ele também fornece o valor de agrupamento para o objeto `Values` associado.
+ Se os resultados da consulta para uma métrica forem nulos, o objeto `Rows` estará vazio.
Além dessas características gerais, a estrutura e o conteúdo do objeto `Rows` variam dependendo da métrica. Isso ocorre porque o Amazon Pinpoint oferece suporte a dois tipos de métrica: *métricas de valor único* e *métricas de vários valores*.
Uma *métrica de valor único* fornece apenas um valor cumulativo. Um exemplo é a porcentagem de mensagens que foram entregues aos destinatários por todas as execuções de uma campanha. Uma *métrica de vários valores* fornece mais de um valor e agrupa esses valores por um campo relevante. Um exemplo é a porcentagem de mensagens que foram entregues aos destinatários para cada execução de uma campanha, agrupadas por execução de campanha.
Você pode determinar rapidamente se uma métrica é uma métrica de valor único ou uma métrica de vários valores referindo-se ao nome da métrica. Se o nome não contiver `grouped-by`, será uma métrica de valor único. Se isso acontecer, é uma métrica de vários valores. Para obter uma lista completa das métricas que você pode consultar programaticamente, consulte [Métricas padrão que se aplicam a projetos, campanhas e jornadas do Amazon Pinpoint](analytics-standard-metrics.md).
### Métricas de valor único
Para uma métrica de valor único, o objeto `Rows` contém um objeto `Values` que:
+ Especifica o nome amigável da métrica que foi consultada.
+ Fornece o valor para a métrica que foi consultada.
+ Identifica o tipo de dados do valor retornado.
Por exemplo, a seguinte resposta JSON contém os resultados da consulta para uma métrica de valor único. Essa métrica registra o número de endpoints exclusivos aos quais as mensagens foram entregues por todas as campanhas associadas a um projeto, de 1 de agosto de 2019 a 31 de agosto de 2019:
```
{
"ApplicationDateRangeKpiResponse":{
"ApplicationId":"1234567890123456789012345example",
"EndTime":"2019-08-31T23:59:59Z",
"KpiName":"unique-deliveries",
"KpiResult":{
"Rows":[
{
"Values":[
{
"Key":"UniqueDeliveries",
"Type":"Double",
"Value":"1368.0"
}
]
}
]
},
"StartTime":"2019-08-01T00:00:00Z"
}
}
```
Neste exemplo, a resposta indica que todas as campanhas do projeto entregaram mensagens para 1.368 endpoints exclusivos de 1 de agosto de 2019 a 31 de agosto de 2019, onde:
+ `Key` é o nome amigável da métrica cujo valor é especificado no campo `Value` (`UniqueDeliveries`).
+ `Type` é o tipo de dados do valor especificado no campo `Value` (`Double`).
+ `Value` é o valor real para a métrica que foi consultada, incluindo quaisquer filtros que foram aplicados (`1368.0`).
Se os resultados da consulta para uma métrica de valor único forem nulos (não maiores ou iguais a zero), o objeto `Rows` estará vazio. O Amazon Pinpoint retornará um valor nulo para uma métrica se não houver nenhum dado a ser retornado para a métrica. Por exemplo:
```
{
"ApplicationDateRangeKpiResponse":{
"ApplicationId":"2345678901234567890123456example",
"EndTime":"2019-08-31T23:59:59Z",
"KpiName":"unique-deliveries",
"KpiResult":{
"Rows":[
]
},
"StartTime":"2019-08-01T00:00:00Z"
}
}
```
### Métricas de vários valores
A estrutura e o conteúdo do objeto `Rows` para uma métrica de vários valores são principalmente os mesmos que uma métrica de valor único. O objeto `Rows` para uma métrica de vários valores também contém um objeto `Values`. O objeto `Values` especifica o nome amigável da métrica que foi consultada, fornece o valor para essa métrica e identifica o tipo de dados desse valor.
No entanto, o objeto `Rows` para uma métrica de vários valores também contém um ou mais objetos `GroupedBy`. Há um objeto `GroupedBy` para cada objeto `Values` nos resultados da consulta. O objeto `GroupedBy` indica qual campo foi usado para agrupar os dados nos resultados e o tipo de dados desse campo. Ele também indica o valor de agrupamento para esse campo (para o objeto `Values` associado).
Por exemplo, a seguinte resposta JSON contém os resultados da consulta para uma métrica de vários valores que relata o número de endpoints exclusivos aos quais as mensagens foram entregues, para cada campanha associada a um projeto, de 1 de agosto de 2019 a 31 de agosto de 2019:
```
{
"ApplicationDateRangeKpiResponse":{
"ApplicationId":"1234567890123456789012345example",
"EndTime":"2019-08-31T23:59:59Z",
"KpiName":"unique-deliveries-grouped-by-campaign",
"KpiResult":{
"Rows":[
{
"GroupedBys":[
{
"Key":"CampaignId",
"Type":"String",
"Value":"80b8efd84042ff8d9c96ce2f8example"
}
],
"Values":[
{
"Key":"UniqueDeliveries",
"Type":"Double",
"Value":"123.0"
}
]
},
{
"GroupedBys":[
{
"Key":"CampaignId",
"Type":"String",
"Value":"810c7aab86d42fb2b56c8c966example"
}
],
"Values":[
{
"Key":"UniqueDeliveries",
"Type":"Double",
"Value":"456.0"
}
]
},
{
"GroupedBys":[
{
"Key":"CampaignId",
"Type":"String",
"Value":"42d8c7eb0990a57ba1d5476a3example"
}
],
"Values":[
{
"Key":"UniqueDeliveries",
"Type":"Double",
"Value":"789.0"
}
]
}
]
},
"StartTime":"2019-08-01T00:00:00Z"
}
}
```
Neste exemplo, a resposta indica que três das campanhas do projeto entregaram mensagens para endpoints exclusivos de 1 de agosto de 2019 a 31 de agosto de 2019. Para cada uma dessas campanhas, a repartição das contagens de entregas é:
+ Campanha `80b8efd84042ff8d9c96ce2f8example` entregou mensagens para 123 endpoints exclusivos.
+ Campanha `810c7aab86d42fb2b56c8c966example` entregou mensagens para 456 endpoints exclusivos.
+ Campanha `42d8c7eb0990a57ba1d5476a3example` entregou mensagens para 789 endpoints exclusivos.
Onde a estrutura geral dos objetos e campos é:
+ `GroupedBys.Key`: o nome da propriedade ou campo que armazena o valor de agrupamento especificado no campo `GroupedBys.Value` (`CampaignId`).
+ `GroupedBys.Type`: o tipo de dados do valor especificado no campo `GroupedBys.Value` (`String`).
+ `GroupedBys.Value`: o valor real para o campo que foi usado para agrupar os dados, conforme especificado no campo `GroupedBys.Key` (ID da campanha).
+ `Values.Key`: o nome amigável da métrica cujo valor é especificado no campo `Values.Value` (`UniqueDeliveries`).
+ `Values.Type`: o tipo de dados do valor especificado no campo `Values.Value` (`Double`).
+ `Values.Value`: o valor real para a métrica que foi consultada, incluindo quaisquer filtros que foram aplicados.
Se os resultados da consulta para uma métrica de vários valores forem nulos (não maiores ou iguais a zero) para um projeto específico, campanha ou outro recurso, o Amazon Pinpoint não retornará nenhum objeto ou campo para o recurso. Se os resultados da consulta para uma métrica de vários valores forem nulos para todos os recursos, o Amazon Pinpoint retornará um objeto `Rows` vazio.
## Objetos e campos JSON
Além de especificar os valores que definiram uma consulta, como o ID do projeto (`ApplicationId`), cada resposta JSON a uma consulta para uma métrica de aplicativo, métrica de campanha ou métrica de engajamento de jornada inclui um objeto `KpiResult`. Este objeto contém o conjunto de resultados geral de uma consulta, que você pode analisar para enviar dados analíticos para outro serviço ou aplicativo. Cada objeto `KpiResult` contém alguns ou todos os seguintes objetos e campos padrão, dependendo da métrica.
| Objeto ou campo | Description |
| --- | --- |
| Rows | Uma matriz de objetos que contém o conjunto de resultados para uma consulta. |
| Rows.GroupedBys | Para uma métrica de vários valores, uma matriz de campos que define o campo e os valores que foram usados para agrupar dados nos resultados da consulta. |
| Rows.GroupedBys.Key | Para uma métrica de vários valores, o nome da propriedade ou campo que armazena o valor especificado no campo GroupedBys.Value. |
| Rows.GroupedBys.Type | Para uma métrica de vários valores, o tipo de dados do valor especificado no campo GroupedBys.Value. |
| Rows.GroupedBys.Value | Para uma métrica de vários valores, o valor real para o campo que foi usado para agrupar dados nos resultados da consulta. Esse valor se correlaciona a um objeto Values associado. |
| Rows.Values | Uma matriz de campos que contém resultados de consulta. |
| Rows.Values.Key | O nome amigável da métrica que foi consultada. O valor da métrica é especificado no campo Values.Value. |
| Rows.Values.Type | O tipo de dados do valor especificado no campo Values.Value. |
| Rows.Values.Value | O valor real para a métrica que foi consultada, incluindo quaisquer filtros que foram aplicados. |
Para obter informações sobre os campos em uma resposta JSON a uma consulta para uma métrica de execução de jornada ou métrica de execução de atividade de jornada, consulte [Métricas padrão que se aplicam a projetos, campanhas e jornadas do Amazon Pinpoint](analytics-standard-metrics.md).