대시보드 API 소개

대시보드 API는 mAsh 플랫폼에 구성된 대시보드(및 그 안의 위젯)에서 제공하는 통합 데이터를 외부로 손쉽게 가져오기 위한 인터페이스입니다. 개별 데이터 소스를 하나씩 연결하거나 별도 ETL 파이프라인을 설계하지 않아도, 대시보드 단위로 필요한 지표들을 구조화된 응답으로 받아올 수 있다는 점이 핵심입니다.

목적

이 문서는 mAsh 대시보드 API를 통해 통합 데이터를 수집하여 자사 시스템(예: BI, 리포팅, 알림)으로 연동하는 방법과 권장 워크플로우를 설명합니다. 또한 mAsh 활용 방식과 자체 스토리지+파이프라인 구축 방식의 장단점을 비교해, 어떤 상황에서 어떤 방식을 선택하면 좋은지 안내합니다.

통합 워크플로우(요약)

1. 대시보드 구성: mAsh에서 수집·연산된 지표를 위젯으로 배치해 커스텀 대시보드를 만듭니다.
2. 인증 토큰 발급: API 접근에 필요한 인증 토큰을 발급받습니다.
3. 대시보드 데이터 조회: 대시보드 ID와 필요한 파라미터로 API를 호출해 위젯별 데이터를 받아옵니다.
4. 데이터 활용: 수집한 데이터를 자사 BI나 리포트, 자동화 시스템에 연동합니다.

아래에 각 단계를 상세히 설명합니다.

1) 대시보드 구성

먼저 mAsh 내부에서 통합용 대시보드를 만듭니다. 예를 들어 '대시보드 API 전용'이라는 대시보드를 생성하고, 다음과 같은 위젯들을 배치할 수 있습니다:

• 구역 그룹별 핵심 지표
• 방문 횟수 히트맵

대시보드를 구성한 후, 브라우저에서 해당 대시보드의 ID를 확인합니다(대시보드 상단 브라우저 URL에서 확인 가능). 이 ID가 API 호출의 주요 식별자가 됩니다.

2) 인증 토큰 발급

대시보드 API는 인증이 필요합니다. mAsh API 인증 가이드를 참고하여 제공된 토큰 발급 방식을 통해 액세스 토큰을 발급받으세요.

3) 대시보드 데이터 조회(API 호출)

API 명세에 따라 대시보드 ID와 필요한 파라미터(예: 기간, 속성 필터)를 포함하여 호출합니다: API 명세 링크.

응답은 대시보드에 포함된 각 위젯의 메타데이터와 집계값(또는 시계열 값)을 포함한 구조화된 JSON 형태로 반환됩니다. 여러 위젯을 한 번에 받아오므로, 별도의 집계 로직 없이 mAsh에서 이미 계산된 결과를 사용할 수 있습니다.

4) 데이터 활용

수집된 데이터를 자사 BI의 데이터 모델에 매핑하여 대시보드, 리포트, 알림(예: SLA 초과 시 경보) 등에 활용합니다. mAsh에서 위젯을 수정하면 API 응답이 변경되므로, 자사 쪽 파이프라인은 주로 파싱·매핑·저장 논리에만 집중하면 됩니다.

자사 BI 연동 시나리오

mAsh 대시보드 API를 자사 BI에 연동할 때는 데이터 적재 여부에 따라 두 가지 패턴으로 나눌 수 있습니다.

• 적재가 필요한 경우

  1. mAsh에서 통합용 대시보드를 구성하고, API를 통해 주기적으로 데이터를 수집합니다.
  2. 수집한 데이터를 파싱·정규화한 뒤 자사 스토리지나 데이터웨어하우스에 적재합니다.
  3. 적재된 원본/집계 데이터를 기반으로 BI 대시보드, 리포트, 분석, 머신러닝 파이프라인 등을 운영합니다.

  고려사항: 데이터 보관 정책, 스키마 정합성, 네트워크 비용 및 적재 지연 등을 설계해야 합니다.

• 적재가 필요하지 않은 경우

  1. mAsh에서 필요한 지표를 위젯으로 구성합니다.
  2. BI 또는 리포팅 서비스에서 주기적으로 mAsh 대시보드 API를 호출하여 최신 결과를 받아오고, 임시 캐시에 저장하거나 바로 시각화합니다.

  고려사항: 응답 지연, mAsh 서비스 가용성에 따른 영향, 위젯 변경에 대한 파싱 유연성 확보가 필요합니다.

두 방식은 상황에 따라 병행 가능합니다. 초기에는 API 조회 기반으로 빠르게 연동한 뒤, 필요한 지표만 선택적으로 적재하는 하이브리드 접근을 권장합니다.

스토리지 서비스+파이프라인 구축과의 비교

구분	mAsh 대시보드 API 활용	스토리지 서비스+파이프라인 구축
개발 난이도	낮음 (API 호출만 구현, mAsh UI로 대시보드 구성)	높음 (스토리지 연동, ETL, 파이프라인 설계 및 운영 필요)
유지보수	mAsh에서 위젯/데이터 소스 변경 시 자동 반영	데이터 소스, 스키마, 파이프라인 변경 시 직접 수정 필요
실시간성	mAsh 대시보드 기준(위젯 데이터 최신화)	데이터 적재/동기화 주기에 따라 다름
확장성	mAsh 대시보드/위젯 추가만으로 확장	데이터 소스/파이프라인/스토리지 별도 확장 필요
필요한 구성 서비스	mAsh 계정·대시보드·API 접근 권한, 위젯 구성 도구	스토리지(S3/Blob), 데이터웨어하우스, ETL/오케스트레이션, 모니터링/로깅, 네트워크·보안 구성

언제 어떤 방식을 선택할까(권장 기준)

• 빠르게 통합하고 운영·유지보수를 최소화하려면: mAsh 대시보드 API 활용
• 대량 원천데이터를 장기간 보관하거나 커스텀 가공·머신러닝 파이프라인이 필요하면: 스토리지 서비스 + 파이프라인 구축

결론

mAsh 대시보드 API는 mAsh 플랫폼에서 이미 통합·가공된 지표를 빠르게 외부 시스템에 연결해야 할 때 효과적입니다. 반면, 원천데이터 수준의 장기 보관, 고도화된 가공 또는 자체 파이프라인 운영을 원할 경우 스토리지 기반 파이프라인을 선택하는 것이 더 적합합니다. 두 방식은 상호 보완적일 수 있으므로, 필요에 따라 병행하는 접근도 권장합니다.