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	テレメトリイベント取り込み