대시보드 REST API
지역
기본 URL은 프로젝트의 데이터 상주 위치에 따라 달라집니다. 이 페이지의 모든 예제에서 프로젝트가 Amplitude의 EU 데이터 센터를 사용하지 않는 한 기본 URL을 사용하십시오. 이 경우 이 표의 EU 기본 URL을 사용하십시오.
요청은 https://amplitude.com(기본값) 또는 https://analytics.eu.amplitude.com (EU)로 이동합니다. https://analytics.amplitude.com호스트 이름은 분석 웹 앱(브라우저 UI)입니다. REST 요청에는 analytics.amplitude.com이 표에 나와 있는 호스트를 사용하십시오.
| 데이터 상주 | 기본 URL |
|---|---|
| 기본값 | https://amplitude.com |
| EU | https://analytics.eu.amplitude.com |
고려 사항
- 이벤트 유형, 이벤트 속성 및 사용자 속성 이름의 특수 문자를 URL 인코딩하십시오. 예를 들어
Play%20Song로Play Song인코딩합니다. W3Schools 인코딩 가이드를 확인하십시오. - 일부 예제에서는 백슬래시 구문을 사용하여 cURL의 문자를 이스케이프합니다. cURL을 사용하지 않는 경우, 요청을 백슬래시 이스케이프 문자로 인코딩하지 마십시오.
- 대시보드 REST API 시간대는 Amplitude 프로젝트의 시간대와 일치합니다.
속도 제한
각 엔드포인트에는 동시 사용 제한과 속도 제한이 있습니다. 동시 사용 제한은 동시에 실행할 수 있는 요청 수를 제한합니다. 속도 제한은 시간당 총 쿼리 수를 제한합니다. 이 제한을 초과하면 429 오류가 반환됩니다. 제한은 프로젝트별로 설정되며 429 오류에는 초과한 제한에 대한 정보가 포함됩니다.
동시 사용 제한: 코호트 다운로드를 포함하여 모든 Amplitude REST API 엔드포인트에서 최대 5개의 동시 요청을 실행하십시오.
사용자 활동 및 사용자 검색 제한
사용자 활동 및 사용자 검색 엔드포인트에는 서로 다른 제한이 있습니다.- 동시 제한: 이러한 엔드포인트에 대해 최대 10개의 동시 요청을 실행하십시오.
- 속도 제한: 이러한 엔드포인트에 대해 시간당 최대 360개의 쿼리를 실행하십시오.
엔드포인트 비용
엔드포인트는 쿼리당 비용을 기준으로 비율 제한 모델을 사용합니다. 비용은 금전적 가치를 지칭하지 않습니다. 비용은 비율 제한과 API 사용 제한을 의미합니다. 이 방법은 모든 쿼리에 대해 동일한 API 가용성을 제공합니다. Amplitude는 다음 수식을 사용하여 요율 비용을 계산합니다.
cost = (# of days) * (# of conditions) * (cost for the query type)
Amplitude는 다음과 같이 각 변수를 결정합니다.
- 일수: 쿼리에 포함된 일수입니다.
- 조건 수: 세그먼트 수와 차트에 적용된 세그먼트 첫 사용 후 조건 수를 합한 값입니다. 각 Group By는 4개의 세그먼트로 계산됩니다.
세그먼트 및 조건
- 세그먼트는 비교 그룹입니다. 자세한 내용은 사용자 세그먼트 추가를 참조하십시오.
- 조건은 최상위 수준의 필터를 나타냅니다. 코호트,
WHERE, 그리고 '누가 수행했는지'는 Amplitude의 조건입니다. 이벤트 필터는 API 비용의 조건으로 수행 회수가 되지 않습니다.
차트 유형에 따라 비용이 다릅니다. 여기에 나열되지 않은 엔드포인트의 경우 비용은 1입니다. 이러한 엔드포인트에 대한 제한은 쿼리당 비용으로 측정되며 다음과 같습니다.
동시 사용 제한: 5분 첫 사용 후 최대 1,000개의 비용이 발생합니다.
속도 제한: 시간당 최대 108,000 비용.
- 이벤트 세분화: 왼쪽 모듈의 이벤트 수와 동일합니다. 전체 이벤트에 그룹 기준이 있는 경우 그룹 기준과 이벤트당 비용을 4로 추가하십시오.
- 퍼널 분석: 퍼널의 이벤트 수에 2를 곱한 값입니다. 전체 이벤트에 그룹 기준이 있는 경우 그룹 기준과 이벤트당 비용을 4로 추가하십시오.
- 리텐션 분석: 이 차트의 비용은 8입니다.
- 사용자 세션: 이 차트의 비용은 4입니다.
공유 쿼리 매개 변수
이러한 쿼리 매개 변수는 여러 대시보드 REST API 엔드포인트에서 공유됩니다.
- 내장된 Amplitude 속성의 경우 유효한 값은 ,
version,country,city,region,DMA,language,platform,os,device,device_type,start_version및paying입니다. - 사용자 지정 사용자 속성의 경우 키 형식을
gp:name로 지정합니다.
이벤트 형식
이벤트 매개변수는 다음 키를 허용합니다.
| 키 | 필수 | 설명 |
|---|---|---|
event_type | 예 | 이벤트 유형입니다. 사용자 지정 이벤트의 경우 이름 앞에 ce:(예: ce:name)를 추가하십시오. '[Amplitude] 전체 활성 이벤트'에 대해서는 _active을 사용하십시오. '[Amplitude] 전체 이벤트'의 경우 _all을 사용하십시오. '[Amplitude] 수익'의 경우 revenue_amount을 사용하십시오. '[Amplitude] 수익(확인됨)'의 경우 verified_revenue을 사용하십시오. '[Amplitude] Revenue (Unverified)'의 경우 unverified_revenue을 사용하십시오. |
filters | 아니요 | 속성 필터 목록입니다. 각 필터는 JSON 객체입니다. Filter 객체 키를 참조하십시오. |
group_by | 아니요 | 그룹화할 속성 목록입니다(최대 2개). 각 group by는 type(event또는 user) 및 value(속성 이름)을 포함하는 JSON 객체입니다. |
객체 키 필터링
| 키 | 필수 | 설명 |
|---|---|---|
subprop_type | 예 | event또는 user, 이벤트 또는 사용자 속성을 나타냅니다. |
subprop_key | 예 | 필터링할 속성의 이름입니다. Amplitude 이외의 사용자 지정 속성의 경우 사용자 속성 이름 앞에 gp:를 추가하십시오. 이벤트 속성에는 gp:접두사가 필요하지 않습니다. |
subprop_op | 예 | 필터 연산자입니다. , , is, is not, contains, does not contain, less, less or equal또는 greater중 greater or equal``set is``set is not하나입니다. |
subprop_value | 예 | 이벤트 속성을 필터링할 기준이 되는 값 목록입니다. |
이벤트 형식 예제
{
"event_type": "CompletedProfile",
"filters": [
{
"subprop_type": "event",
"subprop_key": "EmailVerified",
"subprop_op": "is",
"subprop_value": ["true"]
},
{
"subprop_type": "user",
"subprop_key": "gp:SignUpDate",
"subprop_op": "is",
"subprop_value": ["2021-08-18"]
}
],
"group_by": [
{
"type": "user",
"value": "platform"
}
]
}
세그먼트 정의
세그먼트는 사용자의 속성이나 행동을 기반으로 사용자를 필터링합니다. 각 세그먼트는 JSON 객체입니다.
| 키 | 필수 | 설명 |
|---|---|---|
prop | 예 | 필터링할 속성의 이름입니다. 행동 코호트의 경우 속성 이름은 userdata_cohort입니다. 예: s=\[\{"prop":"userdata_cohort","op":"is","values":\["XYXxxzz"\]\}\]입니다. 여기서 XYXxxzz 는 행동 집단의 URL(https://analytics.amplitude.com/org_name/cohort/XYXxxzz)의 식별자입니다. |
op | 예 | 필터 연산자입니다. , , is, is not, contains, does not contain, less, less or equal또는 greater중 greater or equal``set is``set is not하나입니다. |
values | 예 | 세그먼트를 필터링할 기준이 되는 문자열 목록입니다. 코호트별로 세분화할 때 값은 웹 앱의 코호트 URL에서 찾을 수 있는 코호트 ID입니다(예: 5mjbq8w). |
type | 아니요 | 이벤트 성과를 기반으로 사용자를 세분화하기 위해 '수행자' 필터를 사용할 때 "event"설정합니다. |
event_type | 아니요 | "수행자" 필터를 사용할 때 필터링할 이벤트입니다. type가 "event"인 경우 필수입니다. |
filters | 아니요 | "수행자" 필터를 사용할 때 이벤트 속성 필터링입니다. 필터 객체의 배열입니다. |
value | 아니요 | "수행자" 필터에 대한 수행 회수가 임계값입니다. time_type및 time_value과 함께 사용하십시오. |
time_type | 아니요 | "수행자" 필터에 대한 시간 창 유형입니다. "forEachInterval", "currentInterval"또는 "allTime"중 하나입니다. |
time_value | 아니요 | time_type가 "forEachInterval"와 같은 경우 시간 창의 일수입니다. |
세그먼트 정의 예
사용자 속성 필터
속성 값을 기준으로 사용자를 필터링합니다.
[
{
"prop": "version",
"op": "contains",
"values": ["1.0", "2.0"]
},
{
"prop": "gp:gender",
"op": "is",
"values": ["female"]
}
]
"수행자" 필터
특정 이벤트를 수행한 사용자를 필터링합니다. 이 예제에서는 지난 30일 동안 해당 signup - end signup이벤트를 한 번 이상 수행한 사용자를 필터링합니다.
[
{
"op": ">=",
"type": "event",
"event_type": "signup - end signup",
"filters": [],
"value": 0,
"time_type": "forEachInterval",
"time_value": 30
}
]
여러 필터를 결합할 수 있습니다. 이 예제에서는 해당 signup - end signup 이벤트를 한 번 이상 수행한 미국 사용자를 필터링합니다.
[
{
"prop": "country",
"op": "is",
"values": ["United States"]
},
{
"op": ">=",
"type": "event",
"event_type": "signup - end signup",
"filters": [],
"value": 1,
"time_type": "allTime"
}
]
데이터 테이블 내보내기
대시보드 REST API를 사용하여 데이터 테이블에서 데이터를 내보낼 수 있습니다. 전체 데이터 테이블 차트 유형을 쿼리하고 쿼리에 시작 날짜나 종료 날짜를 포함하지 마십시오.
기존 차트에서 결과 가져오기
전체 불러오기 차트에서 차트 ID별로 JSON 결과를 가져옵니다. GET https://amplitude.com/api/3/chart/chart_id/csv
curl --location --request GET 'https://amplitude.com/api/3/chart/:chart_id/csv' \
-u '{api_key}:{secret_key}'
경로 변수
| 이름 | 설명 |
|---|---|
chart_id | 필수입니다. 차트의 ID입니다. 웹 앱의 차트 URL에서 차트 ID를 가져옵니다. 예를 들어 abc123이 URL의 경우: https://analytics.amplitude.com/demo/chart/abc123. |
응답
응답은 차트의 유형에 따라 다릅니다.
활성 사용자 및 신규 사용자 수 확보
활성 사용자 또는 신규 사용자의 수를 확인합니다.
GET https://amplitude.com/api/2/users
curl --location --request GET 'https://amplitude.com/api/2/users?start=STARTDATE&end=ENDDATE' \
-u '{api_key}:{secret_key}'
쿼리 매개 변수
| 이름 | 설명 |
|---|---|
start | 필수입니다. 데이터 시리즈에 포함된 첫 번째 날짜이며 형식은 YYYYMMDD입니다. 예를 들어 20221001. |
end | 필수입니다. 데이터 시리즈에 포함된 마지막 날짜(형식은 YYYYMMDD입니다). 예를 들어 20221001. |
m | 선택 사항입니다. 필요한 수행 회수가를 얻으려면 new또는 active중 하나를 사용하십시오. 기본값은 active입니다. |
i | 선택 사항입니다. 일별, 주별 및 월별 카운트에 대해 각각 1, 7 또는 30을 입력합니다. 기본값은 1입니다. |
s | 선택 사항입니다. 세그먼트 정의. 기본값은 없음입니다. 공유 쿼리 매개변수에 정의되어 있습니다. |
g | 선택 사항입니다. 그룹화 기준으로 사용할 속성입니다. 기본값은 없음입니다. 공유 쿼리 매개변수에 정의되어 있습니다. |
응답
응답은 다음 스키마를 가진 JSON 객체입니다.
| 속성 | 설명 |
|---|---|
series | 각 그룹에 대해 하나의 요소를 포함하는 배열로, seriesMeta와 동일한 순서로 지정됩니다. 각 요소는 xValues의 각 날짜에 대한 지표 값을 포함하는 배열입니다. |
seriesMeta | 각 세그먼트에 대해 하나씩 구성된 레이블의 배열입니다. |
xValues | 지정된 범위의 각 날짜에 대해 하나씩 하나의 형식의 날짜 문자열의 YYYY-MM-DD배열입니다. |
{
"data": {
"series": [
[46109, 47542],
[42845, 42626]
],
"seriesMeta": ["United States", "Canada"],
"xValues": ["2017-08-14", "2017-08-15"]
}
}
세션 길이 분포 가져오기
지정된 날짜 범위 다음 기간동안 사전 정의된 각 길이(버킷) 기간에 대한 세션 수를 가져옵니다.
GET https://amplitude.com/api/2/sessions/length
curl --location --request GET 'https://amplitude.com/api/2/sessions/length?start=STARTDATE&end=ENDDATE'
-u '{api_key}:{secret_key}'
쿼리 매개 변수
| 이름 | 설명 |
|---|---|
start | 필수입니다. 데이터 시리즈에 포함된 첫 번째 날짜이며 형식은 YYYYMMDD입니다. 예를 들어 20221001. |
end | 필수입니다. 데이터 시리즈에 포함된 마지막 날짜(형식은 YYYYMMDD입니다). 예를 들어 20221001. |
timeHistogramConfigBinTimeUnit | 선택 사항입니다. 버킷 크기에 대한 시간 단위입니다. 유효한 값은 hours,minutes 및 seconds입니다. |
timeHistogramConfigBinMin | 선택 사항입니다. 버킷화에 대한 최소값(숫자)입니다. 예를 들어 0. |
timeHistogramConfigBinMax | 선택 사항입니다. 버킷화에 사용할 수 있는 최대값입니다(숫자). 예를 들어 600. |
timeHistogramConfigBinSize | 선택 사항입니다. 각 버킷의 크기(숫자)입니다. 예를 들어 60. |
timeHistogramConfigBin 형식
사용자 지정 비닝을 사용하려면 timeHistogramConfigBinMin, timeHistogramConfigBinMax및 timeHistogramConfigBinTimeUnit을 지정하십시오. timeHistogramConfigBinSize가 지정되지 않은 경우 Amplitude는 최적의 빈 크기를 찾습니다. 예를 들어 timeHistogramConfigBinMin=0, timeHistogramConfigBinMax=10, 및 timeHistogramConfigBinTimeUnit=minutes을 사용하는 경우 최종 빈 수 또는 빈 경계는 보장되지 않습니다. timeHistogramConfigBinSize=1에는 10개의 Bin이 있으며 각 Bin의 크기는 1분과 같습니다.
timeHistogramConfigBin매개변수가 유효하지 않거나 누락된 경우 Amplitude 계정은 이탈률과 같은 동작을 설명하는 기본 빈을 사용합니다. 기본 빈(단위: 밀리초)은 다음과 같습니다.[0, 3000), [3000, 10,000), [10,000, 30,000), [30,000, 60,000), [60,000, 180,000), [180,000, 600,000), [600,000, 1,800,000), [1,800,000, 3,600,000), [3,600,000, 86,400,000)
세션 길이는 최대 1일(86,400,000ms)입니다.
응답
응답은 다음 스키마를 가진 JSON 객체입니다.
| 속성 | 설명 |
|---|---|
series | 각 버킷에 대한 세션 수가 포함된 하나의 어레이를 포함하는 어레이입니다. |
xValues | 형식이 지정된 세션 길이 간격 문자열(버킷)의 [bucketStartInSeconds]s-[bucketEndInSeconds]s배열입니다. |
{
"data": {
"series": [
[0, 120408, 2261, 6984, 10778, 54529, 210614, 336605, 196235, 54148]
],
"xValues": [
"0s-60s",
"60s-120s",
"120s-180s",
"180s-240s",
"240s-300s",
"300s-360s",
"360s-420s",
"420s-480s",
"480s-540s",
"540s-600s"
]
}
}
평균 세션 길이 확인
GET https://amplitude.com/api/2/sessions/average
지정된 날짜 범위에서 각 날짜의 평균 세션 길이(초)를 가져옵니다.
curl --location --request GET 'https://amplitude.com/api/2/sessions/average?start=20210601&end=20210630' \
-u '{api_key}:{secret_key}'
쿼리 매개 변수
| 이름 | 설명 |
|---|---|
start | 필수입니다. 데이터 시리즈에 포함된 첫 번째 날짜이며 형식은 YYYYMMDD입니다. 예를 들어 20221001. |
end | 필수입니다. 데이터 시리즈에 포함된 마지막 날짜(형식은 YYYYMMDD입니다). 예를 들어 20221004. |
응답
다음 스키마를 가진 JSON 객체를 반환합니다.
| 속성 | 설명 |
|---|---|
series | 매일 평균 세션 길이를 가진 하나의 어레이를 포함하는 어레이입니다. |
seriesMeta | 각 세그먼트에 대해 하나씩 구성된 레이블의 배열입니다. |
segmentIndex | 세그먼트의 인덱스로, 차트 제어판의 오른쪽 모듈에서 해당 세그먼트의 위치를 나타냅니다. |
xValues | 지정된 범위의 각 날짜에 대해 하나씩 하나의 형식의 날짜 문자열의 YYYY-MM-DD배열입니다. |
{
"data": {
"series": [[1204.0238276716443, 1197.4160169086904]],
"seriesMeta": [{ "segmentIndex": 0 }],
"xValues": ["2017-08-14", "2017-08-15"]
}
}
사용자당 평균 세션 확인
GET https://amplitude.com/api/2/sessions/peruser
지정된 날짜 범위에서 매일 사용자당 평균 세션 수를 가져옵니다.
curl --location --request GET 'https://amplitude.com/api/2/sessions/peruser?start=&end=' \
-u '{api_key}:{secret_key}'
쿼리 매개 변수
| 이름 | 설명 |
|---|---|
start | 필수입니다. 데이터 시리즈에 포함된 첫 번째 날짜이며 형식은 YYYYMMDD입니다. 예를 들어 20221001. |
end | 필수입니다. 데이터 시리즈에 포함된 마지막 날짜(형식은 YYYYMMDD입니다). 예를 들어 20221004. |
응답
다음 스키마를 가진 JSON 객체를 반환합니다.
| 속성 | 설명 |
|---|---|
series | 매일 사용자당 세션 수를 부동 소수점 평균으로 표시하는 하나의 어레이를 포함하는 어레이입니다. |
seriesMeta | 각 세그먼트에 대해 하나씩 구성된 레이블의 배열입니다. |
segmentIndex | 세그먼트의 인덱스로, 차트 제어판의 오른쪽 모듈에서 해당 세그먼트의 위치를 나타냅니다. |
xValues | 지정된 범위의 각 날짜에 대해 하나씩 하나의 형식의 날짜 문자열의 YYYY-MM-DD배열입니다. |
{
"data": {
"series": [[3.624536794878406, 3.6232302614435854]],
"seriesMeta": [{ "segmentIndex": 0 }],
"xValues": ["2017-08-14", "2017-08-15"]
}
}
사용자 구성
지정된 날짜 범위의 사용자 속성 값에 대한 사용자 분포를 가져옵니다.
GET https://amplitude.com/api/2/composition
curl --location --request GET 'https://amplitude.com/api/2/composition?start=STARTDATE&end=ENDDATE&p=PROPERTY' \
-u '{api_key}:{secret_key}'
쿼리 매개 변수
| 이름 | 설명 |
|---|---|
start | 필수입니다. 데이터 시리즈에 포함된 첫 번째 날짜이며 형식은 YYYYMMDD입니다. 예를 들어 20221001. |
end | 필수입니다. 데이터 시리즈에 포함된 마지막 날짜(형식은 YYYYMMDD입니다). 예를 들어 20221001. |
p | 필수입니다. 구성을 가져올 속성입니다. 내장된 Amplitude 속성의 경우 유효한 값은 version, country, city, region, DMA, language, platform, os, device, start_version, 및 paying입니다. 사용자 정의 사용자 속성의 경우 키 형식을 gp:name로 지정합니다. |
응답
다음 스키마를 가진 JSON 객체를 반환합니다.
| 속성 | 설명 |
|---|---|
series | 지정된 날짜 범위에서 해당 속성 값을 가진 고유 사용자의 수를 포함하는 단일 요소 배열입니다. |
seriesLabels | 차트에 표시되는 사용자 속성입니다. |
xValues | 선택한 속성이 취할 수 있는 값의 배열입니다. |
{
"data": {
"series": [[69643, 47419, 38087, 19064]],
"seriesLabels": ["version"],
"xValues": ["1.0", "(none)", "1.1", "0.2"]
}
}
이벤트 목록 가져오기
현재 주의 합계, 고유 사용자 및 DAU(일일 활성 사용자)율이 포함된 이벤트 목록을 가져옵니다.
이 엔드포인트는 보이는 이벤트를 반환합니다. 숨겨진 이벤트는 API에서 반환되지 않습니다.
GET https://amplitude.com/api/2/events/list
curl --location --request GET 'https://amplitude.com/api/2/events/list' \
-u '{api-key}:{secret-key}'
응답
다음 스키마를 가진 JSON 객체를 반환합니다.
| 속성 | 설명 |
|---|---|
non_active | 이벤트가 비활성 상태로 표시되는지 여부입니다. |
value | 원시 데이터에 있는 이벤트의 이름입니다. |
totals | 이번 주에 이벤트가 발생한 총 횟수입니다. |
deleted | 이벤트가 삭제되었는지 여부입니다. |
flow_hidden | 이벤트가 Pathfinder 또는 Pathfinder 사용자에게 숨겨져 있는지 여부입니다. |
hidden | 이벤트가 숨겨져 있는지 여부입니다. |
display | 이벤트의 표시 이름입니다. |
{
"data": [
{
"non_active": false,
"value": "Add Content to Cart",
"totals": 1505645,
"deleted": false,
"flow_hidden": false,
"hidden": false,
"display": "Add Content to Cart"
},
{
"non_active": false,
"value": "Add Friends",
"totals": 193167,
"deleted": false,
"flow_hidden": false,
"hidden": false,
"display": "Add Friends"
}
]
...
}
이벤트 세분화
세그멘테이션을 통해 이벤트에 대한 메트릭을 가져옵니다.
curl --location --request GET 'https://amplitude.com/api/2/events/segmentation?e={"event_type":"YOUR%20EVENT"}&start=STARTDATE&end=DATE' \
-u '{api-key}:{secret-key}'
이벤트 유형, 이벤트 속성 및 사용자 속성 이름의 특수 문자를 URL 인코딩하십시오. 예를 들어 Play Song(으)로 Play%20Song을(를) 인코딩합니다.
쿼리 매개 변수
| 이름 | 설명 |
|---|---|
e | 필수입니다. 최대 2개까지 포함됩니다. 완전한 이벤트입니다. 이벤트 형식을 참조하십시오. 두 번째 이벤트에 대해 쿼리하려면 매개 변수를 사용하십시오e2. |
m | 선택 사항입니다. 비속성 메트릭: uniques, totals, pct_dau또는 average. 기본값은 uniques입니다. 속성 메트릭: histogram, sums또는 value_avg. 속성 메트릭을 사용하려면 매개변수 e에 유효한 group by 값을 포함하십시오. 사용자 정의 공식의 경우: formula (이 지표는 최대 2개의 이벤트를 지원하며, 두 번째 이벤트는 e2매개변수를 사용해야 합니다.) |
n | 선택 사항입니다. 사용자 유형은 any 또는 active 중 하나입니다. |
start | 필수입니다. 데이터 시리즈에 포함된 첫 번째 날짜이며 형식은 YYYYMMDD입니다. 예를 들어 20221001. |
end | 필수입니다. 데이터 시리즈에 포함된 마지막 날짜(형식은 YYYYMMDD입니다). 예를 들어 20221001. |
i | 선택 사항입니다. 실시간, 시간별, 일별, 주별 및 월별 카운트를 각각 -300000, -3600000, 1, 7 또는 30으로 설정하십시오. 기본값은 1입니다. 실시간 세그멘테이션은 최대 2일간의 데이터를 표시하고, 시간별 세그멘테이션은 최대 7일간의 데이터를 표시하며, 일별 세그멘테이션은 최대 365일간의 데이터를 표시합니다. |
s | 선택 사항입니다. 세그먼트 정의(기본값: 없음)입니다. 공유 쿼리 매개 변수를 참조하십시오. |
g | 선택 사항입니다. 최대 2개까지 포함됩니다. 그룹화 기준으로 사용할 속성의 이름입니다. 기본값은 없음입니다. Amplitude 이외의 사용자 지정 속성의 경우 사용자 속성 이름 앞에 gp:를 추가하십시오. 예를 들어 country또는 gp:utm_campaign. 두 번째 속성에 대해 조회하려면 매개변수 g2를 사용하십시오. |
limit | 선택 사항입니다. 반환된 그룹화 기준 값의 수입니다(기본값: 100). 제한은 1000입니다. |
formula | 선택 사항입니다. m가 formula로 설정된 경우 필수입니다. 사용자 지정 수식 지표의 경우 여기에 수식을 전달하십시오(예: UNIQUES(A)/UNIQUES(B)). |
rollingWindow | 선택 사항입니다. 이동 구간을 사용하려면 필수입니다. 이동 구간을 계산할 일수, 주수 또는 개월 수를 전달하십시오. |
rollingAverage | 선택 사항입니다. 이동 평균을 사용해야 합니다. 이동 평균을 계산할 일수, 주수 또는 개월 수를 전달하십시오. |
응답
| 속성 | 설명 |
|---|---|
series | 각 그룹에 대해 하나의 요소를 포함하는 배열로, seriesLabels와 동일한 순서로 지정됩니다. 각 요소는 xValues의 각 날짜에 대한 지표 값을 포함하는 배열입니다. |
seriesLabels | 각 그룹에 대해 하나씩 구성된 레이블의 배열입니다. |
seriesCollapsed | 각 그룹에 대해 하나의 요소를 포함하는 배열로, seriesLabels와 동일한 순서로 지정됩니다. 각 요소는 이벤트 세분화의 막대 차트 값으로, 일정 기간 동안의 총 고유 사용자를 나타냅니다. |
xValues | 지정된 범위의 각 날짜에 대해 하나씩 하나의 형식의 날짜 문자열의 YYYY-MM-DD배열입니다. |
{
"data": {
"series": [
[273333], [190351]
],
"seriesLabels": ["United States", "Germany"],
"seriesCollapsed": [
[
{"value": 273333}
],
[
{"value": 190351}
],
"xValues": ["2014-10-01", "2014-10-02"]
}
}
퍼널 분석
퍼널 드롭오프 및 전환율을 확인하세요.
GET https://amplitude.com/api/2/funnels
curl --location -g --request GET 'https://amplitude.com/api/2/funnels?e={"event_type":"EVENT_1"}&e={"event_type":"EVENT_2"}&start=STARTDATE&end=ENDDATE'
-u '{api_key}:{secret_key}'
쿼리 매개 변수
| 이름 | 설명 |
|---|---|
e | 필수입니다. 퍼널의 각 단계에 대한 전체 이벤트입니다. 이벤트 형식을 참조하십시오. |
start | 필수입니다. 데이터 시리즈에 포함된 첫 번째 날짜이며 형식은 YYYYMMDD입니다. 예를 들어 20221001. |
end | 필수입니다. 데이터 시리즈에 포함된 마지막 날짜(형식은 YYYYMMDD입니다). 예를 들어 20221001. |
mode | 선택 사항입니다. 퍼널을 실행할 모드: 지정된 순서의 이벤트에 대한 ordered, 순서 무관 이벤트에 대한 unordered, 그리고 대상 구간에 다른 이벤트가 없는 지정된 순서의 이벤트에 대한 sequential. 기본값은 ordered입니다. |
n | 선택 사항입니다. new또는 active을 사용하여 퍼널에서 고려할 사용자 집합을 지정합니다. 기본값은 active입니다. |
i | 선택 사항입니다. 실시간, 시간별, 일별, 주별 및 월별 카운트를 각각 -300000, -3600000, 1, 7 또는 30으로 설정하십시오. 기본값은 1입니다. 실시간 세그멘테이션은 최대 2일간의 데이터를 표시하고, 시간별 세그멘테이션은 최대 7일간의 데이터를 표시하며, 일별 세그멘테이션은 최대 365일간의 데이터를 표시합니다. |
s | 선택 사항입니다. 세그먼트 정의. 기본값은 없음입니다. 공유 쿼리 매개 변수를 참조하십시오. |
g | 선택 사항입니다. 제한: 1개. 그룹화 기준으로 사용할 속성의 이름입니다. 기본값은 없음입니다. Amplitude 이외의 사용자 지정 속성의 경우 사용자 속성 이름 앞에 gp:를 추가하십시오. 예를 들어 country또는 gp:utm_campaign. |
cs | 선택 사항입니다. 초 단위의 전환 기간입니다. 기본값은 2,592,000(30일)입니다. 전환 기간은 unordered모드에서 가장 가까운 날짜로 내림됩니다. |
limit | 선택 사항입니다. 반환된 그룹화 기준 값의 수입니다. 기본값은 100입니다. 최대값은 1000입니다. |
응답
응답에는 그룹당 하나의 요소를 가진 배열이 포함됩니다. 각 요소에는 다음 필드가 있습니다.
| 필드 | 설명 |
|---|---|
meta | 각 세그먼트에 대해 하나씩 구성된 레이블의 배열입니다. segmentIndex를 포함합니다. 이 값은 차트 제어판의 오른쪽 모듈에 있는 세그먼트의 색인입니다. |
stepTransTimeDistribution | 사용자가 해당 단계를 통해 전환하는 데 걸린 시간을 보여주는 각 단계의 히스토그램 데이터입니다. |
stepPrevStepCountDistribution | 사용자가 이전 단계를 수행한 횟수를 보여주는 각 단계에 대한 히스토그램 데이터입니다. |
bins | 하나의 히스토그램 버킷에 대한 데이터입니다. start 그리고 end히스토그램 저장소 경계를 표시합니다. bin_dist에는 해당 저장소의 사용자, 수행 회수가 또는 프로섬이 포함됩니다. |
dayMedianTransTimes | 단계 대상 구간의 일별 중앙값 전환 회입니다. series(그룹당 하나의 요소를 갖는 배열, 각 배열은 xValues의 각 날짜에 대한 중앙값 전환 회를 밀리초 단위로 표시하며), xValues(YYYY-MM-DD형식의 날짜 문자열) 및 formattedXValues(Month DD형식의 날짜 문자열)을 포함합니다. |
dayAvgTransTimes | 단계 대상 구간의 일별 평균 전환 회입니다. series(그룹당 하나의 요소를 갖는 배열, 각 배열은 의 각 간격에 대한 평균 전환 회를 밀리초로 xValues표시하며), xValues(형식의 날짜 YYYY-MM-DD문자열) 및 formattedXValues(형식의 날짜 Month DD문자열)을 포함합니다. |
stepByStep | 퍼널 단계마다 하나의 요소를 포함하는 배열로, 이전 단계에서 해당 단계를 완료한 사용자의 비율을 나타냅니다. |
medianTransTimes | 퍼널 단계당 하나의 요소를 포함하는 배열로, 단계 대상 구간의 중앙값 전환 시간을 밀리초 단위로 나타냅니다. |
cumulative | 퍼널 단계당 하나의 요소를 포함하는 배열로, 해당 단계를 완료한 전체 사용자 중 비율을 나타냅니다. |
cumulativeRaw | 퍼널 단계당 하나의 요소를 포함하는 배열로, 해당 단계를 완료한 사용자 수를 나타냅니다. |
avgTransTimes | 퍼널 단계당 하나의 요소를 포함하는 배열로, 대상 구간 평균 전환 시간을 밀리초 단위로 나타냅니다. |
dayFunnels | 각 퍼널 단계를 완료한 일별 사용자 수입니다. series(그룹당 하나의 요소를 갖는 배열, 각 배열은 xValues의 각 간격에 대한 사용자 카운트), xValues(YYYY-MM-DD형식의 날짜 문자열) 및 formattedXValues (Month DD형식의 날짜 문자열)을 포함합니다. |
events | 퍼널에 있는 각 이벤트에 대한 레이블입니다. |
{
"data": [
{
"meta": { "segmentIndex": 0 },
"dayMedianTransTimes": {
"series": [
[0, 165548, 264380],
[0, 164767, 269444]
],
"xValues": ["2017-08-14", "2017-08-15"],
"formattedXValues": ["Aug 14", "Aug 15"]
},
"dayAvgTransTimes": {
"series": [
[0, 2294365, 5730478],
[0, 2268879, 5700436]
],
"xValues": ["2017-08-14", "2017-08-15"],
"formattedXValues": ["Aug 14", "Aug 15"]
},
"stepByStep": [1.0, 0.9915120144246691, 0.9741139357951383],
"medianTransTimes": [0, 166444, 270194],
"cumulative": [1.0, 0.9915120144246691, 0.9658456707593803],
"cumulativeRaw": [163054, 161670, 157485],
"avgTransTimes": [0, 2175406, 5607243],
"dayFunnels": {
"series": [
[125259, 123716, 118636],
[126964, 125373, 119986]
],
"xValues": ["2017-08-14", "2017-08-15"],
"formattedXValues": ["Aug 14", "Aug 15"]
},
"events": [
"Search Song or Video",
"Select Song or Video",
"Play Song or Video"
]
}
]
}
리텐션 분석
특정 시작 및 복귀 작업에 대한 사용자 리텐션 확보
GET https://amplitude.com/api/2/retention
curl --location --request GET 'https://amplitude.com/api/2/retention?se={"event_type":"STARTEVENT"}&re={"event_type":"RETURNEVENT"}&start=STARTDATE&end=ENDDATE' \
-u '{api_key}:{secret_key}'
쿼리 매개 변수
| 매개 변수 | 설명 |
|---|---|
se | 필수입니다. 시작 동작에 대한 전체 이벤트입니다. event_type는 새 사용자에 대한 _new값과 모든 사용자에 대한 _active값의 두 가지를 지원합니다. |
re | 필수입니다. 재방문 작업에 대한 전체 이벤트입니다. 는 모든 event_type이벤트와 _all모든 활성 이벤트에 대해 _active하나의 값을 지원합니다. |
start | 필수입니다. 데이터 시리즈에 포함된 첫 번째 날짜이며 형식은 YYYYMMDD입니다. 예를 들어 20221001. |
end | 필수입니다. 데이터 시리즈에 포함된 마지막 날짜(형식은 YYYYMMDD입니다). 예를 들어 20221001. |
rm | 선택 사항입니다. 리텐션 유형은 bracket, rolling또는 n-day입니다. 이는 무제한 리텐션을 rolling의미합니다. 기본값은 n-day입니다. |
rb | 선택 사항입니다. rm가 bracket로 설정된 경우 필수입니다. 각 괄호의 첫 사용 후 날짜는 형식으로 지정됩니다[[0,4]]. 예를 들어 Day 0 - Day 4 괄호의 경우 매개변수 값은 [[0,5]]입니다. |
i | 선택 사항입니다. 일별, 주별 및 월별 카운트에 대해 각각 1, 7 또는 30을 입력합니다. 기본값은 1입니다. |
s | 선택 사항입니다. 세그먼트 정의. 기본값은 없음입니다. 세그먼트 정의를 참조하십시오. |
g | 선택 사항입니다. 제한: 1개. 그룹화 기준으로 사용할 속성의 이름입니다. 기본값은 없음입니다. Amplitude 이외의 사용자 지정 속성의 경우 사용자 속성 이름 앞에 gp:를 추가하십시오. 예를 들어 country또는 gp:utm_campaign. |
응답
| 필드 | 설명 |
|---|---|
series | 두 개의 키를 가진 JSON 객체입니다. dates(지정된 범위의 날짜마다 하나씩, 내림차순으로 형식이 지정된 날짜 문자열의 배열) 및 values(날짜마다 하나의 키를 가진 JSON 객체. 여기서 각 값은 리텐션 데이터의 배열입니다.) 첫 번째 요소(인덱스 0)에는 해당 코호트에 대한 총 사용자 수행 회수가 포함됩니다. 후속 요소에는 리텐션 데이터가 포함됩니다. 인덱스 N+1의 요소는 i에 따라 N 간격(일, 주 또는 개월)의 리텐션에 해당합니다. 인덱스 1은 Day 0 리텐션을 의미하고, 인덱스 2는 Day 1 리텐션을 의미하는 식입니다. |
count | 해당 간격 동안 유지된 사용자 수입니다. |
outof | 코호트에 속한 총 사용자 수(해당 날짜에 시작 작업을 수행한 사용자)입니다. |
incomplete | 해당 날짜의 사용자가 리텐션으로 집계되기에 충분한 시간이 지났는지 여부. |
combined | 각 값은 모든 날짜 코호트에 걸쳐 집계된 리텐션 데이터의 배열인 JSON 객체입니다. 첫 번째 요소(인덱스 0)에는 총 사용자 수가 포함됩니다. 후속 요소에는 리텐션 데이터가 포함됩니다. 인덱스 N+1의 요소는 N 간격 이후의 리텐션에 해당합니다. 인덱스 1은 Day 0 리텐션, 인덱스 2는 Day 1 리텐션인 식입니다. 이 객체는 valuesJSON 객체의 모든 날짜 코호트의 중복 제거된 집계입니다. |
seriesMeta | 각 세그먼트에 대해 하나씩 구성된 레이블의 배열입니다. |
segmentIndex | 세그먼트의 인덱스로, 차트 제어판의 오른쪽 모듈에서 해당 세그먼트의 위치를 나타냅니다. |
eventIndex | 왼쪽 모듈에 여러 개의 반환 이벤트가 있을 때 선택되는 이벤트를 나타내는 이벤트의 인덱스입니다. |
{
"data": {
"series": [
{
"dates": ["Aug 15", "Aug 14"],
"values": {
"Aug 14": [
{"count": 12864, "outof": 12864, "incomplete": false}, {"count": 9061, "outof": 12864, "incomplete": false}, ..., {"count": 1561, "outof": 12864, "incomplete": true}
],
"Aug 15": [
{"count": 14720, "outof": 14720, "incomplete": false}, {"count": 10249, "outof": 14720, "incomplete": false}, ..., {"count": 1773, "outof": 14720, "incomplete": true}
],
},
"combined": [
{"count": 27584, "outof": 27584, "retainedSetId": null, "incomplete": false},
{"count": 19310, "outof": 27584, "retainedSetId": null, "incomplete": false},
...
{"count": 1561, "outof": 12864, "retainedSetId": null, "incomplete": true}
]
},
"seriesMeta": [
{"segmentIndex": 0, "eventIndex": 0}
]
]
}
}
사용자 활동
사용자 요약 정보와 사용자의 가장 최근 또는 가장 오래된 이벤트를 가져옵니다. 요청 제한을 초과하면 429 오류가 반환됩니다.
GET https://amplitude.com/api/2/useractivity
curl --location --request GET 'https://amplitude.com/api/2/useractivity?user={amplitude_id}'
-u '{api_key}:{secret_key}'
쿼리 매개 변수
| 이름 | 설명 |
|---|---|
user | 필수입니다. 사용자의 Amplitude ID입니다. |
offset | 선택 사항입니다. 이벤트를 반환하기 시작할 위치에 대한 인덱싱이 0인 오프셋(가장 최근 이벤트로부터)입니다. |
limit | 선택 사항입니다. 반환할 이벤트 수입니다(최대 1000개). API는 부분 세션을 방지하기 위해 더 많은 이벤트를 반환할 수 있습니다. 기본값은 1000입니다. |
direction | 선택 사항입니다. earliest사용자의 가장 오래된 이벤트를 포함하거나 가장 최근의 이벤트를 포함합니다latest. 기본값은 latest입니다. |
응답
응답은 다음 스키마를 가진 JSON 객체입니다.
| 속성 | 설명 |
|---|---|
events | 사용자가 수행한 각 이벤트에 대해 하나씩 제공되는 JSON 객체 배열입니다. |
userData | 사용자 및 사용자 속성에 대한 총 통계입니다. |
{
"userData": {
"user_id": "myusername",
"canonical_amplitude_id": 12345,
"merged_amplitude_ids": [11111, 22222],
"num_events": 142,
"num_sessions": 23,
"usage_time": 2570259,
"first_used": "2015-03-14",
"last_used": "2015-04-22",
"purchases": 2,
"revenue": 9.98,
"platform": "iOS",
"os": "ios 8.2",
"version": "3.4.9",
"device": "Apple iPhone",
"device_type": "Apple iPhone 6",
"carrier": "AT&T",
"country": "United States",
"region": "California",
"city": "San Francisco",
"dma": "San Francisco-Oakland-San Jose, CA",
"language": "English",
"start_version": "1.2.3",
"device_ids": ["some-device", "some-other-device"],
"last_location": {
"lat": 37.133,
"lng": -122.241
},
"properties": {
"gender": "female"
}
},
"events": [...]
}
사용자 검색
Amplitude ID, 기기 ID, 사용자 ID 또는 사용자 ID 접두사로 사용자를 검색합니다. 요청 제한을 초과하면 429 오류가 반환됩니다.
GET https://amplitude.com/api/2/usersearch
curl --location --request GET 'https://amplitude.com/api/2/usersearch?user=USER_ID' \
-u '{api-key}:{secret-key}'
쿼리 매개 변수
| 이름 | 설명 |
|---|---|
user | 필수입니다. Amplitude ID, 장치 ID, 사용자 ID 또는 사용자 ID 접두사입니다. |
응답
| 속성 | 설명 |
|---|---|
matches | JSON 객체의 배열로, 일치하는 각 사용자에 대해 하나씩 개체의 Amplitude ID와 사용자 ID를 포함합니다. |
type | 어떤 일치 유형(Amplitude ID, 장치 ID, 사용자 ID, 사용자 ID 접두사)이 결과를 산출했는지 확인하십시오. |
{
"matches": [
{
"user_id": "myusername",
"amplitude_id": 12345
}
],
"type": "match_user_or_device_id"
}
일치하는 항목이 없으면 응답은 다음 본문과 함께 200 응답을 반환합니다.
{
"type": "nomatch",
"matches": []
}
실시간 활성 사용자
지난 2일 동안의 활성 사용자 수를 5분 단위로 확인하세요.
GET https://amplitude.com/api/2/realtime
curl --location --request GET 'https://amplitude.com/api/2/realtime' \
-u '{api-key}:{secret-key}'
응답
다음 스키마를 가진 JSON 객체를 반환합니다.
| 속성 | 설명 |
|---|---|
xValues | 현재 시간부터 시작하여 하루의 각 시간 간격에 대해 하나씩 제공되는 형식의 시간 문자열 배열입니다HH:mm. |
seriesLabels | 두 개의 레이블 Today 및 Yesterday로 구성된 배열입니다. |
series | 각 그룹에 대해 하나의 요소를 포함하는 배열로, seriesLabels와 동일한 순서로 지정됩니다. 각 요소는 xValues의 각 날짜에 대한 지표 값을 포함하는 배열입니다. |
{
"data": {
"xValues": ["15:00", "15:05", "15:10", ... ],
"seriesLabels": ["Today", "Yesterday"],
"series": [
[123, 144, 101, ...],
[139, 111, 180, ...]
]
}
}
수익 평생 가치
신규 사용자의 수명 가치를 확인하십시오.
GET https://amplitude.com/api/2/revenue/ltv
curl --location --request GET 'https://amplitude.com/api/2/revenue/ltv?start=&end=' \
-u '{api-key}:{secret-key}'
쿼리 매개 변수
| 매개 변수 | 설명 |
|---|---|
m | 선택 사항입니다. 이러한 지표 중 하나는 0 = 사용자당 평균 수익(ARPU), 1 = 사용자당 평균 실현 수익(ARPPU), 2 = 총 수익, 3 = 유료 사용자입니다. 기본값은 0입니다. |
start | 필수입니다. 데이터 시리즈에 포함된 첫 번째 날짜이며 형식은 YYYYMMDD입니다. 예를 들어 20221001. |
end | 필수입니다. 데이터 시리즈에 포함된 마지막 날짜(형식은 YYYYMMDD입니다). 예를 들어 20221001. |
i | 선택 사항입니다. 일별, 주별 및 월별 카운트에 대해 각각 1, 7 또는 30을 입력합니다. 기본값은 1입니다. |
s | 선택 사항입니다. 세그먼트 정의. 기본값은 없음입니다. 세그먼트 정의를 참조하십시오. |
g | 선택 사항입니다. 제한: 1개. 그룹화 기준으로 사용할 속성의 이름입니다. 기본값은 없음입니다. Amplitude 이외의 사용자 지정 속성의 경우 사용자 속성 이름 앞에 gp:를 추가하십시오. 예를 들어 country또는 gp:utm_campaign. |
응답
다음 스키마를 가진 JSON 객체를 포함하는 응답을 반환합니다.
| 필드 | 설명 |
|---|---|
seriesLabels | 각 그룹에 대해 하나씩 구성된 레이블의 배열입니다. |
series | 두 개의 키를 가진 JSON 객체입니다. dates (지정된 범위의 날짜마다 하나씩, 내림차순으로 형식이 지정된 날짜 문자열의 배열) 및 values (날짜마다 하나의 키를 가진 JSON 객체). 각 값에는 n일 지표 값에 대한 키 r1d, r2d, ..r90d.와 더불어 count, paid``total_amount, 가 포함되어 있으며, 이는 총 사용자 수, 유료 사용자 수 및 사용자가 그룹에 대해 지불한 금액을 나타냅니다. |
{
"data": {
"seriesLabels": [""],
"series": [
{
"dates": ["2021-10-04", "2021-10-03", "2021-10-02", "2021-10-01"],
"values": {
"2014-10-01": {
"r1d": 9.99,
"r2d": 19.98,
...
"r90d": 742.52,
"count": 110,
"paid": 37,
"total_amount": 781.39
},
...
}
}
]
}
}
Was this helpful?