Vai al contenuto principale
POST
Query di Custom Analytics

Panoramica

L’API Custom Analytics offre funzionalità di interrogazione flessibili per i dati di completamento automatico, chat e comandi, con selezioni, filtri, aggregazioni e ordinamenti personalizzabili.

Richiesta

service_key
string
obbligatorio
La tua chiave di servizio con l’autorizzazione “Analytics Read”
group_name
string
Filtra i risultati agli utenti di un gruppo specifico (facoltativo)
query_requests
array
obbligatorio
Array di oggetti di richiesta di query che definiscono i dati da recuperare

Struttura della richiesta di query

Ogni oggetto di richiesta di query contiene:
  • data_source (obbligatorio): Origine dati da interrogare
  • selections (obbligatorio): Array di campi da recuperare
  • filters (facoltativo): Array di filtri da applicare
  • aggregations (facoltativo): Array di aggregazioni in base a cui raggruppare

Selezioni

Le selezioni definiscono quali campi recuperare e come aggregarli.
  • field (obbligatorio): Nome del campo da includere
  • name (facoltativo): Alias del campo
  • aggregation_function (facoltativo): Funzione di aggregazione da applicare

Esempio di selezione

Filtri

I filtri consentono di limitare i dati agli elementi che soddisfano criteri specifici.
  • name (obbligatorio): Nome del campo su cui filtrare
  • filter (obbligatorio): Operazione di filtro
  • value (obbligatorio): Valore con cui confrontare

Esempio di filtro

Aggregazioni

Le aggregazioni raggruppano i dati in base ai criteri specificati.
  • field (obbligatorio): Nome del campo in base al quale raggruppare
  • name (obbligatorio): Alias del campo di aggregazione

Esempio di aggregazione

Campi disponibili

Dati utente

Tutti i dati utente sono aggregati per utente e per ora.

Dati della chat

I dati della chat sono separati dai dati di Cascade e rappresentano l’utilizzo dei nostri plugin legacy non agentici
Tutti i dati della chat rappresentano le risposte del modello di chat, non le domande degli utenti.

Tipi di intent della chat

  • CHAT_INTENT_GENERIC - Chat standard
  • CHAT_INTENT_FUNCTION_EXPLAIN - Code lens per la spiegazione della funzione
  • CHAT_INTENT_FUNCTION_DOCSTRING - Code lens per la docstring della funzione
  • CHAT_INTENT_FUNCTION_REFACTOR - Code lens per il refactor della funzione
  • CHAT_INTENT_CODE_BLOCK_EXPLAIN - Code lens per la spiegazione del blocco di codice
  • CHAT_INTENT_CODE_BLOCK_REFACTOR - Code lens per il refactor del blocco di codice
  • CHAT_INTENT_PROBLEM_EXPLAIN - Code lens per la spiegazione del problema
  • CHAT_INTENT_FUNCTION_UNIT_TESTS - Code lens per i test unitari della funzione

Dati del comando

I dati del comando includono tutti i comandi, compresi quelli rifiutati. Usa il campo accepted per filtrare solo i comandi accettati.

Fonti dei comandi

  • COMMAND_REQUEST_SOURCE_LINE_HINT_CODE_LENS
  • COMMAND_REQUEST_SOURCE_DEFAULT - Uso tipico del comando
  • COMMAND_REQUEST_SOURCE_RIGHT_CLICK_REFACTOR
  • COMMAND_REQUEST_SOURCE_FUNCTION_CODE_LENS
  • COMMAND_REQUEST_SOURCE_FOLLOWUP
  • COMMAND_REQUEST_SOURCE_CLASS_CODE_LENS
  • COMMAND_REQUEST_SOURCE_PLAN
  • COMMAND_REQUEST_SOURCE_SELECTION_HINT_CODE_LENS

Sorgenti del provider

  • PROVIDER_SOURCE_COMMAND_GENERATE - Modalità di generazione
  • PROVIDER_SOURCE_COMMAND_EDIT - Modalità di modifica

Dati PCW

Dati relativi alla Percentuale di Codice Scritto, con monitoraggio separato dei contributi di completamento automatico e dei comandi.

Filtri PCW

Per filtrare per data nelle query PCW, usa start_timestamp e end_timestamp nel corpo principale della richiesta.

Esempi di richieste

Esempio di dati utente

Esempio di dati della chat

Esempio di dati del comando

Esempio di dati PCW

Risposta

queryResults
array
Array dei risultati delle query, uno per ogni richiesta di query
responseItems
array
Array di elementi di risultato
item
object
Oggetto contenente i campi selezionati e i relativi valori

Esempi di risposta

Risposta con i dati dell’utente

Risposta con i dati della chat

Risposta con i dati del comando

Risposta dati PCW

Note importanti

  • Il PCW (Percentuale di Codice Scritto) presenta un’elevata variabilità su singole giornate o singoli utenti: aggrega i dati su base settimanale per ottenere migliori approfondimenti
  • Tutti i campi di selezione devono avere funzioni di aggregazione, oppure nessuno deve averle (non è possibile mescolarli)
  • I campi con pattern “distinct_*” non possono essere usati nelle aggregazioni
  • Gli alias dei campi devono essere univoci in tutte le selezioni e aggregazioni
  • Se non viene specificata alcuna funzione di aggregazione, il valore predefinito è UNSPECIFIED