이벤트 스트리밍 지표 요약 API
지역
기본 URL은 프로젝트의 데이터 상주 위치에 따라 달라집니다. 이 페이지의 모든 예제에서 프로젝트가 Amplitude의 EU 데이터 센터를 사용하지 않는 한 기본 URL을 사용하십시오. 이 경우 이 표의 EU 기본 URL을 사용하십시오.
요청은 https://amplitude.com(기본값) 또는 https://analytics.eu.amplitude.com (EU)로 이동합니다. https://analytics.amplitude.com 호스트 이름은 분석 웹 앱(브라우저 UI)이며 이러한 요청에 대한 API 기본 URL이 아닙니다.
| 데이터 상주 | 기본 URL |
|---|---|
| 기본값 | https://amplitude.com |
| EU | https://analytics.eu.amplitude.com |
고려 사항
- 최근 4시간 분량의 데이터는 분 단위까지 정확합니다. 그 시점을 벗어나면 데이터는 매시간 집계됩니다. 4시간이 넘은 지표 데이터를 요청할 때는 이 점을 유의하십시오.
- Amplitude는 지난 90일 동안 이벤트 스트리밍 지표를 보관합니다. 이 임계값을 초과하여
start회 또는end회 전송하면500상태가 반환됩니다.
제한
API는 프로젝트당 동시 요청 4회, 프로젝트당 분당 요청 12회로 제한됩니다. Amplitude는 이 임계값을 초과하는 요청을 429 상태 코드와 함께 거부합니다.
요청
필수 및 선택적 매개변수를 포함한 GET 요청을 https://amplitude.com/api/2/event-streaming/delivery-metrics-summary로 전송합니다.
다음 예제에서는 필수 매개 변수만 포함된 기본 요청을 보여 줍니다.
curl --location --request GET 'https://amplitude.com/api/2/event-streaming/delivery-metrics-summary?sync_id=SYNC_ID&time_period=TIME_PERIOD' \
-u '{api_key}:{secret_key}'
쿼리 매개 변수
| 매개 변수 | 필수 | 설명 |
|---|---|---|
sync_id | 예 | 특정 스트리밍 목적지의 ID입니다. 목적지의 설정 페이지에서 동기화 제목 아래에 있는 이 ID를 찾으십시오. |
time_period | 예 | 지정된 기간 동안의 데이터를 검색합니다. TEN_MINUTES, ONE_HOUR, FOUR_HOURS, ONE_DAY, ONE_WEEK, TWO_WEEKS, 또는 CUSTOM 중 하나입니다. |
start | time_period이(가) CUSTOM인 경우 필수 | YYYY-MM-DDThh:mmTZD(ISO-8601) 형식의 사용자 정의 간격에 대한 시작 시간(해당 시간 포함)입니다. 예를 들어 2022-10-01T07:00:00+01:00. |
end | time_period이(가) CUSTOM인 경우 필수 | YYYY-MM-DDThh:mmTZD(ISO-8601) 형식의 사용자 정의 간격에 대한 배타적인 종료 시간입니다. 예를 들어 2022-10-31T07:00:00+01:00. |
응답
응답은 지정된 동기화에 대한 전송 지표를 포함하는 JSON 객체입니다.
| 속성 | 설명 |
|---|---|
timePeriod | 문자열입니다. 요청에 포함된 time_period 항목입니다. |
eventsDelivered | 정수입니다. 전달된 이벤트의 총 수입니다. |
eventsNotDelivered | 정수입니다. 전달되지 않은 이벤트의 총 수입니다. |
deliveryRate | 두 배입니다. 배달 성공률입니다. |
latencyInSeconds | 두 배입니다. p95 지연 시간(초)입니다. |
timePeriodStart | 문자열입니다. 요청 시작 시간에 대한 UTC(ISO-8601) 타임스탬프입니다. |
timePeriodEnd | 문자열입니다. 요청 종료 시간에 대한 UTC(ISO-8601) 타임스탬프입니다. |
successOnFirstAttempt | 정수입니다. 첫 번째 시도에서 이벤트가 성공적으로 전달되었습니다. |
successAfterRetry | 정수입니다. 한 번 이상의 재시도 후 이벤트가 성공적으로 전달되었습니다. |
eventsExpired | 정수입니다. 모든 재시도 후에도 전송되지 않은 이벤트입니다. |
eventsDiscarded | 정수입니다. 데이터가 불완전하거나 유효하지 않아서 전송되지 않은 이벤트입니다. |
json
{
"timePeriod": "CUSTOM",
"eventsDelivered": 19,
"eventsNotDelivered": 0,
"deliveryRate": 1.0,
"latencyInSeconds": 5.098051910578275,
"timePeriodStart": "2022-10-01 06:00:00.000000",
"timePeriodEnd": "2022-10-31 06:00:00.000000",
"successOnFirstAttempt": 19,
"successAfterRetry": 0,
"eventsExpired": 0,
"eventsDiscarded": 0
}
상태 코드
| 코드 | 메시지 |
|---|---|
| 200 | 성공 |
| 400 | 잘못된 요청 |
| 401 | 권한 없음 |
| 403 | 금지됨: 조직 및 앱 외부에서 동기화에 액세스하려는 시도. |
| 429 | 속도 제한 초과 |
| 500 | 내부 서버 오류 |
이 내용이 도움이 되었나요?