Skip to content

내보내기 캔버스 데이터 요약 분석

get

/canvas/data_summary

이 엔드포인트를 사용하면 캔버스에 대한 시계열 데이터의 롤업을 내보내 캔버스 결과에 대한 간결한 요약을 제공할 수 있습니다.

See me in Postman

필수 구성 요소

이 엔드포인트를 사용하려면 canvas.data_summary 권한이 있는 API 키가 필요합니다.

사용량 제한

요청 매개변수

매개변수 필수 데이터 유형 설명
canvas_id 필수 문자열 캔버스 API 식별자를 참조하세요.
ending_at 필수 날짜 시간
(ISO-8601 문자열)		 데이터 내보내기가 종료되는 날짜입니다. 기본값은 요청 시간입니다.
starting_at 선택 사항* 날짜 시간
(ISO-8601 문자열)		 데이터 내보내기를 시작해야 하는 날짜입니다.

* length 또는 starting_at 중 하나가 필요합니다.
length 선택 사항* 문자열 반환된 시리즈에 포함할 ending_at 이전 최대 일수입니다. 1에서 14(포함) 사이여야 합니다.

* length 또는 starting_at 중 하나가 필요합니다.
include_variant_breakdown 선택 사항 부울 이형 상품 통계를 포함할지 여부(기본값은 false)입니다.
include_step_breakdown 선택 사항 부울 걸음 수 통계를 포함할지 여부(기본값은 false)입니다.
include_deleted_step_data 선택 사항 부울 삭제된 단계에 대한 단계 통계를 포함할지 여부(기본값은 false)입니다.

요청 예시

1
2

curl --location -g --request GET 'https://rest.iad-01.braze.com/canvas/data_summary?canvas_id={{canvas_id}}&ending_at=2018-05-30T23:59:59-5:00&starting_at=2018-05-28T23:59:59-5:00&length=5&include_variant_breakdown=true&include_step_breakdown=true&include_deleted_step_data=true' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

응답

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

Content-Type: application/json
Authorization: Bearer YOUR-REST-API-KEY
{
  "data": {
    "name": (string) the Canvas name,
    "total_stats": {
      "revenue": (float) the number of dollars of revenue (USD),
      "conversions": (int) the number of conversions,
      "conversions_by_entry_time": (int) the number of conversions for the conversion event by entry time,
      "entries": (int) the number of entries
    },
    "variant_stats": (optional) {
      "00000000-0000-0000-0000-0000000000000": (string) the API identifier for the variant {
        "name": (string) the name of variant,
        "revenue": (float) the number of dollars of revenue (USD),
        "conversions": (int) the number of conversions,
        "entries": (int) the number of entries
      },
      ... (more variants)
    },
    "step_stats": (optional) {
      "00000000-0000-0000-0000-0000000000000": (string) the API identifier for the step {
        "name": (string) the name of step,
        "revenue": (float) the number of dollars of revenue (USD),
        "conversions": (int) the number of conversions,
        "conversions_by_entry_time": (int) the number of conversions for the conversion event by entry time,
        "messages": {
          "android_push": (name of channel) [
            {
              "sent": (int) the number of sends,
              "opens": (int) the number of opens,
              "influenced_opens": (int) the number of influenced opens,
              "bounces": (int) the number of bounces
              ... (more stats for channel)
            }
          ],
          ... (more channels)
        }
      },
      ... (more steps)
    }
  },
  "message": (required, string) the status of the export, returns 'success' when completed without errors
}
Github   GitHub 에서 이 페이지를 편집합니다.
이 페이지가 얼마나 도움이 되었나요?
New Stuff!