Documentazione

Analitica

Metriche dell'applicazione, attività recente, query sull'utilizzo e richieste di monitoraggio.

Tradotto automaticamente dall'inglese. Vedi l'originale in inglese

Playground

Invia queste richieste al tuo sidecar in corsa. I valori rimangono in questo browser.

Non connesso

URL di base Gettone al portatore opzionale Token di sessione opzionale

Come funziona

Il sidecar resta in ascolto su una porta di loopback scelta all'avvio e la stampa nel suo file ready linea; usa quell'URL e il file CADCAMFUN_TOKEN è stato iniziato con. Le richieste vanno direttamente da questa pagina a quell'indirizzo.

Il sidecar invia intestazioni CORS solo alle origini Tauri e a http://localhost o http://127.0.0.1 su qualsiasi porto. Dai documenti ospitati il browser blocca la risposta, quindi esegui i documenti localmente (bun run dev in packages/web) per utilizzare il parco giochi, oppure copiare la richiesta come ricciolo. Per sperimentare senza toccare i dati reali, avvia il sidecar con CADCAMFUN_DATA_DIR indicato in una directory usa e getta - vedi la procedura dettagliata dell'API.

Operazioni

10 endpoint nel analytics gruppo, generato da quello del sidecar Documento OpenAPI. Le operazioni protette richiedono Authorization: Bearer $CADCAMFUN_TOKEN; vedere autenticazione. Comportamenti e limiti sono entrati la guida del sottosistema.

ottenere	/api/analytics/system-metrics	analytics.systemMetrics
ottenere	/api/analytics	analytics.index
ottenere	/api/analytics/dashboard-data	analytics.dashboardData
inviare	/api/analytics/log-view	analytics.logView
ottenere	/api/analytics/recent-activity	analytics.recentActivity
ottenere	/api/analytics/user-history	analytics.userHistory
ottenere	/api/analytics/user-metrics	analytics.userMetrics
ottenere	/api/analytics/user-usage	analytics.userUsage
eliminare	/api/analytics/user-usage	analytics.clearUserUsage
inviare	/api/analytics/track	analytics.track

Operazioni di analisi in 3D Trascina per orbitare · scorri per ingrandire · trascina con il tasto destro per eseguire la panoramica

Un blocco per operazione (10), impilato per sezione di risorse di questa pagina e colorato in base al metodo: verde GET, arancione POST, blu PUT, viola PATCH, rosso DELETE. Generato dal documento OpenAPI in fase di compilazione.

/api/analytics/system-metrics

ottenere /api/analytics/system-metrics # analytics.systemMetrics

Richiede Authorization: Bearer <token>.

Risposte

200 oggetto 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

Risposta di esempio catturato · 200

GET /api/analytics/system-metrics

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

Esempio dell'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}"

Provalo

/api/analytics

ottenere /api/analytics # analytics.index

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
startDate	domanda	corda \| null	opzionale
endDate	domanda	corda \| null	opzionale
itemType	domanda	corda \| corda[] \| null	opzionale
azione	domanda	corda \| corda[] \| null	opzionale
groupBy	domanda	corda \| null	opzionale
userFilter	domanda	corda \| corda[] \| null	opzionale

Risposte

200 oggetto 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

Risposta di esempio catturato · 200

GET /api/analytics

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

Esempio dell'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

GET /api/analytics

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

Provalo

startDate domanda endDate domanda itemType domanda azione domanda groupBy domanda userFilter domanda

/api/analytics/dashboard-data

ottenere /api/analytics/dashboard-data # analytics.dashboardData

Richiede Authorization: Bearer <token>.

Risposte

200 oggetto 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

Risposta di esempio catturato · 200

OTTIENI /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
  }
}

Esempio dell'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

OTTIENI /api/analytics/dashboard-data

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

Provalo

/api/analytics/log-view

inviare /api/analytics/log-view # analytics.logView

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

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

Risposte

200 oggetto application/json

{
  success: true
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'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

Provalo

Richiedi corpo application/json

/api/analytics/recent-activity

ottenere /api/analytics/recent-activity # analytics.recentActivity

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
limite	domanda	corda \| null	opzionale

Risposte

200 Matrice<oggetto> 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

Risposta di esempio catturato · 200

GET /api/analytics/attività-recente

[]

Esempio dell'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/attività-recente

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

Provalo

limite domanda

/api/analytics/user-history

ottenere /api/analytics/user-history # analytics.userHistory

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
limite	domanda	corda \| null	opzionale
offset	domanda	corda \| null	opzionale
itemType	domanda	corda \| corda[] \| null	opzionale
azione	domanda	corda \| corda[] \| null	opzionale
startDate	domanda	corda \| null	opzionale
endDate	domanda	corda \| null	opzionale

Risposte

200 oggetto application/json

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

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Risposta di esempio catturato · 200

GET /api/analytics/user-history

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

Esempio dell'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

GET /api/analytics/user-history

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

Provalo

limite domanda offset domanda itemType domanda azione domanda startDate domanda endDate domanda

/api/analytics/user-metrics

ottenere /api/analytics/user-metrics # analytics.userMetrics

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
startDate	domanda	corda \| null	opzionale
endDate	domanda	corda \| null	opzionale
groupBy	domanda	corda \| null	opzionale
metrico	domanda	corda \| null	opzionale

Risposte

200 oggetto 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

Risposta di esempio catturato · 200

GET /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
    },
    {
      "
…

Esempio dell'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

GET /api/analytics/user-metrics

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

Provalo

startDate domanda endDate domanda groupBy domanda metrico domanda

/api/analytics/user-usage

ottenere /api/analytics/user-usage # analytics.userUsage

Richiede Authorization: Bearer <token>.

Parametri

Nome	In	Tipo	Necessario
userId	domanda	corda \| null	opzionale
startDate	domanda	corda \| null	opzionale
endDate	domanda	corda \| null	opzionale
periodo	domanda	corda \| null	opzionale

Risposte

200 oggetto 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

Risposta di esempio catturato · 200

GET /api/analytics/user-usage

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

Esempio dell'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}"

Provalo

userId domanda startDate domanda endDate domanda periodo domanda

eliminare /api/analytics/user-usage # analytics.clearUserUsage

Richiede Authorization: Bearer <token>.

Risposte

200 oggetto application/json

{
  message: string
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 KeyedInternalEncoded application/json

KeyedInternalEncoded

Esempio dell'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

DELETE /api/analytics/user-usage

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

Provalo

/api/analytics/track

inviare /api/analytics/track # analytics.track

Richiede Authorization: Bearer <token>.

Corpo della richiesta · obbligatorio · application/json

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

Risposte

200 oggetto application/json

{
  success: true
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

Esempio dell'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

Provalo

Richiedi corpo application/json

Schemi

Schemi denominati raggiungibili dai parametri, dai corpi e dalle risposte di questo gruppo. UN ? contrassegna un campo facoltativo; | null contrassegna un campo che può essere presente con un valore nullo.

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
}

Chiamando questo gruppo

Gli ID operazione hanno il formato analytics.<name>. L'SDK Promise generato (@cadcamfun/api/sdk) ne espone la maggior parte come client.<namespace>.<method>(input), dove input è un oggetto piatto di parametri di percorso e campi del corpo; l'esempio dell'SDK di ciascuna scheda mostra l'esatto accessor e il tipo di input. Non vengono generati caricamenti in più parti, risposte binarie o JavaScript e webhook grezzi; quelle carte mostrano fetch invece.

Errori dall'SDK Promise

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
  }
}

Risoluzione dei problemi

Sintomo	Probabile causa	Aggiustare
401 a ogni chiamata	Token di un lancio precedente o mancante `Bearer` prefisso	Inviare `Authorization: Bearer <token>` con il gettone con cui è stato avviato il sidecar.
400 prima che accada qualcosa	Il corpo o il parametro non corrisponde allo schema	Confronta il payload con lo schema di richiesta sulla carta.
403 o 404 su un record visibile altrove	Il resoconto della recitazione è diverso	Invia il diritto `x-session-token`oppure utilizzare il profilo locale proprietario del record.
409	Stato in conflitto, ad esempio un nome duplicato o una testa di ramo obsoleta	Rileggere la risorsa e riprovare con i dati correnti.
Prova, dice "bloccato da CORS"	I documenti vengono serviti da un'origine non di loopback	Esegui i documenti localmente o copia la richiesta come curl.
Connessione rifiutata	Il sidecar è ripartito su una nuova porta	Leggi il porto dal nuovo `ready` riga.