프로
엔터프라이즈
1000회/분
이메일 상세 통계 조회
이메일의 상세 통계(발송 성공한 구독자 목록, 오픈한 구독자 목록 등)를 조회합니다.
Path Parameters
- Type: integeridrequired
이메일 아이디
Query Parameters
- Type: integeroffsetmin:0
현재 데이터 조회가 시작되는 위치
- Type: integerlimitmin:1max:1000
한 번에 가져올 데이터의 최대 개수 (최대 1000)
- Type: stringactions
조회할 구독자 활동(쉼표로 구분). 예) "O,C" 또는 "OPENED,CLICKED"
-
활동 코드(
action)와 활동 이름(actionName) 중 어느 쪽으로도 요청할 수 있습니다. -
활동 이름은 대소문자를 구분하지 않습니다. 예) "opened,clicked"
-
토큰 앞뒤 공백은 허용됩니다. 예) "O, C"
-
같은 활동을 코드와 이름으로 함께 보내면 하나로 처리됩니다. 예) "B,HARD_BOUNCED"
-
알 수 없는 값은 무시됩니다. 이 경우 400 오류는 발생하지 않습니다.
-
보낸 값이 전부 알 수 없는 값이면 필터를 지정하지 않은 것과 같습니다.
-
지정하지 않으면 모든 활동을 조회합니다.
-
P (DELIVERED): 발송 성공
-
F (SOFT_BOUNCED): 발송 실패, 소프트바운스
-
A (HARD_BOUNCED_DELETED): 발송 실패, 하드바운스, 주소록 자동삭제 적용
-
B (HARD_BOUNCED): 발송 실패, 하드바운스, 주소록 자동삭제 미적용
-
D (UNSUBSCRIBED): 수신 거부
-
O (OPENED): 이메일 오픈
-
C (CLICKED): 이메일 본문 내 링크 클릭
-
G (DONATED): 기부 완료
-
V (DONATION_REDIRECT): 기부 페이지 유입
-
- Type: stringsubscribers
조회할 구독자의 이메일 주소(쉼표로 구분). 지정하면 해당 구독자들의 로그만 조회합니다.
- 한 번에 최대 30명까지 지정할 수 있습니다.
- 주소가 정확히 일치하는 로그만 조회합니다. 부분 검색은 지원하지 않습니다.
actions와 함께 쓸 수 있습니다. 예) "subscribers=gildong.go@stibee.com&actions=O"- 앞뒤 공백은 무시되고, 같은 주소를 여러 번 넣어도 한 번만 조회합니다.
- 여러 명을 지정하면 로그 아이디 오름차순으로 반환되므로, 한 구독자의 로그가
limit을 채우면 다른 구독자의 로그는 다음 페이지에 나옵니다.offset으로 끝까지 넘겨야 전원의 로그를 볼 수 있습니다. - 해당 구독자들의 로그가 없으면 빈 목록과
total: 0을 반환합니다.
Responses
- application/json
- application/json
Request Example for get/emails/{id}/logs
curl 'https://api.stibee.com/v2/emails/1/logs?offset=0&limit=20&actions=O%2CC&subscribers=gildong.go%40stibee.com%2Cdooly%40stibee.com' \
--header 'AccessToken: YOUR_SECRET_TOKEN'
{
"total": 1,
"offset": 0,
"limit": 20,
"items": [
{
"id": 1,
"subscriber": "gildong.go@stibee.com",
"action": "P",
"actionName": "DELIVERED",
"value": "",
"value2": "250\nok",
"createdTime": "2024-07-23T18:43:08+09:00"
}
]
}
