ドキュメント

分析

アプリケーションのメトリクス、最近のアクティビティ、使用状況のクエリ、および追跡リクエスト。

英語から自動翻訳されています。英語の原文を見る

プレイグラウンド

これらのリクエストを独自の実行中のサイドカーに送信します。値はこのブラウザ内に残ります。

接続されていません

ベースURL 無記名トークン オプション セッショントークン オプション

仕組み

サイドカーは起動時に選択されたループバックポートをリッスンし、それをそのポートに出力します。 ready ライン;その URL を使用し、 CADCAMFUN_TOKEN で始まりました。リクエストはこのページからそのアドレスに直接送信されます。

サイドカーは CORS ヘッダーを Tauri オリジンと http://localhost または http://127.0.0.1 どのポートでも。ホストされているドキュメントからはブラウザーが応答をブロックするため、ドキュメントをローカルで実行します (bun run dev で packages/web) プレイグラウンドを使用するか、リクエストをcurlとしてコピーします。実際のデータに触れることなく実験するには、次のようにしてサイドカーを開始します。 CADCAMFUN_DATA_DIR 使い捨てディレクトリを指す - を参照 aPI のチュートリアル.

運営

10 エンドポイント（ analytics サイドカー自体から生成されたグループ OpenAPIドキュメント。保護された操作には時間がかかります Authorization: Bearer $CADCAMFUN_TOKEN;見る認証。行動と制限は次のとおりですサブシステムガイド.

得る	/api/analytics/system-metrics	analytics.systemMetrics
得る	/api/analytics	analytics.index
得る	/api/analytics/dashboard-data	analytics.dashboardData
役職	/api/analytics/log-view	analytics.logView
得る	/api/analytics/recent-activity	analytics.recentActivity
得る	/api/analytics/user-history	analytics.userHistory
得る	/api/analytics/user-metrics	analytics.userMetrics
得る	/api/analytics/user-usage	analytics.userUsage
消去	/api/analytics/user-usage	analytics.clearUserUsage
役職	/api/analytics/track	analytics.track

3D での分析オペレーションドラッグして周回します · スクロールしてズーム · 右ドラッグしてパンします

オペレーションごとに 1 つのブロック (10)、このページのリソースセクションごとにスタックされ、メソッドごとに色分けされます: 緑色の GET、オレンジ色の POST、青色の PUT、紫色の PATCH、赤色の DELETE。ビルド時に OpenAPI ドキュメントから生成されます。

/api/analytics/system-metrics

得る /api/analytics/system-metrics # analytics.systemMetrics

必要 Authorization: Bearer <token>.

応答

200 物体 application/json

{
  cpuUsage: number | "Infinity" | "-Infinity" | "NaN"
  memoryUsage: number | "Infinity" | "-Infinity" | "NaN"
  storageUsed: number | "Infinity" | "-Infinity" | "NaN"
  networkLatency: number | "Infinity" | "-Infinity" | "NaN"
  activeConnections: number | "Infinity" | "-Infinity" | "NaN"
  cacheHitRatio: number | "Infinity" | "-Infinity" | "NaN"
  errorRate: number | "Infinity" | "-Infinity" | "NaN"
  responseTime: number | "Infinity" | "-Infinity" | "NaN"
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

応答例捕獲 · 200

GET /api/analytics/system-metrics

{
  "cpuUsage": 6,
  "memoryUsage": 79,
  "storageUsed": 72,
  "networkLatency": 15,
  "activeConnections": 145,
  "cacheHitRatio": 98,
  "errorRate": 0.04,
  "responseTime": 52
}

SDKの例

analytics.systemMetrics

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.analytics.systemMetrics()

curl

GET /api/analytics/system-metrics

curl --request GET "${CADCAMFUN_URL}/api/analytics/system-metrics" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

/api/analytics

得る /api/analytics # analytics.index

必要 Authorization: Bearer <token>.

パラメータ

名前	で	タイプ	必須
startDate	クエリ	弦 \| null	オプション
endDate	クエリ	弦 \| null	オプション
itemType	クエリ	弦 \| 弦[] \| null	オプション
アクション	クエリ	弦 \| 弦[] \| null	オプション
groupBy	クエリ	弦 \| null	オプション
userFilter	クエリ	弦 \| 弦[] \| null	オプション

応答

200 物体 application/json

{
  success: true
  data: {
    countByType: Array<{
      itemType: string
      _count: number | "Infinity" | "-Infinity" | "NaN"
    }>
    countByAction: Array<{
      action: string
      _count: number | "Infinity" | "-Infinity" | "NaN"
    }>
  }
  isAdmin: boolean
  filters: unknown
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 AnalyticsFailureEncoded application/json

AnalyticsFailureEncoded

応答例捕獲 · 200

/api/analytics を取得する

{
  "success": true,
  "data": {
    "countByType": [],
    "countByAction": []
  },
  "isAdmin": true,
  "filters": {
    "groupBy": "day"
  }
}

SDKの例

analytics.index

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// AnalyticsIndexInput
const result = await client.analytics.index({})

curl

/api/analytics を取得する

curl --request GET "${CADCAMFUN_URL}/api/analytics" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

startDate クエリ endDate クエリ itemType クエリ アクション クエリ groupBy クエリ userFilter クエリ

/api/analytics/dashboard-data

得る /api/analytics/dashboard-data # analytics.dashboardData

必要 Authorization: Bearer <token>.

応答

200 物体 application/json

{
  components: {
    total: number | "Infinity" | "-Infinity" | "NaN"
    trend: number | "Infinity" | "-Infinity" | "NaN"
    recentActivity: number | "Infinity" | "-Infinity" | "NaN"
  }
  projects: {
    total: number | "Infinity" | "-Infinity" | "NaN"
    trend: number | "Infinity" | "-Infinity" | "NaN"
    activeProjects: number | "Infinity" | "-Infinity" | "NaN"
  }
  tools: {
    total: number | "Infinity" | "-Infinity" | "NaN"
    trend: number | "Infinity" | "-Infinity" | "NaN"
    mostUsed: string
  }
  materials: {
    total: number | "Infinity" | "-Infinity" | "NaN"
    trend: number | "Infinity" | "-Infinity" | "NaN"
    lowStock: number | "Infinity" | "-Infinity" | "NaN"
  }
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

応答例捕獲 · 200

/api/analytics/dashboard-data を取得する

{
  "components": {
    "total": 0,
    "trend": 0,
    "recentActivity": 0
  },
  "projects": {
    "total": 0,
    "trend": 0,
    "activeProjects": 0
  },
  "tools": {
    "total": 0,
    "trend": 0,
    "mostUsed": "No tools used yet"
  },
  "materials": {
    "total": 0,
    "trend": 0,
    "lowStock": 0
  }
}

SDKの例

analytics.dashboardData

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.analytics.dashboardData()

curl

/api/analytics/dashboard-data を取得する

curl --request GET "${CADCAMFUN_URL}/api/analytics/dashboard-data" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

/api/analytics/log-view

役職 /api/analytics/log-view # analytics.logView

必要 Authorization: Bearer <token>.

リクエスト本文 · 必須 · application/json

{
  path?: string | null
  query?: unknown | null
}

応答

200 物体 application/json

{
  success: true
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDKの例

analytics.logView

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// AnalyticsLogViewInput
const result = await client.analytics.logView({
  path: "",
  query: null
})

curl

POST /api/analytics/log-view

curl --request POST "${CADCAMFUN_URL}/api/analytics/log-view" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

試してみてください

リクエストボディ application/json

/api/analytics/recent-activity

得る /api/analytics/recent-activity # analytics.recentActivity

必要 Authorization: Bearer <token>.

パラメータ

名前	で	タイプ	必須
限界	クエリ	弦 \| null	オプション

応答

200 配列<オブジェクト> application/json

Array<{
  id: string
  type: string
  action: string
  itemName: string
  timestamp: string
  userId: string
  userName: string
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

応答例捕獲 · 200

GET /api/analytics/recent-activity

[]

SDKの例

analytics.recentActivity

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// AnalyticsRecentActivityInput
const result = await client.analytics.recentActivity({})

curl

GET /api/analytics/recent-activity

curl --request GET "${CADCAMFUN_URL}/api/analytics/recent-activity" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

限界 クエリ

/api/analytics/user-history

得る /api/analytics/user-history # analytics.userHistory

必要 Authorization: Bearer <token>.

パラメータ

名前	で	タイプ	必須
限界	クエリ	弦 \| null	オプション
オフセット	クエリ	弦 \| null	オプション
itemType	クエリ	弦 \| 弦[] \| null	オプション
アクション	クエリ	弦 \| 弦[] \| null	オプション
startDate	クエリ	弦 \| null	オプション
endDate	クエリ	弦 \| null	オプション

応答

200 物体 application/json

{
  logs: unknown[]
  total: number | "Infinity" | "-Infinity" | "NaN"
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

応答例捕獲 · 200

/api/analytics/ユーザー履歴を取得する

{
  "logs": [],
  "total": 0
}

SDKの例

analytics.userHistory

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// AnalyticsUserHistoryInput
const result = await client.analytics.userHistory({})

curl

/api/analytics/ユーザー履歴を取得する

curl --request GET "${CADCAMFUN_URL}/api/analytics/user-history" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

限界 クエリ オフセット クエリ itemType クエリ アクション クエリ startDate クエリ endDate クエリ

/api/analytics/user-metrics

得る /api/analytics/user-metrics # analytics.userMetrics

必要 Authorization: Bearer <token>.

パラメータ

名前	で	タイプ	必須
startDate	クエリ	弦 \| null	オプション
endDate	クエリ	弦 \| null	オプション
groupBy	クエリ	弦 \| null	オプション
メトリック	クエリ	弦 \| null	オプション

応答

200 物体 application/json

{
  summary: {
    totalAiRequests: number | "Infinity" | "-Infinity" | "NaN"
    totalCadDrawings: number | "Infinity" | "-Infinity" | "NaN"
    totalStorageUsage: number | "Infinity" | "-Infinity" | "NaN"
    totalProjects: number | "Infinity" | "-Infinity" | "NaN"
    totalComponents: number | "Infinity" | "-Infinity" | "NaN"
    totalToolpaths: number | "Infinity" | "-Infinity" | "NaN"
    totalActivityCount?: number | "Infinity" | "-Infinity" | "NaN" | null
  }
  chartData: Array<{
    [key: string]: string | number | "Infinity" | "-Infinity" | "NaN"
  }>
}

400 AnalyticsKeyedBadRequestEncoded application/json

AnalyticsKeyedBadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

応答例捕獲 · 200

/api/analytics/user-metrics を取得する

{
  "summary": {
    "totalAiRequests": 0,
    "totalCadDrawings": 0,
    "totalStorageUsage": 0,
    "totalProjects": 0,
    "totalComponents": 0,
    "totalToolpaths": 0,
    "totalActivityCount": 0
  },
  "chartData": [
    {
      "date": "2026-09-15",
      "activityCount": 0,
      "toolpathsGenerated": 0,
      "connections": 0,
      "programRuns": 0,
      "aiRequests": 0,
      "cadDrawings": 0,
      "storageUsage": 0,
      "projects": 0,
      "components": 0,
      "toolpaths": 0
    },
    {
      "date": "2026-09-16",
      "activityCount": 0,
      "toolpathsGenerated": 0,
      "connections": 0,
      "programRuns": 0,
      "aiRequests": 0,
      "cadDrawings": 0,
      "storageUsage": 0,
      "projects": 0,
      "components": 0,
      "toolpaths": 0
    },
    {
      "date": "2026-09-17",
      "activityCount": 0,
      "toolpathsGenerated": 0,
      "connections": 0,
      "programRuns": 0,
      "aiRequests": 0,
      "cadDrawings": 0,
      "storageUsage": 0,
      "projects": 0,
      "components": 0,
      "toolpaths": 0
    },
    {
      "date": "2026-09-18",
      "activityCount": 0,
      "toolpathsGenerated": 0,
      "connections": 0,
      "programRuns": 0,
      "aiRequests": 0,
      "cadDrawings": 0,
      "storageUsage": 0,
      "projects": 0,
      "components": 0,
      "toolpaths": 0
    },
    {
      "date": "2026-09-19",
      "activityCount": 0,
      "toolpathsGenerated": 0,
      "connections": 0,
      "programRuns": 0,
      "aiRequests": 0,
      "cadDrawings": 0,
      "storageUsage": 0,
      "projects": 0,
      "components": 0,
      "toolpaths": 0
    },
    {
      "date": "2026-09-20",
      "activityCount": 0,
      "toolpathsGenerated": 0,
      "connections": 0,
      "programRuns": 0,
      "aiRequests": 0,
      "cadDrawings": 0,
      "storageUsage": 0,
      "projects": 0,
      "components": 0,
      "toolpaths": 0
    },
    {
      "date": "2026-09-21",
      "activityCount": 0,
      "toolpathsGenerated": 0,
      "connections": 0,
      "programRuns": 0,
      "aiRequests": 0,
      "cadDrawings": 0,
      "storageUsage": 0,
      "projects": 0,
      "components": 0,
      "toolpaths": 0
    },
    {
      "date": "2026-09-22",
      "activityCount": 0,
      "toolpathsGenerated": 0,
      "connections": 0,
      "programRuns": 0,
      "aiRequests": 0,
      "cadDrawings": 0,
      "storageUsage": 0,
      "projects": 0,
      "components": 0,
      "toolpaths": 0
    },
    {
      "
…

SDKの例

analytics.userMetrics

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// AnalyticsUserMetricsInput
const result = await client.analytics.userMetrics({})

curl

/api/analytics/user-metrics を取得する

curl --request GET "${CADCAMFUN_URL}/api/analytics/user-metrics" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

startDate クエリ endDate クエリ groupBy クエリ メトリック クエリ

/api/analytics/user-usage

得る /api/analytics/user-usage # analytics.userUsage

必要 Authorization: Bearer <token>.

パラメータ

名前	で	タイプ	必須
userId	クエリ	弦 \| null	オプション
startDate	クエリ	弦 \| null	オプション
endDate	クエリ	弦 \| null	オプション
期間	クエリ	弦 \| null	オプション

応答

200 物体 application/json

{
  summary?: unknown | null
  breakdown?: unknown | null
  users?: unknown[] | null
  systemStats?: unknown | null
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 AnalyticsKeyedForbiddenEncoded application/json

AnalyticsKeyedForbiddenEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

応答例捕獲 · 200

GET /api/analytics/user-usage

{
  "users": [],
  "systemStats": {
    "totalUsers": 0,
    "totalTokens": 0,
    "totalCost": 0,
    "totalRequests": 0,
    "averageCostPerUser": 0,
    "topSpendingUsers": [],
    "modelDistribution": {}
  }
}

SDKの例

analytics.userUsage

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// AnalyticsUserUsageInput
const result = await client.analytics.userUsage({})

curl

GET /api/analytics/user-usage

curl --request GET "${CADCAMFUN_URL}/api/analytics/user-usage" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

userId クエリ startDate クエリ endDate クエリ 期間 クエリ

消去 /api/analytics/user-usage # analytics.clearUserUsage

必要 Authorization: Bearer <token>.

応答

200 物体 application/json

{
  message: string
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

SDKの例

analytics.clearUserUsage

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// no input
const result = await client.analytics.clearUserUsage()

curl

/api/analytics/user-usage を削除します

curl --request DELETE "${CADCAMFUN_URL}/api/analytics/user-usage" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

試してみてください

/api/analytics/track

役職 /api/analytics/track # analytics.track

必要 Authorization: Bearer <token>.

リクエスト本文 · 必須 · application/json

{
  itemId?: string | null
  itemType?: string | null
  action?: string | null
  details?: unknown | null
}

応答

200 物体 application/json

{
  success: true
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDKの例

analytics.track

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// AnalyticsTrackInput
const result = await client.analytics.track({
  itemId: "",
  itemType: "",
  action: "",
  details: null
})

curl

POST /api/analytics/track

curl --request POST "${CADCAMFUN_URL}/api/analytics/track" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

試してみてください

リクエストボディ application/json

スキーマ

このグループのパラメータ、本体、および応答から到達可能な名前付きスキーマ。あ ? オプションのフィールドをマークします。 | null null 値が存在する可能性があるフィールドにマークを付けます。

AnalyticsFailureEncoded

{
  _tag: "AnalyticsFailure"
  success: false
  message: string
}

AnalyticsKeyedBadRequestEncoded

{
  _tag: "AnalyticsKeyedBadRequest"
  error: string
}

AnalyticsKeyedForbiddenEncoded

{
  _tag: "AnalyticsKeyedForbidden"
  error: string
}

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

KeyedInternalEncoded

{
  _tag: "KeyedInternal"
  error: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

このグループに電話をかける

オペレーション ID の形式は次のとおりです。 analytics.<name>。生成された Promise SDK (@cadcamfun/api/sdk) それらのほとんどを次のように公開します client.<namespace>.<method>(input)、どこ input パスパラメータとボディフィールドの 1 つのフラットオブジェクトです。各カードの SDK の例は、正確なアクセサーと入力タイプを示しています。マルチパートアップロード、バイナリまたは JavaScript 応答、生の Webhook は生成されません。それらのカードが示しているのは fetch 代わりに。

Promise SDK からのエラー

import { CadCam, ClientError } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

try {
  await client.projects.list()
} catch (error) {
  if (error instanceof ClientError) {
    // Transport | UnexpectedStatus | UnsupportedContentType | MalformedResponse | SseEventTooLarge
  } else {
    // a declared error body: switch on error._tag
  }
}

トラブルシューティング

症状	考えられる原因	修理
呼び出しごとの 401	以前の起動からのトークン、または欠落しています `Bearer` 接頭辞	送信 `Authorization: Bearer <token>` サイドカーが開始されたトークンを使用します。
何も起きる前の 400	本体またはパラメータがスキーマと一致しません	ペイロードとカード上のリクエストスキーマを比較します。
別の場所で見えるレコードの 403 または 404	代理アカウントは異なります	権利を送信します `x-session-token`、またはレコードを所有するローカルプロファイルを使用します。
409	重複した名前や古いブランチヘッドなどの矛盾した状態	リソースを再読み込みし、現在のデータで再試行します。
「CORS によってブロックされました」と表示されてみてください	ドキュメントは非ループバックオリジンから提供されます	ドキュメントをローカルで実行するか、リクエストをcurlとしてコピーします。
接続拒否	サイドカーが新しいポートで再起動されました	新しいポートからポートを読み取ります `ready` 行。