하나의 캠페인에 대한 Amazon Pinpoint 데이터 쿼리

하나의 캠페인에 대한 데이터를 쿼리하려면 캠페인 지표 API를 사용하여 다음 필수 파라미터에 대한 값을 지정합니다.

• application-id - 캠페인과 연관된 프로젝트의 고유 식별자인 프로젝트 ID입니다. Amazon Pinpoint에서 프로젝트 및 애플리케이션이라는 용어는 동일한 의미를 갖습니다.

• campaign-id - 캠페인의 고유 식별자입니다.

• kpi-name - 쿼리할 지표의 이름입니다. 이 값은 연관된 지표를 설명하며 두 개 이상의 용어로 구성되며, 이 용어는 소문자 영숫자 문자로 구성되며 하이픈으로 구분됩니다. 지원되는 지표의 전체 목록과 각 지표에 대한 kpi-name 값은 프로젝트, 캠페인 및 여정에 대한 표준 지표 단원을 참조하십시오.

특정 날짜 범위에 대해 데이터를 쿼리하는 필터를 적용할 수도 있습니다. 날짜 범위를 지정하지 않으면 Amazon Pinpoint에서는 이전 31일 동안의 데이터를 반환합니다. 다른 날짜별로 데이터를 필터링하려면 지원되는 날짜 범위 파라미터를 사용하여 날짜 범위의 첫 번째 및 마지막 날짜 및 시간을 지정합니다. 값은 확장된 ISO 8601 형식이어야 하며 협정 세계시(UTC)를 사용해야 합니다. 예를 들어 2019-07-19T20:00:00Z는 2019년 7월 19일 오후 8시 UTC입니다. 날짜 범위는 포괄적이며 31일 이하로 제한되어야 합니다. 또한 첫 번째 날짜 및 시간은 현재 날짜로부터 90일 이내여야 합니다.

다음 예제에서는 Amazon Pinpoint REST API, AWS CLI및를 사용하여 캠페인에 대한 분석 데이터를 쿼리하는 방법을 보여줍니다 AWS SDK for Java. 지원되는 AWS SDK를 사용하여 캠페인에 대한 분석 데이터를 쿼리할 수 있습니다. AWS CLI 예제는 Microsoft Windows용으로 형식이 지정되어 있습니다. Unix, Linux 및 macOS의 경우 캐럿(^) 행 연속 문자를 백슬래시(\)로 바꿉니다.

REST API

Amazon Pinpoint REST API를 사용하여 캠페인의 분석 데이터를 쿼리하려면 HTTP(S) GET 요청을 캠페인 지표 URI에 보냅니다. URI에서 필요한 경로 파라미터에 적합한 값을 지정합니다.

https://endpoint/v1/apps/application-id/campaigns/campaign-id/kpis/daterange/kpi-name

위치:

• endpoint는 캠페인과 연결된 프로젝트를 호스팅하는 AWS 리전의 Amazon Pinpoint 엔드포인트입니다.

• application-id는 캠페인과 관련된 프로젝트의 고유 식별자입니다.

• campaign-id는 캠페인의 고유 식별자입니다.

• kpi-name은 쿼리할 지표의 kpi-name 값입니다.

모든 파라미터는 URL로 인코딩해야 합니다.

특정 날짜 범위에 대한 데이터를 쿼리하는 필터를 적용하려면 start-time 및 end-time 쿼리 파라미터와 값을 URI에 추가합니다. 이러한 파라미터를 사용하여 데이터를 검색할 포함 날짜 범위의 확장 ISO 8601 형식으로 첫 번째 날짜와 마지막 날짜 및 시간을 지정할 수 있습니다. 앰퍼샌드(&)를 사용하여 파라미터를 구분합니다.

예를 들어 다음 요청은 2019년 7월 19일부터 2019년 7월 26일까지 캠페인의 모든 실행에 의해 메시지가 배달된 고유 엔드포인트 수를 검색합니다.

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

위치:

• pinpoint.us-east-1.amazonaws.com은 프로젝트를 호스팅하는 AWS 리전의 Amazon Pinpoint 엔드포인트입니다.

• 1234567890123456789012345example은 캠페인과 연결된 프로젝트의 고유 식별자입니다.

• 80b8efd84042ff8d9c96ce2f8example은 캠페인의 고유 식별자입니다.

• unique-deliveries는 엔드포인트 배달 건수 캠페인 지표의 kpi-name 값이며, 이는 캠페인의 모든 실행에 의해 메시지가 배달된 고유한 엔드포인트 수를 보고하는 지표입니다.

• 2019-07-19T00:00:00Z는 포함된 날짜 범위의 일부로 데이터를 검색할 첫 번째 날짜 및 시간입니다.

• 2019-07-26T23:59:59Z는 포함된 날짜 범위의 일부로 데이터를 검색할 마지막 날짜 및 시간입니다.

AWS CLI

를 사용하여 캠페인에 대한 분석 데이터를 쿼리하려면 get-campaign-date-range-kpi 명령을 AWS CLI사용하고 필요한 파라미터에 적절한 값을 지정합니다.

C:\> aws pinpoint get-campaign-date-range-kpi ^
    --application-id application-id ^
    --campaign-id campaign-id ^
    --kpi-name kpi-name

위치:

• application-id는 캠페인과 관련된 프로젝트의 고유 식별자입니다.

• campaign-id는 캠페인의 고유 식별자입니다.

• kpi-name은 쿼리할 지표의 kpi-name 값입니다.

특정 날짜 범위에 대한 데이터를 쿼리하는 필터를 적용하려면 start-time 및 end-time 파라미터와 값을 쿼리에 추가합니다. 이러한 파라미터를 사용하여 데이터를 검색할 포함 날짜 범위의 확장 ISO 8601 형식으로 첫 번째 날짜와 마지막 날짜 및 시간을 지정할 수 있습니다. 예를 들어 다음 요청은 2019년 7월 19일부터 2019년 7월 26일까지 캠페인의 모든 실행에 의해 메시지가 배달된 고유 엔드포인트 수를 검색합니다.

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

위치:

• 1234567890123456789012345example은 캠페인과 연결된 프로젝트의 고유 식별자입니다.

• 80b8efd84042ff8d9c96ce2f8example은 캠페인의 고유 식별자입니다.

• unique-deliveries는 엔드포인트 배달 건수 캠페인 지표의 kpi-name 값이며, 이는 캠페인의 모든 실행에 의해 메시지가 배달된 고유한 엔드포인트 수를 보고하는 지표입니다.

• 2019-07-19T00:00:00Z는 포함된 날짜 범위의 일부로 데이터를 검색할 첫 번째 날짜 및 시간입니다.

• 2019-07-26T23:59:59Z는 포함된 날짜 범위의 일부로 데이터를 검색할 마지막 날짜 및 시간입니다.

SDK for Java

를 사용하여 캠페인에 대한 분석 데이터를 쿼리하려면 캠페인 지표 API의 GetCampaignDateRangeKpiRequest 메서드를 AWS SDK for Java사용합니다. https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-campaigns-campaign-id-kpis-daterange-kpi-name.html 필수 파라미터에 대해 적절한 값을 지정합니다.

GetCampaignDateRangeKpiRequest request = new GetCampaignDateRangeKpiRequest()
        .withApplicationId("applicationId")
        .withCampaignId("campaignId")
        .withKpiName("kpiName")

위치:

• applicationId는 캠페인과 관련된 프로젝트의 고유 식별자입니다.

• campaignId는 캠페인의 고유 식별자입니다.

• kpiName은 쿼리할 지표의 kpi-name 값입니다.

특정 날짜 범위에 대한 데이터를 쿼리하는 필터를 적용하려면 쿼리에 startTime 및 endTime 파라미터 및 값을 포함합니다. 이러한 파라미터를 사용하여 데이터를 검색할 포함 날짜 범위의 확장 ISO 8601 형식으로 첫 번째 날짜와 마지막 날짜 및 시간을 지정할 수 있습니다. 예를 들어 다음 요청은 2019년 7월 19일부터 2019년 7월 26일까지 캠페인의 모든 실행에 의해 메시지가 배달된 고유 엔드포인트 수를 검색합니다.

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")));

위치:

• 1234567890123456789012345example은 캠페인과 연결된 프로젝트의 고유 식별자입니다.

• 80b8efd84042ff8d9c96ce2f8example은 캠페인의 고유 식별자입니다.

• unique-deliveries는 엔드포인트 배달 건수 캠페인 지표의 kpi-name 값이며, 이는 캠페인의 모든 실행에 의해 메시지가 배달된 고유한 엔드포인트 수를 보고하는 지표입니다.

• 2019-07-19T00:00:00Z는 포함된 날짜 범위의 일부로 데이터를 검색할 첫 번째 날짜 및 시간입니다.

• 2019-07-26T23:59:59Z는 포함된 날짜 범위의 일부로 데이터를 검색할 마지막 날짜 및 시간입니다.

쿼리를 전송한 후 Amazon Pinpoint는 쿼리 결과를 JSON 응답으로 반환합니다. 결과 구조는 쿼리한 지표에 따라 다릅니다. 일부 지표는 하나의 값만 반환합니다. 예를 들어, 이전 예제에서 사용된 엔드포인트 배달 건수(unique-deliveries) 캠페인 지표는 하나의 값, 즉 캠페인의 모든 실행에 의해 메시지가 배달된 고유한 엔드포인트 수를 반환합니다. 이 경우 JSON 응답은 다음과 같습니다.

{
    "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"
    }
}  

다른 지표는 여러 값을 반환하고 관련 필드별로 값을 그룹화합니다. 지표가 여러 값을 반환하는 경우 JSON 응답에는 데이터를 그룹화하는 데 사용된 필드를 나타내는 필드가 포함됩니다.

쿼리 결과의 구조에 대한 자세한 내용은 JSON 쿼리 결과 사용 단원을 참조하십시오.