These docs are for v1.0. Click to read the latest docs for v2.0.

1. Home 탭 소개

1.1 Home 탭 소개

Home 탭에서는 계정 정보, 플랜 정보, API 사용량 관련 정보를 확인할 수 있습니다.

대시보드 홈 화면

대시보드 홈 화면

1.2 계정/플랜 정보

1.2.1 계정 정보

  1. Email: 계정 ID이자 메일을 수신하는 Email 주소입니다. ID는 변경할 수 없습니다.
  2. Company: 회사명을 의미합니다. 설정에서 변경할 수 있습니다.
  3. Nickname: 담당자 이름 및 닉네임을 의미합니다. 설정에서 변경할 수 있습니다.
계정 정보

계정 정보

1.2.2 플랜 정보

  1. Plan: 현재 사용중인 플랜을 표시합니다. [Trial Plan]과 [Enterprise Plan]으로 나뉩니다.
  2. Plan Date: 현재 사용중인 플랜의 사용 기간을 표시합니다. 사용 기간이 지나면 Asleep API 사용이 중지됩니다.
  3. API Quota: 현재 계약된 API 콜 수를 표시합니다. 이 API 콜 수를 초과 사용하게 되면 Asleep API 사용이 중지됩니다. API 사용량은 이메일을 통해 정기적으로 리포팅되며, 초과 발생 위험이 감지되면 이메일로 안내합니다.
플랜 정보

플랜 정보

2. API 차트 모듈 소개

2.1 Used API Quota

  • 플랜 시작일로부터 현재까지의 API 사용량을 나타냅니다.
  • 바그래프 위에 마우스 커서를 호버하여 정확한 수치를 확인할 수 있습니다.
  • 유효 API 사용량만 집계합니다.
Used API Quota 그래프

Used API Quota 그래프

2.2 Daily API Usage

설명

  • Daily API Usage 그래프는 하루 동안의 API 사용 횟수를 나타냅니다. 이 그래프를 통해 일자별 API 호출 패턴과 횟수를 쉽게 파악할 수 있습니다.
  • 피크 사용 일, 요일 등을 알아내거나, 예상치 못한 API 호출 패턴을 발견하는 등의 인사이트를 얻을 수 있습니다.
  • UTC 시간(KST-9)을 기준으로 집계됩니다. UTC를 기준으로 익일에 전날의 정확한 API 사용량을 확인할 수 있습니다.
  • 각 일자별 포인트에 마우스 커서를 호버하여 정확한 수치를 파악할 수 있습니다.
Daily API Usage 그래프

Daily API Usage 그래프

필터

  1. Chargeable
    • 유효 API 콜 / 무효 API 콜 데이터를 따로 확인하거나, 유효+무효 API 콜을 함께 확인할 수 있습니다.
    • Chargeable: valid
      유효 API 콜을 의미하며, 수면 측정 이후 분석이 완료된 세션을 생성한 API 콜에 대해서만 나타냅니다. 이 API 콜에 대해서만 비용이 부과되며, 사용한 만큼 계약 API 콜수에서 차감됩니다.
    • Chargeable: invalid
      무효 API 콜을 의미하며, 수면 측정 이후 분석이 완료된 세션을 생한 API 콜에 대해서만 나타냅니다. 이 API 콜은 비용 책정에 사용되지 않으며, API 콜수에서 차감되지 않습니다.
    • Chargeable: total
      모든 API 콜을 나타냅니다.
필터 - Chargable

Daily API Usage 필터 - Chargeable

  1. Date
    • 조회하고 싶은 기간을 선택할 수 있습니다. 별도 조정이 없다면 현재 시점으로부터 최근 1달이 보여집니다.
    • Today: 조회하는 날의 API 사용량 데이터를 1시간 단위로 확인할 수 있습니다.
    • Last 7 days: 현재 시점으로부터 최근 7일간의 API 사용량 데이터를 확인할 수 있습니다.
    • Last 15 days: 현재 시점으로부터 최근 15일간의 API 사용량 데이터를 확인할 수 있습니다.
    • Last 30 days: 현재 시점으로부터 최근 30일간의 API 사용량 데이터를 확인할 수 있습니다.
    • Custom: 원하는 기간의 API 사용량 데이터를 달력에서 직접 선택해 확인할 수 있습니다. 일자는 최대 1달까지 선택 가능합니다.
Daily API Usage 필터 - Date

Daily API Usage 필터 - Date

  1. Per API Key / Total
    • API Key를 2개 이상 가지고 있을 경우, 데이터를 API Key별로 분리해서 보거나, 모두 합친 데이터를 볼 수 있습니다. API Key를 한개만 가지고 있다면 동일한 데이터를 보게 됩니다.
    • Per API Key: API Key 별 API 사용량 데이터를 분리해서 볼 수 있습니다. 그래프 범례를 클릭해 원하는 API Key의 데이터만 골라서 확인할 수도 있습니다.
    • Total: 모든 API Key의 데이터를 총합해 보여줍니다.
Daily Active Usage 필터 - API Key

Daily Active Usage 필터 - API Key

2.3 Daily Active Users

설명

  • Daily Active Users(DAU) 그래프는 하루동안 API를 사용한 사용자 수를 나타냅니다. API를 사용하는 사용자들의 일자별 패턴과 추세를 쉽게 파악할 수 있습니다.
  • 일자별 사용자 수를 확인함으로써 서비스의 성장률, 사용자 참여도, 그리고 피크 일/요일 등의 중요한 지표를 한 눈에 파악할 수 있습니다.
  • UTC 시간(KST-9)을 기준으로 1일 1회 집계됩니다. UTC를 기준으로 익일에 전날의 DAU를 확인할 수 있습니다.
  • 각 일자별 포인트에 마우스 커서를 호버하여 정확한 수치를 파악할 수 있습니다.
  • 무효 API를 호출한 사용자도 함께 집계됩니다.
Daily Active Users 그래프

Daily Active Users 그래프

필터

  1. Date
    • 조회하고 싶은 기간을 선택할 수 있습니다. 별도 조정이 없다면 현재 시점으로부터 최근 1달이 보여집니다.
    • Today: 조회하는 날과 이전 날의 DAU데이터를 확인할 수 있습니다.
    • Last 7 days: 현재 시점으로부터 최근 7일간의 DAU 데이터를 확인할 수 있습니다.
    • Last 15 days: 현재 시점으로부터 최근 15일간의 DAU 데이터를 확인할 수 있습니다.
    • Last 30 days: 현재 시점으로부터 최근 30일간의 DAU 데이터를 확인할 수 있습니다.
    • Custom: 원하는 기간의 DAU 데이터를 달력에서 직접 선택해 확인할 수 있습니다. 일자는 최대 1달까지 선택 가능합니다.
Daily Active Users 필터 - Date

Daily Active Users 필터 - Date

  1. Per API Key / Total
    • API Key를 2개 이상 가지고 있을 경우, DAU 정보를 API Key별로 분리해서 보거나, 모두 합친 데이터를 볼 수 있습니다. API Key를 한개만 가지고 있다면 동일한 데이터를 보게 됩니다.
    • Per API Key: API Key 별 DAU 데이터를 분리해서 볼 수 있습니다. 그래프 범례를 클릭해 원하는 API Key의 데이터만 골라서 확인할 수도 있습니다.
    • Total: 모든 API Key의 DAU 데이터를 총합해 보여줍니다.
Daily Active Users 필터 - API Key

Daily Active Users 필터 - API Key

2.4 Retention

설명

  • 2023년 4분기에 공개되는 기능입니다.
  • Retention 그래프는 사용자의 잔존율을 시각화하여 보여주는 도구입니다.
  • 이 그래프는 특정 시점에 서비스를 시작한 사용자 그룹(cohort)이 시간이 지남에 따라 얼마나 서비스를 계속 이용하는지를 나타냅니다.
  • 잔존율은 사용자가 서비스에 얼마나 오래 머무르는지, 그리고 재방문하는지 등의 중요한 지표를 나타내므로, 이를 통해 서비스의 충성도와 사용자 참여도를 평가할 수 있습니다.