리머지는 앱 리타게팅 플랫폼입니다. 클라이언트는 대시보드와 분석 기능 외에도 리머지 보고서 API에서 진행 중인 캠페인에 대한 일 단위의 JSON 기반 보고서를 자체 BI로 불러올 수 있습니다.
참고:
-
리머지 보고서 API는 다음과 같이 터미널(또는 API 클라이언트)을 통해서만 액세스할 수 있습니다.
- 터미널을 통해 액세스하는 경우 아래의 로그인 요청 및 게시 요청 예시에 따라 데이터 전송 도구 Curl 이 필요합니다(로그인 정보는 리머지 계정 관리자가 제공).
- 또는 고객이 자체 내부 API와 데이터 전송 도구를 사용할 수도 있습니다.
- 보고서 API는 웹 브라우저에서 액세스할 수 없습니다.
클라이언트의 성과는 타임스탬프, 국가, 앱, 캠페인, 관련 광고의 5가지 기준으로 분석됩니다. 따라서 결과를 간편하게 가져와서 세분화하고, 클라이언트가 선택한 모든 비즈니스 인텔리전스 플랫폼의 기준에 따라 배포할 수 있습니다. 매개변수와 필드에 관한 자세한 정보를 알아보려면 아래의 색인 섹션을 참조하시기 바랍니다.
엔드포인트
다음 엔드포인트를 통해 API에 액세스할 수 있습니다.
https://api.remerge.io/report요청 매개변수
리머지 보고서 API는 간단한 데이터 검색 인터페이스를 제공합니다. 필수 매개변수는 시작일과 종료일뿐입니다.
| 이름 | 내용 | 예시 | 필수 여부 |
|---|---|---|---|
| *start_date | 보고 시작일(YYYY-MM-DD) | 2017-01-09 | x |
| *end_date | 보고 종료일(YYYY-MM-DD) | 2017-01-10 | x |
| dimensions |
전달되지 않는 경우, 집계된 데이터를 기본적으로 audience, country, campaign, ad로 분할하기 위한 기준 목록(쉼표로 구분). 가능한 기준: audience, country, campaign, ad, ad_label, platform. |
국가, 플랫폼 |
유효한 요청의 형식은 다음과 같습니다: https://api.remerge.io/report?start_date=2017-01-10&end_date=2017-01-11&dimensions=campaign,ad
참고:
- 리머지는 검색에 포함된 모든 기호를 올바르게 터미널로 전송할 수 있도록 Sublime이나 Atom과 같은 텍스트 편집 프로그램을 활용할 것을 권장합니다.
- 요청 URL의 기준을 제한하지 않으면 응답이 가능한 모든 기준을 생성합니다.
승인
예시
로그인 요청
curl -H 'Content-Type: application/json' -H 'Accept: application/json' -X POST
-d '{"user" : { "email" : "your@email.com", "password": "password"}}' https://api.remerge.io/users/sign_in
필요한 토큰을 JSON으로 반환하기
{"email":"your@email.com","token":"J-QeJxyza7JH19QUDb4","user_id":1234,"user_name":"Peter Example","user_token":"J-QeJ49Yasdf219QUDb4"}
유효한 보고 요청을 위한 필수 요청 헤더
| 이름 | 내용 | 예시 | 필수 여부 |
|---|---|---|---|
| 요청 헤더 | 콘텐츠-유형 | 'Content-Type: application/json' | x |
| 요청 헤더 | 수락 | 'Accept: application/json' | x |
| 요청 헤더 | 승인 토큰 | 'Authorization: Token user_token="HJn4OYViZv", email="example@mydomain.com"' | x |
| 요청 유형 | POST | POST | x |
요청 예시
아래는 데이터 전송 도구 curl을 사용하여 리머지 보고서 API로 보낸 POST 요청의 예시입니다.
curl -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Authorization: Token user_token="HJn4OYViZv", email="example@mydomain.com"' -X POST "https://api.remerge.io/report?start_date=2017-01-10&end_date=2017-01-11" -v
응답 필드
응답은 결과 배열과 요소 카운트를 포함하는 JSON 개체를 반환합니다. 각 배열의 요소는 다음 필드로 구성됩니다.
| 이름 | 내용 | 예시 | |
|---|---|---|---|
| timestamp | UTC 타임스탬프 | 2017-01-11T00:00:00.000Z | |
| event.platform | 플랫폼(iOS/Android) | ios | |
| event.country | RTB 지리 정보 | de | |
| event.campaign | 내부 리머지 캠페인 ID | 42 | |
| event.campaign_name | 외부 리머지 캠페인 이름 | Test Campaign | |
| **event.cost_currency | 내부 리머지 캠페인 통화 | EUR | |
| ***event.audience | 앱스토어 참조 | 12345678 | |
| event.ad_id | 크리에이티브 ID | 1406561 | |
| event.ad_name | 위험이 제거된 이미지/동영상 자산 파일 이름 | banner_300_50.png | |
| event.ad_label_id | 크리에이티브 라벨 ID | 18304 | |
| event.ad_label_name | 크리에이티브 라벨 이름 | non_purchasers_it | |
| ****event.ad_creative_url | 크리에이티브 URL | https://assets.remerge.io/ad_assets/files/000/006/696/original/banner_300_50.png?1478088208 | |
| event.impressions | App.Country.Campaign.Ad Level의 일일 임프레션 카운터 | 2 | |
| event.clicks | App.Country.Campaign.Ad Level의 일일 클릭 카운터 | 1 | |
| event.app_open_rate | 집계된 클릭 수 대비 앱 열기(%) | 83.57 | |
| event.cost | App.Country.Campaign.Ad Level의 비용(고객 통화 기준) | 0.12 | |
| event.conversions | App.Country.Campaign.Ad Level의 일일 타깃 컨버젼 이벤트 카운터 | 1 | |
| event.ap_conversions | App.Country.Campaign.Ad Level의 일일 어트리뷰션 타깃 컨버젼 이벤트 카운터 | 5 | |
| event.unique_user | App.Country.Campaign.Ad Level의 일일 고유 사용자 카운터 | 2 |
JSON 응답 예시(같은 쿼리의 2가지 표시 옵션)
옵션 1:
{results: [{"timestamp":"2017-01-11T00:00:00.000Z","event":{"impressions":2,"audience":"12345678","app_open_rate":1.0,"clicks":1,"ad":"test.jpg","user_id":2,"conversions":1,"campaign":"42","country":"de","cost":0.12,"campaign_name":"Test Campaign"}}],count:1}
옵션 2:
해당 기간에 데이터가 존재하지 않는 경우 요청이 빈 결과 배열과 카운트 '0'을 반환합니다.
발생할 수 있는 오류의 목록
| 상태 | 메시지 | 설명 |
|---|---|---|
| 200 | 확인 | JSON으로 반환된 쿼리 결과 |
| 401 | Unauthorized | 제공된 인증 토큰이 잘못됨 |
| 422 | start_date: Format YYYY-MM-DD required | 시작일의 형식이 잘못됨 |
| 422 | end_date: Format YYYY-MM-DD required | 종료일의 형식이 잘못됨 |
| 422 | start_date: must be a valid date | 실제 날짜가 제공되지 않음(예: 2015-33-09) |
| 422 | end_date: must be a valid date | 실제 날짜가 제공되지 않음(예: 2015-33-09) |
| 422 | end_date: end date must be greater or equal to the start date | 종료일이 시작일보다 빠름 |
| 422 | queryID: queryId already exists | 사용자가 보낸 요청을 API가 처리 중. 예: 사용자당 검색 속도 제한이 1임 |
| 504 | Gateway Timeout | 웹 서버가 요청을 처리하는 데 너무 많은 시간이 소요됩니다. 이는 보통 검색 기간이 너무 길기 때문입니다. 이러한 경우 기간을 최대 14일로 설정하고 다시 시도해 보십시오. |
색인
* API 타임스탬프 - start_date 및 end_date는 모두 기본적으로 당일 00:00 자정으로 설정됩니다. 즉, 예를 들어 딱 하루를 검색하려면 해당 날짜를 start_date로, 다음날을 end_date로 설정해야 합니다. 한 번에 하루치의 데이터만 요청할 수 있습니다. 예를 들어, 어제의 데이터는 매일 요청하여 내부 데이터베이스에 저장해야 합니다.
**캠페인마다 다른 통화를 사용하는 경우, 보고서를캠페인 단위로 분할하십시오.
***타깃이 세그먼트를 의미하는 일부 컨텍스트와 달리, 리머지는 'Audience(타깃)'이라는 용어를 전체 애플리케이션의 의미로 사용합니다. 보고서를 불러오면 리머지 보고서 API가 Audience(타깃)라는 필드를 반환합니다. 이는 해당 보고서가 앱 전체에 대한 정적 데이터를 포함한다는 뜻입니다.
**** 다이내믹 광고의 경우 피드에서 그때 그때 적절한 실제 크리에이티브 URL을 가져오므로 표시된 크리에이티브 URL이 유일한 자리 표시자입니다. 이 항목은 이 보고서에 표시되지 않습니다.