리머지는 앱 리타게팅 플랫폼입니다. 클라이언트는 대시보드와 분석 기능 외에도 리머지 Reporting API를 통해 현재 진행 중인 캠페인의 일 단위 JSON 기반 보고서를 자체 BI로 불러올 수 있습니다.
일반
참고:
-
리머지Reporting API는 다음과 같이 터미널 을 통해서만(또는 API 클라이언트만) 액세스할 수 있습니다.
- 터미널 - 이 옵션은 아래 Sign-In Request(로그인 정보는 리머지 Account Manager가 제공해야 함) 및 Post Request 예시에 따라 데이터 전송 도구인 Curl 을 사용해야 합니다 .
-
API - 고객이 자체 API 및 데이터 전송 도구를 사용할 수 있습니다.
- 보고서 API는 웹 브라우저에서 액세스할 수 없습니다.
- 리머지는 6개월이라는 제한된 기간에 한해 고객 데이터를 저장합니다. 따라서 해당 기간보다 이전의 데이터를 받아보고 싶으실 때를 대비하여 자체적으로 데이터 로그를 유지 관리할 것을 권장합니다.
화면 비율
고객의 성과는 6가지 기준(타임스탬프, 국가, 앱, 캠페인, 캠페인 유형, 관련 광고)으로 분류됩니다. 그래서 결과를 간편하게 가져오고 좀 더 세분화하여, 제시된 기준에 맞춰 고객이 선택한 모든 비즈니스 인텔리전스 플랫폼에 배포할 수 있습니다. 특정 매개변수와 필드에 대한 자세한 내용은 아래 색인 섹션을 참조하세요.
엔드포인트
다음 엔드포인트를 통해 API에 액세스할 수 있습니다.
https://api.remerge.io/report요청 및 응답
요청 매개변수
리머지 보고서 API는 간단한 데이터 조회 인터페이스를 제공합니다. 필수 매개변수는 시작일과 종료일 뿐입니다.
참고: 어제 날짜의 데이터를 가져오려면 반드시 오늘 날짜를 end_date로 선택해야 합니다. 예를 들어 2021년 12월 8일 데이터를 가져오려면 2021-12-08을 start_date 로 2021-12-09를 end_date로 선택해야 합니다.
| 이름 | 내용 | 예시 | 필수 여부 |
|---|---|---|---|
| *start_date | 보고 시작일(YYYY-MM-DD) | 2021-12-08 | x |
| *end_date | 보고 종료일(YYYY-MM-DD) | 2021-12-09 | x |
| dimensions |
쉼표로 구분되는 기준 리스트가 전달되지 않는 경우, 기본 설정에서 집계된 데이터를 분류합니다. 분류 기준: audience, country, campaign, campaign_type, ad 가능한 측정 기준: audience, country, campaign, campaign_type, ad, ad_label, platform. |
국가, 플랫폼 | |
| 필터 |
캠페인 유형별로 요청을 필터링할 수 있습니다. 예: https://api.remerge.io/report?start_date=2022-01-01&end_date=2022-01-02&campaign_type=retargeting |
리타게팅 |
유효한 요청의 형식은 다음과 같습니다: 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="xxXxxXXXXXXx-xXxxXXX", email="example@mydomain.com"' -X POST "https://api.remerge.io/report?start_date=2022-01-01&end_date=2022-01-02&dimensions=audience%2Ccountry%2Ccampaign%2Cad%2Cad_label%2Cplatform"
응답 필드
응답은 결과 배열과 요소 카운트를 포함하는 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.campaign_type | 캠페인 유형 | Install/Impact/Retargeting | |
| **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 응답 예시(같은 쿼리의 두 가지 표 옵션)
옵션 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로 설정해야 합니다. 한 번에 1일 데이터만 요청할 수 있습니다. 매일 전날의 데이터를 요청하여 내부 데이터베이스에 저장해야 합니다.
** 캠페인마다 다른 통화를 사용하는 경우 캠페인별로 보고서를 분할하십시오.
***Audience가 Segment를 의미하는 일부 컨텍스트와 달리 리머지는 'Audience'이라는 용어를 전체 애플리케이션에 대한 레퍼런스로 사용합니다. 보고서를 가져오면 리머지 Reporting API가 Audience라는 필드를 반환합니다. 이는 해당 보고서에 앱 전체에 대한 정적 데이터를 포함 한다는 것을 의미합니다.
**** 다이내믹 광고의 경우 동적으로 피드에서 적절한 실제 크리에이티브 URL을 가져오므로 이 항목은 이 보고서에 표시되지 않습니다.