RESTful APIでNEXORAの全機能をプログラムから制御。データ取得・ダッシュボード操作・アラート設定まで完全対応。
すべてのAPIリクエストはBearerトークン認証が必要です。APIキーはダッシュボードの「設定 → API」から発行できます。
ワークスペースごとに複数のAPIキーを発行できます。キーにはスコープ（読み取り専用 / 読み書き / 管理者）を設定し、最小権限の原則に従って管理することを推奨します。
# すべてのリクエストにヘッダーを付与する curl https://api.nexora.jp/v1/dashboards \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" # レスポンス例 { "data": [...], "meta": { "total": 12, "page": 1, "limit": 20 } }
すべてのエンドポイントはベースURL https://api.nexora.jp/v1 からのパスです。
| Method | Endpoint | 説明 |
|---|---|---|
| GET | /dashboards | ダッシュボード一覧を取得 |
| GET | /dashboards/{id} | 指定IDのダッシュボードを取得 |
| POST | /dashboards | 新しいダッシュボードを作成 |
| PUT | /dashboards/{id} | ダッシュボードを更新 |
| DELETE | /dashboards/{id} | ダッシュボードを削除 |
| Method | Endpoint | 説明 |
|---|---|---|
| GET | /sources | データソース一覧を取得 |
| GET | /sources/{id}/status | データソースの接続状態を確認 |
| POST | /sources | 新しいデータソースを追加 |
| DELETE | /sources/{id} | データソースを削除 |
| Method | Endpoint | 説明 |
|---|---|---|
| GET | /metrics | メトリクス定義一覧を取得 |
| GET | /metrics/{id}/data | メトリクスの時系列データを取得 |
| POST | /metrics | カスタムメトリクスを作成 |
| Method | Endpoint | 説明 |
|---|---|---|
| GET | /alerts | アラートルール一覧を取得 |
| GET | /alerts/{id}/history | アラートの発火履歴を取得 |
| POST | /alerts | 新しいアラートルールを作成 |
| PUT | /alerts/{id} | アラートルールを更新 |
| DELETE | /alerts/{id} | アラートルールを削除 |
| Method | Endpoint | 説明 |
|---|---|---|
| GET | /users | ワークスペースのメンバー一覧を取得 |
| GET | /users/me | 認証済みユーザーの情報を取得 |
| PUT | /users/{id}/role | メンバーのロールを変更 |
ダッシュボード作成のリクエストとレスポンスのサンプル。
{
"name": "売上モニタリング",
"description": "月次売上・MRR・ARRの推移",
"visibility": "team",
"tags": ["sales", "revenue"],
"widgets": [
{
"type": "line_chart",
"metric_id": "mtrc_mrr_001",
"period": "30d",
"position": { "x": 0, "y": 0, "w": 8, "h": 4 }
}
]
}
{
"id": "dash_8f2k9p3m",
"name": "売上モニタリング",
"description": "月次売上・MRR・ARRの推移",
"visibility": "team",
"tags": ["sales", "revenue"],
"widgets": [...],
"created_at": "2025-06-04T09:12:33Z",
"updated_at": "2025-06-04T09:12:33Z",
"created_by": "usr_abc123"
}
主要言語向けの公式SDKをご用意。型安全・エラーハンドリング・リトライ処理を内包しています。