Tracking Link

    에어브릿지의 트래킹 링크는 다양한 환경에 대응하는 올인원 링크입니다.

    트래킹 링크를 통해 다양한 플랫폼, 채널, 상황에서 링크를 클릭하는 유저를 원하는 목적지에 도달시키며, 링크 클릭, 클릭 후 설치, 설치 후 구매 행동 등 유저들로부터 발생한 행동에 어떤 채널이 기여되었는지 분석할 수 있습니다.

    트래킹 링크 API 토큰 활용

    클라이언트에서 트래킹 링크를 생성하고자 하는 경우 '트래킹 링크 API 토큰' 활용을 권장합니다.


    생성하기

    POST

    https://api.airbridge.io/v1/tracking-links

    트래킹 링크를 생성합니다.

    Request

    Headers

    Accept-Language
    string

    API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.

    Content-Type
    string

    리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.

    Authorization
    string

    API 요청에 사용하는 키값입니다. 을 확인하여 획득할 수 있습니다.

    Body Params

    channel
    필수string

    터치포인트와 컨버젼이 발생한 채널명.

    에어브릿지의 채널은 S2S 형태의 포스트백이 연동된 Integrated 채널과 직접 생성할 수 있는 Custom 채널로 나뉘어집니다.

    Integrated 채널은 [Integrated Channel] 에서 확인할 수 있습니다. Integrated 채널 이외에 모든 채널은 Custom 채널입니다.

    campaignParams
    object

    트래킹 링크에 들어갈 캠페인 파라미터.

    isReengagement
    enum

    Re-engagement 파라미터.

    ENUM VALUES
    OFF

    해당 트래킹링크에 발생한 터치포인트로 설치 및 인앱 이벤트를 기여합니다.

    ON-TRUE

    딥링크 오픈 및 그에 기인한 이벤트만 기여됩니다. Re-engagement 캠페인에 활용 가능합니다.

    ON-FALSE

    설치 이벤트 및 그에 기인한 인앱 이벤트만 기여됩니다. UA 캠페인에 활용 가능합니다.

    deeplinkUrl
    stringnullable

    리다이렉트할 딥링크 URL.

    deeplinkUrl이 없거나 null일 경우 deeplink가 설정되지 않습니다.

    fallbackPaths
    object

    플랫폼별 리다이렉트 경로.

    ogTag
    object

    트래킹 링크를 공유 혹은 게시하면 노출되는 썸네일의 미리보기(Open Graph).

    customShortId
    string

    Custom 채널의 트래킹 링크 생성시 축약된 링크 숏 아이디.

    입력하지 않으면 랜덤 아이디가 생성되며, 트래킹 링크 생성 완료 후에는 변경할 수 없습니다.

    Request
    12345
    curl -X POST 'https://api.airbridge.io/v1/tracking-links' \
      -H 'Accept-Language: ko' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
      -d '{"channel":"my-channel","campaignParams":{"campaign":"2022_FW_Sale_Festival","ad_group":"UA","ad_creative":"Coat_840x600"},"isReengagement":"ON-TRUE","fallbackPaths":{"option":{"iosCustomProductPageId":"5ae82ffe-1f08-428d-b352-ac1c3a22aa1e","googlePlayCustomStoreListing":"custom-store-listing"}},"ogTag":{"title":"30% Off Winter Apparel for 3 Days Only","description":"Get great deals on apparel to keep you warm this winter","imageUrl":"https://static.airbridge.io/images/2021_airbridge_og_tag.png"}}'
    Payload
    1234567891011121314151617181920
    {
      "channel": "my-channel",
      "campaignParams": {
        "campaign": "2022_FW_Sale_Festival",
        "ad_group": "UA",
        "ad_creative": "Coat_840x600"
      },
      "isReengagement": "ON-TRUE",
      "fallbackPaths": {
        "option": {
          "iosCustomProductPageId": "5ae82ffe-1f08-428d-b352-ac1c3a22aa1e",
          "googlePlayCustomStoreListing": "custom-store-listing"
        }
      },
      "ogTag": {
        "title": "30% Off Winter Apparel for 3 Days Only",
        "description": "Get great deals on apparel to keep you warm this winter",
        "imageUrl": "https://static.airbridge.io/images/2021_airbridge_og_tag.png"
      }
    }

    Response

    200SUCCESS

    파라미터

    설명

    trackingLink.id

    트래킹 링크의 ID

    trackingLink.channelType

    트래킹 링크의 채널 타입

    trackingLink.link.impression

    조회 이벤트를 발생시키는 트래킹 링크

    trackingLink.link.click

    클릭 이벤트를 발생시키는 트래킹 링크

    trackingLink.link.serverToServerClick

    S2S 이벤트를 발생시키는 트래킹 링크

    trackingLink.shortId

    단축 URL의 ID

    trackingLink.shortURL

    단축 URL

    trackingLink.trackingTemplateID

    트래킹 링크의 템플릿 ID

    404ERROR

    입력한 필드에 오류가 있거나 해당하는 앱이 없습니다.

    422ERROR

    필드가 누락되었거나 오류가 있습니다.

    Response
    12345678910111213141516
    {
      "data": {
        "trackingLink": {
          "id": 10000,
          "link": {
            "click": "http://abr.ge/@airbridge/my-channel?...",
            "impression": "http://abr.ge/@airbridge/my-channel?...",
            "serverToServerClick": null
          },
          "shortId": "6nwx4w",
          "shortURL": "http://abr.ge/6nwx4w",
          "channelType": "custom",
          "trackingTemplateID": "706f9839a7b50d87ab917dbb1b9fa7f3"
        }
      }
    }

    세부 정보 가져오기

    GET

    https://api.airbridge.io/v1/tracking-links/{id}

    트래킹 링크의 세부 정보를 조회합니다.

    Request

    Headers

    Accept-Language
    string

    API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.

    Content-Type
    string

    리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.

    Authorization
    string

    API 요청에 사용하는 키값입니다. 을 확인하여 획득할 수 있습니다.

    Path Params

    id
    필수string

    트래킹 링크 식별자. idType를 활용하면 트래킹 링크 식별자로 트래킹 링크 ID 대신 숏 링크 ID와 트래킹 링크 템플릿 ID를 사용할 수 있습니다. idType을 입력하지 않으면 트래킹 링크 식별자로 트래킹 링크 ID를 사용합니다.

    트래킹 링크 ID는 목록 가져오기 API를 통해 확인할 수 있습니다. 숏 링크 ID와 트래킹 링크 템플릿 ID는 에어브릿지 대시보드에서 확인할 수 있습니다.

    Body Params

    idType
    string

    트래킹 링크 식별자의 형식. 기본 설정은 id입니다.

    • id: 일반적인 트래킹 링크의 식별자입니다. 목록 가져오기 API를 통해 확인할 수 있습니다.

    • shortId: 숏 링크 ID입니다. 숏 링크는 숏 링크 형식의 트래킹 링크입니다.

    • trackingTemplateId: 트래킹 링크 템플릿의 ID입니다.

    Request
    12345
    curl -X GET 'https://api.airbridge.io/v1/tracking-links/10000' \
      -H 'Accept-Language: ko' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
      -d '{"idType":"id"}'
    Payload
    123
    {
      "idType": "id"
    }

    Response

    200SUCCESS

    400ERROR

    입력한 필드에 오류가 있거나 해당하는 리소스가 없습니다.

    422ERROR

    필드가 누락되었거나 오류가 있습니다.

    Response
    123456789101112131415161718192021222324252627282930313233343536373839404142
    {
      "data": {
        "link": {
          "click": "https://go.ab180.co/@ablog/my-channel?...",
          "impression": null,
          "serverToServerClick": null
        },
        "email": "contact@ab180.co",
        "ogTag": {
          "title": "AB180",
          "imageUrl": "http://static.airbridge.io/images/og_tags/50ca2e8d-07b2-4a0e-8294-f00ddb8e59ae.png",
          "description": "Discovering Metrics That Matter!"
        },
        "company": null,
        "shortId": "ri4lnp",
        "shortUrl": "https://go.ab180.co/ri4lnp",
        "createdAt": "2023-01-01T00:00:00+09:00",
        "channelName": "my-channel",
        "channelType": "custom",
        "deeplinkUrl": null,
        "fallbackPaths": {
          "ios": "itunes-appstore",
          "option": {
            "iosCustomProductPageId": null
          },
          "android": "google-play",
          "desktop": "https://airbridge.io"
        },
        "campaignParams": {
          "term": null,
          "subId": null,
          "subId1": null,
          "subId2": null,
          "subId3": null,
          "adGroup": null,
          "content": null,
          "campaign": "my-campaign",
          "adCreative": null
        },
        "isReengagement": false
      }
    }

    소셜 쉐어 프리뷰 수정하기

    PATCH

    https://api.airbridge.io/v1/tracking-links/{id}/og-tag

    트래킹 링크의 소셜 쉐어 프리뷰를 수정합니다.

    Request

    Headers

    Accept-Language
    string

    API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.

    Content-Type
    string

    리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.

    Authorization
    string

    API 요청에 사용하는 키값입니다. 을 확인하여 획득할 수 있습니다.

    Path Params

    id
    필수string

    트래킹 링크 식별자. idType를 활용하면 트래킹 링크 식별자로 트래킹 링크 ID 대신 숏 링크 ID와 트래킹 링크 템플릿 ID를 사용할 수 있습니다. idType을 입력하지 않으면 트래킹 링크 식별자로 트래킹 링크 ID를 사용합니다.

    트래킹 링크 ID는 목록 가져오기 API를 통해 확인할 수 있습니다. 숏 링크 ID와 트래킹 링크 템플릿 ID는 에어브릿지 대시보드에서 확인할 수 있습니다.

    Body Params

    idType
    string

    트래킹 링크 식별자의 형식. 기본 설정은 id입니다.

    • id: 일반적인 트래킹 링크의 식별자입니다. 목록 가져오기 API를 통해 확인할 수 있습니다.

    • shortId: 숏 링크 ID입니다. 숏 링크는 숏 링크 형식의 트래킹 링크입니다.

    • trackingTemplateId: 트래킹 링크 템플릿의 ID입니다.

    title
    필수string

    트래킹 링크의 og:title

    description
    필수string

    트래킹 링크의 og:description

    imageUrl
    필수string

    트래킹 링크의 og:image

    Request
    12345
    curl -X PATCH 'https://api.airbridge.io/v1/tracking-links/10000/og-tag' \
      -H 'Accept-Language: ko' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
      -d '{"idType":"id","title":"30% Off Winter Apparel for 3 Days Only","description":"Get great deals on apparel to keep you warm this winter","imageUrl":"https://static.airbridge.io/images/2021_airbridge_og_tag.png"}'
    Payload
    123456
    {
      "idType": "id",
      "title": "30% Off Winter Apparel for 3 Days Only",
      "description": "Get great deals on apparel to keep you warm this winter",
      "imageUrl": "https://static.airbridge.io/images/2021_airbridge_og_tag.png"
    }

    Response

    200SUCCESS

    404ERROR

    입력한 필드에 오류가 있거나 해당하는 리소스가 없습니다.

    Response
    1
    {}

    경로 수정하기

    PATCH

    https://api.airbridge.io/v1/tracking-links/{id}/routing

    트래킹 링크의 최종 목적지 및 Fallback 경로를 수정합니다.

    Request

    Headers

    Accept-Language
    string

    API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.

    Content-Type
    string

    리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.

    Authorization
    string

    API 요청에 사용하는 키값입니다. 을 확인하여 획득할 수 있습니다.

    Path Params

    id
    필수string

    트래킹 링크 식별자. idType를 활용하면 트래킹 링크 식별자로 트래킹 링크 ID 대신 숏 링크 ID와 트래킹 링크 템플릿 ID를 사용할 수 있습니다. idType을 입력하지 않으면 트래킹 링크 식별자로 트래킹 링크 ID를 사용합니다.

    트래킹 링크 ID는 목록 가져오기 API를 통해 확인할 수 있습니다. 숏 링크 ID와 트래킹 링크 템플릿 ID는 에어브릿지 대시보드에서 확인할 수 있습니다.

    Query Params

    idType
    string

    트래킹 링크 식별자의 형식. 기본 설정은 id입니다.

    • id: 일반적인 트래킹 링크의 식별자입니다. 목록 가져오기 API를 통해 확인할 수 있습니다.

    • shortId: 숏 링크 ID입니다. 숏 링크는 숏 링크 형식의 트래킹 링크입니다.

    • trackingTemplateId: 트래킹 링크 템플릿의 ID입니다.

    Body Params

    deeplinkUrl
    stringnullable

    리다이렉트할 딥링크 URL.

    deeplinkUrl이 없거나 null일 경우 deeplink가 설정되지 않습니다.

    fallbackPaths
    object

    플랫폼별 리다이렉트 경로.

    option
    object

    fallback의 옵션을 설정합니다.

    Request
    12345
    curl -X PATCH 'https://api.airbridge.io/v1/tracking-links/10000/routing' \
      -H 'Accept-Language: ko' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}' \
      -d '{}'
    Payload
    1
    {}

    Response

    200SUCCESS

    404ERROR

    입력한 필드에 오류가 있거나 해당하는 리소스가 없습니다.

    Response
    1
    {}

    목록 가져오기

    GET

    https://api.airbridge.io/v1/tracking-links

    생성한 트래킹 링크 목록을 불러옵니다.

    Request

    Headers

    Accept-Language
    string

    API 요청 및 결과 반환에 사용할 언어를 지정할 수 있습니다. ISO-639-1 포맷을 따릅니다.

    Content-Type
    string

    리소스의 미디어 타입을 나타냅니다. 기본값으로 application/json을 사용합니다.

    Authorization
    string

    API 요청에 사용하는 키값입니다. 을 확인하여 획득할 수 있습니다.

    Query Params

    from
    필수string

    생성한 트래킹 링크 목록을 조회할 기준 시작일.

    to
    필수string

    생성한 트래킹 링크 목록을 조회할 기준 종료일.

    skip
    number

    건너뛸 item의 갯수.

    size
    number

    가져올 item의 갯수. (최대 500)

    keyword
    string

    검색 키워드.

    channel_name
    string

    채널 명 필터.

    sort_key
    enum

    정렬 기준 (기본값: createdAt)

    ENUM VALUES
    createdAt

    생성 순 정렬

    sort_type
    enum

    정렬 타입. (기본값: DESC)

    ENUM VALUES
    DESC

    내림차순 정렬.

    ASC

    오름차순 정렬.

    Request
    1234
    curl -X GET 'https://api.airbridge.io/v1/tracking-links?from=2023-04-01&to=2023-04-02&skip=0&size=10&sort_key=createdAt&sort_type=DESC' \
      -H 'Accept-Language: ko' \
      -H 'Content-Type: application/json' \
      -H 'Authorization: Bearer {AIRBRIDGE-API-TOKEN}'

    Response

    200SUCCESS

    400ERROR

    입력한 필드가 오류가 있거나 형태가 올바르지 않습니다.

    Response
    12345678910111213
    {
      "data": {
        "totalCount": 2,
        "trackingLinks": [
          {
            "id": 10001
          },
          {
            "id": 10002
          }
        ]
      }
    }

    도움이 되었나요?

    더 필요한 내용이 있나요?