[Airbridge] Api 호출 수 트래킹

개요

api 호출 수를 트래킹하기 위해 airbridge를 사용하게 되었습니다. 본래 airbridge는 광고 성과 분석을 하는데에 사용되는 툴이지만 이벤트를 에어브릿지 서버로 보내고 이를 쉽게 조회하고 필터링할 수 있기 때문에 사용하게 되었습니다.

 

api 호출 수를 트래킹하기 위한 방안을 찾던 중 에어브릿지를 활용하는 방법은 찾지 못했기에 이런 방법도 있다는 것을 알리자는 취지로 글을 작성하게 되었습니다.

 

사전 준비

먼저 에어브릿지를 사용하기 위해서는 아래 간단한 과정을 거쳐야 합니다.

1. 에어브릿지 회원가입
2. 앱 등록

에어브릿지는 아래 페이지에서 이메일, 비밀번호만으로 간편하게 회원가입 할 수 있습니다.

https://www.airbridge.io/ko

에어브릿지 | 모바일 앱 성장을 극대화하세요.

이후 아래와 같은 화면에서 앱을 등록하면 됩니다.

 

저는 website를 고르고 서비스를 소개하는 간단한 웹페이지 URL을 입력했는데, 단순히 api 호출 수를 트래킹 하는 목적을 위해서면 꼭 올바른 웹페이지를 넣지 않아도 됩니다. 어차피 에어브릿지에서 제공하는 api를 호출하고, 그 결과를 에어브릿지에서 모니터링 할 것이기 때문입니다.

 

만일 sdk를 사용하거나 서비스 내 광고 성과 트래킹 등 더 복잡한 기능을 사용하려면 실제 동작하는 앱/URL를 넣어주셔야 합니다.

앱을 등록하고 나면 아래와 같이 등록한 앱 목록을 확인할 수 있게 됩니다.

 

Api 호출 수 트래킹하기

이제 에어브릿지의 Server To Server Event Api를 활용해 에어브릿지 서버로 이벤트를 전송해보도록 하겠습니다. 해당 api의 docs는 아래 링크에서 확인할 수 있습니다.

https://help.airbridge.io/ko/references/s2s-event#%EC%9D%B8%EC%9B%B9-%EC%9D%B4%EB%B2%A4%ED%8A%B8-%EC%A0%84%EC%86%A1%ED%95%98%EA%B8%B0

Server To Server Event | Airbridge Help Center

 

앱 이름을 클릭해 실제 앱 대시보드로 이동한 뒤 Settings-Tokens에서 API 토큰을 미리 복사해둡니다.

그리고 문서에 따르면 header에 API토큰을, 링크에 appName을 넣어야 합니다. 그리고 위 docs에 예시로 주어진 payload를 이용해 필수 요소가 아닌것들을 지워 아래와 같이 단순화하였습니다. ClientId와 ShortId는 예시로 주어진 payload에 있는 값을 그대로 활용했습니다.

 

또 Label은 이후 이벤트를 그룹화 할 때 사용되니 개발환경별로 다르게 설정하였습니다. (dev, prod 등)

const body = {
    eventTimestamp: Date.now(),
    browser: {
      clientID: '05609013-bb5a-4594-bbc3-832cb1b87072',
    },
    eventData: {
      shortID: "aef04",
      goal: {
        category,
        label: config.airbridgeLabel,  //(dev, prod 등)
      },
    },
  };

저는 카테고리에 이벤트 이름을 넣었습니다. (signUp, login 등) 이후 아래와 같이 모듈화하여 원하는 이벤트를 전송할 수 있도록 하였습니다.

const sendApiEvent = async (category: string) => {
  const body = {
    eventTimestamp: Date.now(),
    browser: {
      clientID: '05609013-bb5a-4594-bbc3-832cb1b87072',
    },
    eventData: {
      shortID: "aef04",
      goal: {
        category,
        label: config.airbridgeLabel,  //(dev, prod 등)
      },
    },
  };
  const head = {
    headers: { Authorization: `Bearer ${config.airbridgeToken}` },
  };
  try {
    const result = await axios.post(
      `https://api.airbridge.io/events/v1/apps/${config.airbridgeAppName}/web/9320`,
      body,
      head,
    );
    return result;
  } catch (error) {
    throw error
  }
};

이렇게 해서 전송된 이벤트들은 대시보드의 Reports-Actuals에서 조회할 수 있습니다. 아래 사진에서는 메트릭에서 WEB2_NFT_CREATE와 같은 것들이 미리 지정한 이벤트 이름들입니다. 다만 처음으로 보내는 이벤트는 반영되기까지 5-10분 정도, 이미 보낸 적 있는 api의 호출 수가 증가하기 까지는 약 30초정도가 소요되는 듯 합니다.

 

 

그룹 바이에서 Event Label를 클릭하면 이벤트 라벨별로 이벤트 횟수를 조회할 수 있습니다.