Consultar dados do Amazon Pinpoint para uma campanha

Para consultar os dados para uma campanha, use a API de Métricas de campanha 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.

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 (\).

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. 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. 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.