API 개요

Framedash REST API를 사용하여 텔레메트리 데이터의 조회 및 분석을 수행할 수 있습니다.

참고

상세 API 레퍼런스 페이지는 영어로만 제공됩니다. 사이드바의 “Framedash API” 섹션을 참조하세요.

기본 URL

서비스	URL
Web API (Projects, Maps, Content, Query, Analytics, Alerts)	https://api.framedash.dev/api
Ingest API (Event Ingestion)	https://ingest.framedash.dev

인증

모든 요청에 API 키가 필요합니다. X-API-Key 헤더로 전송합니다:

X-API-Key: fd_your_api_key_here

API 키는 대시보드의 “설정” > “API 키”에서 발급할 수 있습니다.

API 키 유형

유형	용도
admin	Web API 엔드포인트 전체 접근
write	이벤트 수집만
ci	CI 빌드용 이벤트 수집 (과금 우회)

속도 제한

플랜에 따른 속도 제한이 적용됩니다. 응답 헤더로 확인할 수 있습니다:

X-RateLimit-Limit: 2000
X-RateLimit-Remaining: 1999
X-RateLimit-Reset: 1700000000

응답 형식

Web API

성공 시:

{
  "success": true,
  "data": { ... }
}

오류 시:

{
  "success": false,
  "error": "Error message"
}

Ingest API

성공 시:

{
  "status": "accepted"
}

오류 시:

{
  "error": "Error message"
}

OpenAPI 스펙

API 스펙은 OpenAPI 3.1 형식으로 다운로드할 수 있습니다.

엔드포인트

상세 정보는 사이드바의 자동 생성 API 레퍼런스를 참조하세요.

Projects

엔드포인트	메서드	설명
/v1/projects	GET	프로젝트 목록
/v1/projects/{id}/status	GET	프로젝트 상태

Analytics

엔드포인트	메서드	설명
/v1/projects/{id}/dashboard	GET	대시보드 지표 (DAU, MAU, 세션, 이벤트)
/v1/projects/{id}/heatmap	GET	맵 히트맵 데이터
/v1/projects/{id}/retention	GET	플레이어 리텐션 코호트
/v1/projects/{id}/funnels	GET	퍼널 전환 분석
/v1/projects/{id}/insights	GET	차원별 집계 분석

Alerts

엔드포인트	메서드	설명
/v1/projects/{id}/alerts	GET	알림 규칙 목록
/v1/projects/{id}/alerts	POST	알림 규칙 생성
/v1/projects/{id}/alerts/{alertId}	GET	알림 규칙 조회
/v1/projects/{id}/alerts/{alertId}	PATCH	알림 규칙 업데이트
/v1/projects/{id}/alerts/{alertId}	DELETE	알림 규칙 비활성화
/v1/projects/{id}/alerts/history	GET	알림 평가 이력

Maps

엔드포인트	메서드	설명
/v1/projects/{id}/maps	GET	맵 목록
/v1/projects/{id}/maps/{mapId}	DELETE	맵 삭제
/v1/maps/upload	POST	맵 업로드

Content Registry

엔드포인트	메서드	설명
/v1/content	GET	콘텐츠 항목 목록
/v1/content	POST	콘텐츠 항목 생성/업데이트
/v1/content	DELETE	콘텐츠 항목 삭제

Query

엔드포인트	메서드	설명
/v1/query	POST	분석 쿼리 실행

Event Ingestion

엔드포인트	메서드	설명
/v1/events	POST	텔레메트리 이벤트 수집