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

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

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