Benutzerdefinierte Analytics-Abfrage

curl --request POST \
  --url https://server.codeium.com/api/v1/Analytics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "group_name": "<string>",
  "query_requests": [
    {
      "data_source": "<string>",
      "selections": [
        {
          "field": "<string>",
          "name": "<string>",
          "aggregation_function": "<string>"
        }
      ],
      "filters": [
        {
          "name": "<string>",
          "filter": "<string>",
          "value": "<string>"
        }
      ],
      "aggregations": [
        {
          "field": "<string>",
          "name": "<string>"
        }
      ]
    }
  ]
}
'

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {}
        }
      ]
    }
  ]
}

POST

api

Analytics

Benutzerdefinierte Analytics-Abfrage

curl --request POST \
  --url https://server.codeium.com/api/v1/Analytics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "service_key": "<string>",
  "group_name": "<string>",
  "query_requests": [
    {
      "data_source": "<string>",
      "selections": [
        {
          "field": "<string>",
          "name": "<string>",
          "aggregation_function": "<string>"
        }
      ],
      "filters": [
        {
          "name": "<string>",
          "filter": "<string>",
          "value": "<string>"
        }
      ],
      "aggregations": [
        {
          "field": "<string>",
          "name": "<string>"
        }
      ]
    }
  ]
}
'

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {}
        }
      ]
    }
  ]
}

Überblick

Die Custom Analytics API ermöglicht flexible Abfragen von Autovervollständigungs-, Chat- und Befehlsdaten mit anpassbarer Auswahl, Filtern, Aggregationen und Sortierungen.

Anfrage

service_key

string

erforderlich

Ihr Service-Schlüssel mit „Analytics Read“-Berechtigungen

group_name

string

Ergebnisse auf Nutzer in einer bestimmten Gruppe beschränken (optional)

query_requests

array

erforderlich

Array von Abfrageobjekten, die die abzurufenden Daten definieren

Anzeigen Abfrageobjekt

data_source

string

erforderlich

Abzufragende Datenquelle. Optionen:

QUERY_DATA_SOURCE_USER_DATA - Daten zur Autovervollständigung
QUERY_DATA_SOURCE_CHAT_DATA - Chat-Daten
QUERY_DATA_SOURCE_COMMAND_DATA - Befehlsdaten
QUERY_DATA_SOURCE_PCW_DATA - Daten zum Prozentsatz des geschriebenen Codes

selections

array

erforderlich

Array von Feldauswahlen zum Abrufen

Anzeigen Auswahlobjekt

field

string

erforderlich

Name des auszuwählenden Felds (siehe Abschnitt „Available Fields“)

name

string

Alias für das Feld. Falls nicht angegeben, wird standardmäßig {aggregation_function}_{field_name} verwendet (in Kleinbuchstaben)

aggregation_function

string

Anzuwendende Aggregationsfunktion:

QUERY_AGGREGATION_UNSPECIFIED (Standard)
QUERY_AGGREGATION_COUNT
QUERY_AGGREGATION_SUM
QUERY_AGGREGATION_AVG
QUERY_AGGREGATION_MAX
QUERY_AGGREGATION_MIN

filters

array

Array von anzuwendenden Filtern

Anzeigen Filterobjekt

name

string

erforderlich

Name des Felds, nach dem gefiltert werden soll

filter

string

erforderlich

Filteroperation:

QUERY_FILTER_EQUAL
QUERY_FILTER_NOT_EQUAL
QUERY_FILTER_GREATER_THAN
QUERY_FILTER_LESS_THAN
QUERY_FILTER_GE (größer oder gleich)
QUERY_FILTER_LE (kleiner oder gleich)

value

string

erforderlich

Vergleichswert

aggregations

array

Array von Aggregationen zum Gruppieren

Anzeigen Aggregationsobjekt

field

string

erforderlich

Name des Felds, nach dem gruppiert werden soll

name

string

erforderlich

Alias für das Aggregationsfeld

Struktur der Query-Anfrage

Jedes Abfrageobjekt enthält:

data_source (erforderlich): Abzufragende Datenquelle
selections (erforderlich): Array der abzurufenden Feldauswahlen
filters (optional): Array der anzuwendenden Filter
aggregations (optional): Array der Aggregationen zur Gruppierung

Auswahlen

Auswahlen legen fest, welche Felder abgerufen und wie sie aggregiert werden.

field (erforderlich): Name des Felds, das ausgewählt werden soll
name (optional): Alias für das Feld
aggregation_function (optional): Anzuwendende Aggregationsfunktion

Beispiel für eine Auswahl

{
  "field": "num_acceptances",
  "name": "total_acceptances",
  "aggregation_function": "QUERY_AGGREGATION_SUM"
}

Filter

Filter schränken Daten auf Elemente ein, die bestimmte Kriterien erfüllen.

name (erforderlich): Feldname, nach dem gefiltert werden soll
filter (erforderlich): Filteroperation
value (erforderlich): Wert, mit dem verglichen werden soll

Beispiel für einen Filter

{
  "name": "language",
  "filter": "QUERY_FILTER_EQUAL",
  "value": "PYTHON"
}

Aggregationen

Aggregationen fassen Daten nach angegebenen Kriterien zusammen.

field (erforderlich): Feldname, nach dem gruppiert wird
name (erforderlich): Alias für das Aggregationsfeld

Beispiel für eine Aggregation

{
  "field": "ide",
  "name": "ide_type"
}

Verfügbare Felder

Nutzerdaten

Alle Nutzerdaten werden pro Nutzer und Stunde aggregiert.

Feldname	Beschreibung	Gültige Aggregationen
`api_key`	Hash des API-Schlüssels des Nutzers	UNSPECIFIED, COUNT
`date`	UTC-Datum der Autovervollständigung	UNSPECIFIED, COUNT
`date UTC-x`	Datum mit Zeitzonenversatz (z. B. „date UTC-8“ für PST)	UNSPECIFIED, COUNT
`hour`	UTC-Stunde der Autovervollständigung	UNSPECIFIED, COUNT
`language`	Programmiersprache	UNSPECIFIED, COUNT
`ide`	Verwendete IDE	UNSPECIFIED, COUNT
`version`	Version von Devin Desktop	UNSPECIFIED, COUNT
`num_acceptances`	Anzahl akzeptierter Autovervollständigungen	SUM, MAX, MIN, AVG
`num_lines_accepted`	Akzeptierte Codezeilen	SUM, MAX, MIN, AVG
`num_bytes_accepted`	Akzeptierte Bytes	SUM, MAX, MIN, AVG
`distinct_users`	Eindeutige Nutzer	UNSPECIFIED, COUNT
`distinct_developer_days`	Eindeutige Tupel aus (Nutzer, Tag)	UNSPECIFIED, COUNT
`distinct_developer_hours`	Eindeutige Tupel aus (Nutzer, Stunde)	UNSPECIFIED, COUNT

Chat-Daten

Chat-Daten sind von Cascade-Daten getrennt und erfassen die Nutzung unserer älteren, nicht-agentischen Plugins

Alle Chat-Daten beziehen sich auf Antworten des Chatmodells, nicht auf Fragen von Nutzern.

Feldname	Beschreibung	Gültige Aggregationen
`api_key`	Hash des API-Schlüssels des Nutzers	UNSPECIFIED, COUNT
`model_id`	ID des Chatmodells	UNSPECIFIED, COUNT
`date`	UTC-Datum der Chat-Antwort	UNSPECIFIED, COUNT
`date UTC-x`	Datum mit Zeitzonenversatz	UNSPECIFIED, COUNT
`ide`	Verwendete IDE	UNSPECIFIED, COUNT
`version`	Version von Devin Desktop	UNSPECIFIED, COUNT
`latest_intent_type`	Chat-Intent-Typ (siehe Intent-Typen unten)	UNSPECIFIED, COUNT
`num_chats_received`	Anzahl der empfangenen Chat-Nachrichten	SUM, MAX, MIN, AVG
`chat_accepted`	Ob der Chat akzeptiert wurde („Daumen hoch“)	SUM, COUNT
`chat_inserted_at_cursor`	Ob auf die Schaltfläche „Insert“ geklickt wurde	SUM, COUNT
`chat_applied`	Ob auf die Schaltfläche „Apply Diff“ geklickt wurde	SUM, COUNT
`chat_loc_used`	Aus dem Chat übernommene Codezeilen	SUM, MAX, MIN, AVG

Chat-Intent-Typen

CHAT_INTENT_GENERIC - Regulärer Chat
CHAT_INTENT_FUNCTION_EXPLAIN - CodeLens zur Erklärung einer Funktion
CHAT_INTENT_FUNCTION_DOCSTRING - CodeLens für den Docstring einer Funktion
CHAT_INTENT_FUNCTION_REFACTOR - CodeLens zum Refactoring einer Funktion
CHAT_INTENT_CODE_BLOCK_EXPLAIN - CodeLens zur Erklärung eines Codeblocks
CHAT_INTENT_CODE_BLOCK_REFACTOR - CodeLens zum Refactoring eines Codeblocks
CHAT_INTENT_PROBLEM_EXPLAIN - CodeLens zur Problemerklärung
CHAT_INTENT_FUNCTION_UNIT_TESTS - CodeLens für Unit-Tests einer Funktion

Befehlsdaten

Befehlsdaten umfassen alle Befehle, einschließlich abgelehnter. Verwenden Sie das Feld accepted, um nur akzeptierte Befehle zu filtern.

Feldname	Beschreibung	Gültige Aggregationen
`api_key`	Hash des API-Schlüssels des Nutzers	UNSPECIFIED, COUNT
`date`	UTC-Datum des Befehls	UNSPECIFIED, COUNT
`timestamp`	UTC-Zeitstempel des Befehls	UNSPECIFIED, COUNT
`language`	Programmiersprache	UNSPECIFIED, COUNT
`ide`	Verwendete IDE	UNSPECIFIED, COUNT
`version`	Version von Devin Desktop	UNSPECIFIED, COUNT
`command_source`	Quelle, durch die der Befehl ausgelöst wurde (siehe Befehlsquellen unten)	UNSPECIFIED, COUNT
`provider_source`	Generierungs- oder Bearbeitungsmodus	UNSPECIFIED, COUNT
`lines_added`	Hinzugefügte Codezeilen	SUM, MAX, MIN, AVG
`lines_removed`	Entfernte Codezeilen	SUM, MAX, MIN, AVG
`bytes_added`	Hinzugefügte Bytes	SUM, MAX, MIN, AVG
`bytes_removed`	Entfernte Bytes	SUM, MAX, MIN, AVG
`selection_lines`	Ausgewählte Zeilen (0 bei Generierungen)	SUM, MAX, MIN, AVG
`selection_bytes`	Ausgewählte Bytes (0 bei Generierungen)	SUM, MAX, MIN, AVG
`accepted`	Gibt an, ob der Befehl akzeptiert wurde	SUM, COUNT

Befehlsquellen

COMMAND_REQUEST_SOURCE_LINE_HINT_CODE_LENS
COMMAND_REQUEST_SOURCE_DEFAULT - Typische Nutzung von Befehlen
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

Provider-Quellen

PROVIDER_SOURCE_COMMAND_GENERATE - Generierungsmodus
PROVIDER_SOURCE_COMMAND_EDIT - Bearbeitungsmodus

PCW-Daten

Daten zu „Percent Code Written“ mit separater Erfassung von Beiträgen durch Autovervollständigung und Befehle.

Feldname	Beschreibung	Gültige Aggregationen
`percent_code_written`	Berechnet als codeium_bytes / (codeium_bytes + user_bytes)	UNSPECIFIED
`codeium_bytes`	Insgesamt von Codeium generierte Bytes	UNSPECIFIED
`user_bytes`	Insgesamt vom Nutzer geschriebene Bytes	UNSPECIFIED
`total_bytes`	codeium_bytes + user_bytes	UNSPECIFIED
`codeium_bytes_by_autocomplete`	Codeium-Bytes aus Autovervollständigung	UNSPECIFIED
`codeium_bytes_by_command`	Codeium-Bytes aus Befehlen	UNSPECIFIED

PCW-Filter

Feldname	Beschreibung	Beispiele
`language`	Programmiersprache	KOTLIN, GO, JAVA
`ide`	Verwendete IDE	jetbrains, vscode
`version`	Version von Devin Desktop	1.28.0, 130.0

Verwenden Sie für die Datumsfilterung in PCW-Abfragen start_timestamp und end_timestamp im Hauptteil des Request-Bodys.

Beispielanfragen

Beispiel für Nutzerdaten

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_USER_DATA",
      "selections": [
        {
          "field": "num_acceptances",
          "name": "total_acceptances",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        },
        {
          "field": "num_lines_accepted",
          "name": "total_lines",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        }
      ],
      "filters": [
        {
          "name": "date",
          "filter": "QUERY_FILTER_GE",
          "value": "2024-01-01"
        },
        {
          "name": "date",
          "filter": "QUERY_FILTER_LE",
          "value": "2024-02-01"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

Beispiel für Chat-Daten

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_CHAT_DATA",
      "selections": [
        {
          "field": "chat_loc_used",
          "name": "lines_used",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        }
      ],
      "filters": [
        {
          "name": "latest_intent_type",
          "filter": "QUERY_FILTER_EQUAL",
          "value": "CHAT_INTENT_FUNCTION_DOCSTRING"
        }
      ],
      "aggregations": [
        {
          "field": "ide",
          "name": "ide_type"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

Beispiel für Befehlsdaten

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_COMMAND_DATA",
      "selections": [
        {
          "field": "lines_added",
          "name": "total_lines_added",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        },
        {
          "field": "lines_removed",
          "name": "total_lines_removed",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        }
      ],
      "filters": [
        {
          "name": "provider_source",
          "filter": "QUERY_FILTER_EQUAL",
          "value": "PROVIDER_SOURCE_COMMAND_EDIT"
        },
        {
          "name": "accepted",
          "filter": "QUERY_FILTER_EQUAL",
          "value": "true"
        }
      ],
      "aggregations": [
        {
          "field": "language",
          "name": "programming_language"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

Beispiel für PCW-Daten

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "your_service_key_here",
  "start_timestamp": "2024-01-01T00:00:00Z",
  "end_timestamp": "2024-12-22T00:00:00Z",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_PCW_DATA",
      "selections": [
        {
          "field": "percent_code_written",
          "name": "pcw"
        },
        {
          "field": "codeium_bytes",
          "name": "ai_bytes"
        },
        {
          "field": "total_bytes",
          "name": "total"
        },
        {
          "field": "codeium_bytes_by_autocomplete",
          "name": "autocomplete_bytes"
        },
        {
          "field": "codeium_bytes_by_command",
          "name": "command_bytes"
        }
      ],
      "filters": [
        {
          "filter": "QUERY_FILTER_EQUAL",
          "name": "language",
          "value": "GO"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

Antwort

queryResults

array

Array mit Abfrageergebnissen, eines für jede Abfrage

responseItems

array

Array mit Ergebniseinträgen

item

object

Objekt mit den ausgewählten Feldern und ihren Werten

Beispielantworten

Antwort mit Nutzerdaten

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "total_acceptances": "125",
            "total_lines": "863"
          }
        }
      ]
    }
  ]
}

Antwort mit Chat-Daten

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "lines_used": "74",
            "ide_type": "jetbrains"
          }
        },
        {
          "item": {
            "lines_used": "41",
            "ide_type": "vscode"
          }
        }
      ]
    }
  ]
}

Antwort mit Befehlsdaten

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "programming_language": "PYTHON",
            "total_lines_added": "21",
            "total_lines_removed": "5"
          }
        },
        {
          "item": {
            "programming_language": "GO",
            "total_lines_added": "31",
            "total_lines_removed": "27"
          }
        }
      ]
    }
  ]
}

Antwort mit PCW-Daten

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "ai_bytes": "6018",
            "autocomplete_bytes": "4593",
            "command_bytes": "1425",
            "pcw": "0.61",
            "total": "9900"
          }
        }
      ]
    }
  ]
}

Wichtige Hinweise

PCW (Percent Code Written) weist innerhalb einzelner Tage oder bei einzelnen Nutzern eine hohe Varianz auf – für aussagekräftigere Ergebnisse über mehrere Wochen aggregieren
Alle Auswahlfelder müssen entweder Aggregationsfunktionen haben oder keines darf eine haben (eine Mischung ist nicht möglich)
Felder mit dem Muster “distinct_*” können nicht in Aggregationen verwendet werden
Feldaliase müssen über alle Auswahlen und Aggregationen hinweg eindeutig sein
Wenn keine Aggregationsfunktion angegeben ist, wird standardmäßig UNSPECIFIED verwendet

Cascade-Analysen abrufen Fehlerbehandlung

⌘I

Documentation Index

​Überblick

​Anfrage

​Struktur der Query-Anfrage

​Auswahlen

​Beispiel für eine Auswahl

​Filter

​Beispiel für einen Filter

​Aggregationen

​Beispiel für eine Aggregation

​Verfügbare Felder

​Nutzerdaten

​Chat-Daten

​Chat-Intent-Typen

​Befehlsdaten

​Befehlsquellen

​Provider-Quellen

​PCW-Daten

​PCW-Filter

​Beispielanfragen

​Beispiel für Nutzerdaten

​Beispiel für Chat-Daten

​Beispiel für Befehlsdaten

​Beispiel für PCW-Daten

​Antwort

​Beispielantworten

​Antwort mit Nutzerdaten

​Antwort mit Chat-Daten

​Antwort mit Befehlsdaten

​Antwort mit PCW-Daten

​Wichtige Hinweise

Überblick

Anfrage

Struktur der Query-Anfrage

Auswahlen

Beispiel für eine Auswahl

Filter

Beispiel für einen Filter

Aggregationen

Beispiel für eine Aggregation

Verfügbare Felder

Nutzerdaten

Chat-Daten

Chat-Intent-Typen

Befehlsdaten

Befehlsquellen

Provider-Quellen

PCW-Daten

PCW-Filter

Beispielanfragen

Beispiel für Nutzerdaten

Beispiel für Chat-Daten

Beispiel für Befehlsdaten

Beispiel für PCW-Daten

Antwort

Beispielantworten

Antwort mit Nutzerdaten

Antwort mit Chat-Daten

Antwort mit Befehlsdaten

Antwort mit PCW-Daten

Wichtige Hinweise