로딩중입니다
[구버전 v4] 애드브릭스 오픈 API
9/16/2015 1:46:20 PM

애드브릭스 Open API

Open API를 이용하여 애드브릭스 리포트와 트래킹 링크 정보를 조회 할 수 있습니다.


제공 기능

  • 앱 정보 조회
  • 애드브릭스 리포트
  • 트래킹링크 메타 정보 조회
  • 트래킹링크 채널 메타 정보 조회
  • 트래킹링크 컨버전 리포트 조회



토큰 발급

Open API 를 사용하기 위해서는 반드시 토큰이 발급되어야 합니다. 토큰은 Open API 메뉴에서 발급 가능합니다.

토큰을 발급받더라도 Open API를 호출하는 서버나 클라이언트의 아이피가 등록되지 않으면 아무런 정보도 리턴되지 않습니다.





앱 정보 조회

요청한 토큰에 해당하는 앱 정보를 조회할 수 있습니다.


API

GET: 
~/v3/AppInfo?access_token={발급받은 토큰키}

Example Request

GET: 
https://report.ad-brix.com/v3/AppInfo?access_token=d00f4e0d76497033f5d82d53987c1060
Example Response

{
  "version": "3.0",
  "generatedDate": "2015-10-19T14:47:18.7485346+09:00",
  "data": {
    "name": "    Adbrix Postback Test App   ",
    "appScheme": "igaworks.integration.testapp",
    "appKey": 493312809,
    "hashKey": "8ae42e5b25d74580",
    "os": "Android",
    "thumbnailImage": "https://lh3.googleusercontent.com/bsZT3FosCpVKc9LIs-cA1RxZFmDFIyoH4ZKGE4LaVKFhzW4VWPr8kQM2UQo7952lTWQ=w170",
    "marketURL": "market://details?id=igaworks.integration.testapp",
    "screenShotURL": [
      "http://static.adbrix.igaworks.com/adpopcorn/2015/9/16/7a4441a4-8994-488e-b7bf-81fd4ef47c5d.png",
      "//i.ytimg.com/vi/lHehS1L7JtI/hqdefault.jpg",
      "https://lh3.googleusercontent.com/RPyEeMwyyz8xHD_yJYBqTqaRk576uvD05CFQZnvBqLIa4GUVwAUHlpcm6YNAG6fA8xKh=h310",
      "https://lh3.googleusercontent.com/D9zA-t17anzA1yHngbWFcCynWcuHAmysohJsfe72JjveZQaMyh6dA6mGdRlaTo5wtiY=h310"
    ],
    "currenySymbol": null
  }
}

Response Details

  • version : api 버전
  • generatedDate : api 응답 시각
  • data : 세부정보
    • name : 앱 이름
    • appScheme : 안드로이드 패키지 네임 혹은 iOS app scheme
    • appKey : 앱키
    • hashKey : 해시키
    • os : OS 플랫폼 (Android or iOS)
    • thumbnailImage : 썸네일 이미지
    • marketUrl : 마켓 주소
    • screenShotUrl : 앱 스크린 샷
    • hashKey : 해시키
    • currencySymbol : 가상화폐이름 ( 가상화폐 등록이 필요한 서비스를 이용할 때 리턴)




애드브릭스 리포트 조회

요청한 토큰에 해당하는 애드브릭스 리포트 정보를 조회할 수 있습니다.


API

GET : 
~/v4/Metrics?access_token={발급받은_토큰키}&startDate={조회시작날짜}&endDate={조회종료날짜}

Example Request

GET :
https://report.ad-brix.com/v4/Metrics?access_token=d00f4e0d76497033f5d82d53987c1060&startDate=2015-09-09&endDate=2015-09-10

Example Response

{
    version: "4.0",
    generatedDate: "2016-07-29T17:47:30.5878507+09:00",
    fromDate: "2015-09-09T00:00:00",
    toDate: "2015-09-10T00:00:00",
    datas: [
        {
            reportAt: "20150910",
            dailyActiveUser: 0,
            weeklyActiveUser: 0,
            monthlyActiveUser: 0,
            retentionUser: 0,
            newUser: 0,
            underOneMinuteUser: 0,
            runCount: 0,
            oneDay: 0,
            twoDay: 0,
            threeDay: 0,
            fourDay: 0,
            fiveDay: 0,
            sixDay: 0,
            sevenDay: 0,
            fourteenDay: 0,
            fifteenDay: 0,
            thirtyDay: 0,
            oneWeek: 0,
            twoWeek: 0,
            threeWeek: 0,
            fourWeek: 0
        },
        {
            reportAt: "20150909",
            dailyActiveUser: 0,
            weeklyActiveUser: 0,
            monthlyActiveUser: 0,
            retentionUser: 0,
            newUser: 0,
            underOneMinuteUser: 0,
            runCount: 0,
            oneDay: 0,
            twoDay: 0,
            threeDay: 0,
            fourDay: 0,
            fiveDay: 0,
            sixDay: 0,
            sevenDay: 0,
            fourteenDay: 0,
            fifteenDay: 0,
            thirtyDay: 0,
            oneWeek: 0,
            twoWeek: 0,
            threeWeek: 0,
            fourWeek: 0
        }
    ]
}

Response Details

  • generatedDate : 데이터를 조회를 요청한 시각
  • fromDate : 조회 대상 시작 날짜
  • toDate : 조회 대상 종료 날짜
  • version : 조회 api 버전
  • datas : 상세 데이터
    • reportAt : 현재 데이터 날짜
    • dailyActiveUser : DAU
    • weeklyActiveUser : WAU
    • monthlyActiveUser : MAU
    • retUser : 재방문 유저
    • newUser : 신규유저
    • underOneMinuteUser : 1분 미만 실행 유저
    • runCount : 실행횟수
    • oneDayRetentionUser : 1일 실행 유저
    • twoDayRetentionUser : 2일 연속 실행 유저
    • threeDayRetentionUser : 3일 연속 실행 유저
    • fourDayRetentionUser : 4일 연속 실행 유저
    • fiveDayRetentionUser : 5일 연속 실행 유저
    • sixDayRetentionUser : 6일 연속 실행 유저
    • sevenDayRetentionUser : 7일 연속 실행 유저
    • oneWeekRetentionUser : 1주일 연속 실행 유저
    • twoWeekRetentionUser : 2주일 연속 실행 유저
    • threeWeekRetentionUser : 3주일 연속 실행 유저
    • fourWeekRetentionUser : 4주일 연속 실행 유저




트래킹링크 메타 정보 조회

요청한 토큰에 해당하는 트래킹링크 메타 정보를 조회할 수 있습니다.


API

GET :
~/v4/TrackingLink/AllList?access_token={발급한토큰값}

Example Request

GET :
https://report.ad-brix.com/v4/TrackingLink/AllList?access_token=d00f4e0d76497033f5d82d53987c1060

Example Response

{
    "version": "4.0",
    "generatedDate": "2016-05-03T15:04:24.7024655+09:00",
    "pageNo": 1,
    "limit": 50,
    "totalCount": 166,
    "nextConversionUrl": "https://report.ad-brix.com/v4/TrackingLink/AllList?access_token=d00f4e0d76497033f5d82d53987c1060&page_no=2",
    "datas": [{
        "appkey": 493312809,
        "conversionKey": 6464330,
        "conversionName": "testads",
        "thumbnailImage": null,
        "channelName": "test",
        "channelNo": 5666,
        "landingUrl": "market://details?id=igaworks.integration.testapp",
        "rewardType": null,
        "costType": null,
        "campaignType": null,
        "registeredDate": "2016-05-02T14:00:45.13",
        "updatedDate": "2016-05-02T14:02:25.873",
        "isSubConversion": false,
        "conversionUrl": "https://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=6464330",
        "subConversions": null
    }, {
        "appkey": 493312809,
        "conversionKey": 688492,
        "conversionName": "testads",
        "thumbnailImage": null,
        "channelName": "testads",
        "channelNo": 3378,
        "landingUrl": "market://details?id=igaworks.integration.testapp",
        "rewardType": null,
        "costType": null,
        "campaignType": null,
        "registeredDate": "2016-04-27T10:09:25.103",
        "updatedDate": "2016-04-27T10:09:25.103",
        "isSubConversion": true,
        "conversionUrl": "https://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=688492&cb_param1=testads&cb_param2=testads",
        "subConversions": {
            "subConversionCount": 1,
            "nextSubConversionUrl": null,
            "subConversion": [{
                "appkey": 493312809,
                "conversionKey": 688492,
                "subConversionKey": "9723124",
                "subConversionName": "sublink",
                "rewardType": null,
                "costType": null,
                "campaignType": null,
                "thumbnailImage": "",
                "registeredDate": "2016-05-03T15:04:18.36",
                "updatedDate": "2016-05-03T15:04:18.36",
                "subConversionUrl": "https://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=688492&sub_referral=9723124&cb_param1=TAPJOY_APP_ID&cb_param2=TAPJOY_RAW_ANDROID_ID"
            }]
        }
    }, 
    중략
    ]
}

Response Details

  • version : 조회 API 버전
  • generatedDate : 조회를 요청한 시각
  • pageNo : 데이터가 많을 경우 페이징처리된 페이지 넘버
  • limit : 1페이지 당 최대 데이터 수,
  • totalCount : 총 데이터 수,
  • nextConversionUrl : 다음 데이터 페이지 링크,
  • datas : 세부정보
    • appKey : 앱키
    • conversionKey : 컨버전키 (=트래킹링크 식별키)
    • conversionName : 컨버전명 (=트래킹링크 이름)
    • thumbnailImage : 트래킹링크 관리용 이미지 URL
    • channelName : 트래킹링크 채널명
    • channelNo : 트래킹링크 채널넘버
    • LandingUrl : 마켓주소(=트래킹링크 랜딩주소)
    • rewardType : 트래킹링크 캠페인의 리워드 타입
    • costType : 트래킹링크로 진행되는 캠페인의 정산 방식
    • campaignType : 트래킹링크로 진행되는 캠페인 타입
    • registedDate : 트래킹링크 생성시각
    • updatedDate : 트래킹링크 수정시각
    • isSubConversion : 서브컨버전 존재유무
    • conversionUrl : 트래킹링크Url
    • subConversions : 서브컨버전 정보(=서브트래킹링크 정보)
      • appKey : 앱키
      • conversionKey : 컨버전키(=트래킹링크 식별값)
      • subConversionKey : 서브컨버전키(=서브트래킹링크 식별값)
      • subConversionName : 서브컨버전네임(=서브트래킹링크 이름)
      • thumbnailImg : 서브트래킹링크 관리용 이미지
      • registedDate : 서브트래킹링크 생성시각
      • updatedDate : 서브트래킹링크 수정시각
      • subConversionUrl : 서브컨버전Url(=서브트래킹링크Url)




트래킹링크 채널 메타 정보 조회

애드브릭스에 등록된 트래킹링크 채널 메타 정보를 조회합니다.

API

GET :
~/v4/TrackingLink/GetChannel?access_token={발급한토큰값}

Example Request

GET :
https://report.ad-brix.com/v4/TrackingLink/GetChannel?access_token=6ed8a26ce0447cecdf12cc32bd24c3e9

Example Response

{
    version: "4.0",
    generatedDate: "2015-10-20T10:44:20.8591614+09:00",
    datas: [
        {
            channelNo: 1,
            channelName: "Ad@m",
            isPostback: false
        },
        {
            channelNo: 2,
            channelName: "InMobi",
            isPostback: true
        }, {중략}
    ]
}

Response Details

  • version : 조회 api 버전
  • generatedDate : api 응답 시각
  • datas : 상세정보
    • channelNo : 채널넘버
    • channelName : 채널명
    • isPostback : 포스트백 설정여부




트래킹링크 컨버전 리포트 조회

특정 트래킹링크에 대해서 컨버전(신규실행) 정보를 조회할 수 있습니다.


조회 : 전체기간 

특정 트래킹링크의 모든 컨버전 정보를 조회합니다.

API

GET :
~/v4/TrackingLink/GetConversionDetail?access_token={발급한토큰값}&ck={컨버전키}

Optional Parameter

  • start_date : 조회시작날짜( yyyy-MM-dd )
  • end_date : 조회종료날짜( yyyy-MM-dd )


Example Request

GET :
https://report.ad-brix.com/v4/TrackingLink/GetConversionDetail?access_token=d00f4e0d76497033f5d82d53987c1060&ck=1095259

Example Response

{
    "version": "4.0",
    "generatedDate": "2016-05-03T14:52:30.3623207+09:00",
    "completeDate": "2016-05-02",
    "data": {
        "conversionName": "트래킹링크 샘플 3",
        "conversionKey": 1095259,
        "channelName": "Syrup ad",
        "channelNo": 6,
        "landingUrl": "https://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259",
        "appKey": 493312809,
        "thumbnailImage": "https://partners.igaworks.com/Content/theme/images/adbrix_app_default.png",
        "registeredUserId": "dev@igaworks.com",
        "registeredUserName": "개발팀",
        "registeredDate": "2015-09-16T15:57:26.79",
        "costType": null,
        "campaignType": null,
        "rewardType": null,
        "thirdPartyCampaignId": null,
        "thirdPartyConversionId": "",
        "thirdPartyConversionLabel": null,
        "clickCount": 0,
        "conversionCount": 0,
        "installCount": 0,
        "cvr": 0.0,
        "subConversionInfos": [{
            "appkey": 493312809,
            "conversionKey": 1095259,
            "subConversionKey": null,
            "subConversionName": "basic",
            "rewardType": null,
            "costType": null,
            "campaignType": null,
            "thumbnailImage": "https://partners.igaworks.com/Content/theme/images/adbrix_app_default.png",
            "registeredDate": "2015-09-16T15:57:26.79",
            "updatedDate": "2015-09-16T15:57:26.787",
            "clickCount": 0,
            "conversionCount": 0,
            "cvr": 0.0,
            "installCount": 0,
            "subConversionUrl": "https://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259"
        }, {
            "appkey": 493312809,
            "conversionKey": 1095259,
            "subConversionKey": "8414567",
            "subConversionName": "서브트래킹링크A",
            "rewardType": null,
            "costType": null,
            "campaignType": null,
            "thumbnailImage": "http://static.adbrix.igaworks.com/adpopcorn/2015/9/16/1b47ba45-f038-4a80-b96d-03b6ecf66676.png",
            "registeredDate": "2015-09-16T16:03:36.293",
            "updatedDate": "2015-09-16T16:03:36.293",
            "clickCount": 0,
            "conversionCount": 0,
            "cvr": 0.0,
            "installCount": 0,
            "subConversionUrl": "https://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259&sub_referral=8414567"
        }, {
            "appkey": 493312809,
            "conversionKey": 1095259,
            "subConversionKey": "9916840",
            "subConversionName": "서브트래킹링크B",
            "rewardType": null,
            "costType": null,
            "campaignType": null,
            "thumbnailImage": "http://static.adbrix.igaworks.com/adpopcorn/2015/9/16/4922d2e1-1e45-403d-8028-57d511651af8.png",
            "registeredDate": "2015-09-16T16:03:55.52",
            "updatedDate": "2015-09-16T16:03:55.52",
            "clickCount": 0,
            "conversionCount": 0,
            "cvr": 0.0,
            "installCount": 0,
            "subConversionUrl": "https://ref.ad-brix.com/v1/referrallink?ak=493312809&ck=1095259&sub_referral=9916840"
        }]
    }
}

Response Details

  • version : 조회 api 버전
  • generatedDate : api 응답 시각
  • completeDate : 데이터 확정 날짜
  • datas : 상세정보
    • conversionName : 컨버전명(=트래킹링크이름)
    • conversionKey : 컨버전키(=트래킹링크식별값)
    • channelName : 트래킹링크 채널명
    • landingUrl : 랜딩URL
    • appKey : 앱키
    • thumbnailImage : 트래킹링크 썸네일 이미지(옵션:관리용)
    • registeredUserId : 트래킹링크 생성 유저 아이디
    • registeredUserName : 트래킹링크 생성 유저명
    • registeredDate : 트래킹링크 생성 시각
    • thirdPartyConversionId : 구글 애드워즈 연동 아이디
    • thirdPartyConversionLabel : 구글 애드워즈 연동 라벨
    • clickCount : 세션 카운트 (=트래킹링크 클릭 수)
    • conversionCount : 컨버전 카운트(=신규 유입 수)
    • thirdPartyConversionCount : 실행 카운트(애드워즈 사용 시 집계)
    • cvr : 트래킹링크 컨버전율 (= 컨버전카운트/세션카운트*100)
    • subConversionInfos : 서브 컨버전 정보 (=서브트래킹링크 정보)
      • appkey : 앱키
      • conversionKey : 부모 컨버전키 (=부모 트래킹링크 식별값)
      • subConversionKey : 서브 컨버전키 (=서브 트래킹링크 식별값)
      • subConversionName : 서브 컨버전명 (=서브 트래킹링크 이름)
      • thumbnailImage : 서브 트래킹링크 썸네일 이미지(옵션 : 관리용)
      • registedDate : 서브 트래킹링크 생성 시각
      • updatedDate : 서브 트래킹링크 수정 시각
      • clickCount : 서브 트래킹링크 세션 카운트 (=서브 트래킹링크 클릭 수)
      • conversionCount : 서브 트래킹링크 컨버전 카운트 (=서브 트래킹링크 신유유입 수)
      • cvr : 서브 트래킹링크 컨버전율 (=서브 트래킹링크 컨버전 카운트/서브 트래킹링크 세션 카운트 * 100)
      • thirdPartyConversionCount : 서브 트래킹링크 실행 카운트 (애드워즈 사용시 집계)
      • subConversionUrl : 서브 컨버전 URL (=서브 트래킹링크 URL)


조회 : 특정기간

특정 트래킹링크의 일별, 시간대별 컨버전 정보를 조회합니다.

API

~/v4/TrackingLink/GetConversionPeriodicInfo?access_token={발급받은 토큰키}&ck={트래킹링크 식별값}&start_date={조회시작날짜}&end_date={조회종료날짜}&time_span={시간구분타입}

*time_span prameter :   day-일별 리포트 , hour-시간대별 리포트

Example Request

https://report.ad-brix.com/v4/TrackingLink/GetConversionPeriodicInfo?access_token=d00f4e0d76497033f5d82d53987c1060&ck=1095259&start_date=2015-09-14&end_date=2015-09-16&time_span=day

Example Response

{
    "version": "4.0",
    "generatedDate": "2016-05-03T15:00:50.4831119+09:00",
    "completeDate": "2016-05-02",
    "data": {
        "conversionKey": 1095259,
        "conversionName": "트래킹링크 샘플 3",
        "channelNo": 6,
        "channelName": "Syrup ad",
        "rewardType": null,
        "costType": null,
        "campaignType": null,
        "conversionDatas": [{
            "reportAt": "20150916",
            "reportedHour": 0,
            "reportedDate": "0001-01-01T00:00:00",
            "clickCount": 0,
            "conversionCount": 0,
            "installCount": null,
            "cvr": 0.0
        }, {
            "reportAt": "20150915",
            "reportedHour": 0,
            "reportedDate": "0001-01-01T00:00:00",
            "clickCount": 0,
            "conversionCount": 0,
            "installCount": null,
            "cvr": 0.0
        }, {
            "reportAt": "20150914",
            "reportedHour": 0,
            "reportedDate": "0001-01-01T00:00:00",
            "clickCount": 0,
            "conversionCount": 0,
            "installCount": null,
            "cvr": 0.0
        }]
    }
}

Response Details

  • version : 조회 api 버전
  • generatedDate : api 응답 시각
  • completeDate : 데이터 확정 날짜
  • data : 상세정보
    • conversionKey : 컨버전키(=트래킹링크식별값)
    • conversionName : 컨버전명(=트래킹링크이름)
    • channelNo : 트래킹링크 채널넘버
    • channelName : 트래킹링크 채널명
    • conversionDatas : 컨버전 정보
      • reportAt :  리포트 날짜
      • reportedHour : 리포트시각
      • reportedDate : 리포트날짜
      • clickCount : 서브 트래킹링크 세션카운트 (=서브 트래킹링크 클릭 수)
      • conversionCount : 서브 트래킹링크 컨버전 카운트 (=서브 트래킹링크 신유유입 수)
      • thirdPartyConversionCount : 서브 트래킹링크 실행 카운트 (애드워즈 사용시 집계)
      • cvr : 서브 트래킹링크 컨버전율 (=서브 트래킹링크 컨버전 카운트/서브 트래킹링크 세션 카운트 * 100)