Consulta Personalizada de Analytics

curl --request POST \
  --url https://server.codeium.com/api/v1/Analytics \
  --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

Consulta Personalizada de Analytics

curl --request POST \
  --url https://server.codeium.com/api/v1/Analytics \
  --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": {}
        }
      ]
    }
  ]
}

Visão geral

A Analytics API personalizada oferece recursos flexíveis de consulta para dados de Autocomplete, Chat e Command, com selections, filtros, aggregations e ordenações personalizáveis.

Request

service_key

string

obrigatório

Sua Service Key com permissões de “Analytics Read”

group_name

string

Filtra os resultados para usuários em um grupo específico (opcional)

query_requests

array

obrigatório

Array de objetos de requisição de consulta que definem os dados a serem recuperados

Mostrar Query Request Object

data_source

string

obrigatório

Fonte de dados a consultar. Opções:

QUERY_DATA_SOURCE_USER_DATA - dados de Autocomplete
QUERY_DATA_SOURCE_CHAT_DATA - dados de Chat
QUERY_DATA_SOURCE_COMMAND_DATA - dados de Command
QUERY_DATA_SOURCE_PCW_DATA - dados de Percent Code Written

selections

array

obrigatório

Array de seleções de campos a serem recuperadas

Mostrar Selection Object

field

string

obrigatório

Nome do campo a selecionar (consulte a seção Available Fields)

name

string

Apelido (alias) para o campo. Se não for especificado, o padrão é {aggregation_function}_{field_name} (em minúsculas)

aggregation_function

string

Função de agregação a aplicar:

QUERY_AGGREGATION_UNSPECIFIED (padrão)
QUERY_AGGREGATION_COUNT
QUERY_AGGREGATION_SUM
QUERY_AGGREGATION_AVG
QUERY_AGGREGATION_MAX
QUERY_AGGREGATION_MIN

filters

array

Array de filtros a serem aplicados

Mostrar Filter Object

name

string

obrigatório

Nome do campo a filtrar

filter

string

obrigatório

Operação de filtro:

QUERY_FILTER_EQUAL
QUERY_FILTER_NOT_EQUAL
QUERY_FILTER_GREATER_THAN
QUERY_FILTER_LESS_THAN
QUERY_FILTER_GE (maior que ou igual)
QUERY_FILTER_LE (menor que ou igual)

value

string

obrigatório

Valor a ser comparado

aggregations

array

Array de agregações para agrupamento

Mostrar Aggregation Object

field

string

obrigatório

Nome do campo pelo qual agrupar

name

string

obrigatório

Apelido (alias) para o campo de agregação

Estrutura da solicitação de consulta

Cada objeto de solicitação de consulta contém:

data_source (obrigatório): Fonte de dados a consultar
selections (obrigatório): Array de seleções de campos a recuperar
filters (opcional): Array de filtros a aplicar
aggregations (opcional): Array de aggregations para agrupamento

Selections

Selections definem quais campos recuperar e como agregá-los.

field (obrigatório): Nome do campo a selecionar
name (opcional): Apelido (alias) para o campo
aggregation_function (opcional): Função de agregação a aplicar

Exemplo de Seleção

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

Filtros

Filtros restringem os dados a elementos que atendem a critérios específicos.

name (obrigatório): Nome do campo a ser usado no filtro
filter (obrigatório): Operação de filtro
value (obrigatório): Valor a ser usado na comparação

Exemplo de filtro

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

Aggregations

Aggregations agrupam dados com base em critérios especificados.

field (obrigatório): Nome do campo usado para agrupar
name (obrigatório): Alias para o campo de aggregation

Exemplo de agregação

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

Campos disponíveis

Dados do usuário

Todos os dados do usuário são agregados por usuário, por hora.

Nome do campo	Descrição	Agregações válidas
`api_key`	Hash da chave de API do usuário	UNSPECIFIED, COUNT
`date`	Data em UTC da autocompletação	UNSPECIFIED, COUNT
`date UTC-x`	Data com deslocamento de fuso horário (por exemplo, “date UTC-8” para PST)	UNSPECIFIED, COUNT
`hour`	Hora em UTC da autocompletação	UNSPECIFIED, COUNT
`language`	Linguagem de programação	UNSPECIFIED, COUNT
`ide`	IDE em uso	UNSPECIFIED, COUNT
`version`	Versão do Windsurf	UNSPECIFIED, COUNT
`num_acceptances`	Número de aceitações do Autocomplete	SUM, MAX, MIN, AVG
`num_lines_accepted`	Linhas de código aceitas	SUM, MAX, MIN, AVG
`num_bytes_accepted`	Bytes aceitos	SUM, MAX, MIN, AVG
`distinct_users`	Usuários distintos	UNSPECIFIED, COUNT
`distinct_developer_days`	Tuplas distintas (usuário, dia)	UNSPECIFIED, COUNT
`distinct_developer_hours`	Tuplas distintas (usuário, hora)	UNSPECIFIED, COUNT

Dados de Chat

Todos os Dados de Chat representam respostas do modelo de chat, não perguntas do usuário.

Field Name	Description	Valid Aggregations
`api_key`	Hash da chave de API do usuário	UNSPECIFIED, COUNT
`model_id`	ID do modelo de Chat	UNSPECIFIED, COUNT
`date`	Data em UTC da resposta do chat	UNSPECIFIED, COUNT
`date UTC-x`	Data com offset de fuso horário	UNSPECIFIED, COUNT
`ide`	IDE em uso	UNSPECIFIED, COUNT
`version`	Versão do Windsurf	UNSPECIFIED, COUNT
`latest_intent_type`	Tipo de intenção do Chat (veja Tipos de Intenção abaixo)	UNSPECIFIED, COUNT
`num_chats_received`	Número de mensagens de chat recebidas	SUM, MAX, MIN, AVG
`chat_accepted`	Indica se o chat foi aceito (polegar para cima)	SUM, COUNT
`chat_inserted_at_cursor`	Indica se o botão “Insert” foi clicado	SUM, COUNT
`chat_applied`	Indica se o botão “Apply Diff” foi clicado	SUM, COUNT
`chat_loc_used`	Linhas de código usadas pelo chat	SUM, MAX, MIN, AVG

Tipos de intenção do Chat

CHAT_INTENT_GENERIC - Chat comum
CHAT_INTENT_FUNCTION_EXPLAIN - CodeLens de explicação de função
CHAT_INTENT_FUNCTION_DOCSTRING - CodeLens de docstring de função
CHAT_INTENT_FUNCTION_REFACTOR - CodeLens de refatoração de função
CHAT_INTENT_CODE_BLOCK_EXPLAIN - CodeLens de explicação de bloco de código
CHAT_INTENT_CODE_BLOCK_REFACTOR - CodeLens de refatoração de bloco de código
CHAT_INTENT_PROBLEM_EXPLAIN - CodeLens de explicação de problema
CHAT_INTENT_FUNCTION_UNIT_TESTS - CodeLens de testes unitários de função

Dados do Command

Os dados do Command incluem todos os comandos, inclusive os recusados. Use o campo accepted para filtrar apenas os comandos aceitos.

Field Name	Description	Valid Aggregations
`api_key`	Hash da chave de API do usuário	UNSPECIFIED, COUNT
`date`	Data UTC do comando	UNSPECIFIED, COUNT
`timestamp`	Timestamp (UTC) do comando	UNSPECIFIED, COUNT
`language`	Linguagem de programação	UNSPECIFIED, COUNT
`ide`	IDE em uso	UNSPECIFIED, COUNT
`version`	Versão do Windsurf	UNSPECIFIED, COUNT
`command_source`	Origem do acionamento do Command (veja Command Sources abaixo)	UNSPECIFIED, COUNT
`provider_source`	Modo de geração ou edição	UNSPECIFIED, COUNT
`lines_added`	Linhas de código adicionadas	SUM, MAX, MIN, AVG
`lines_removed`	Linhas de código removidas	SUM, MAX, MIN, AVG
`bytes_added`	Bytes adicionados	SUM, MAX, MIN, AVG
`bytes_removed`	Bytes removidos	SUM, MAX, MIN, AVG
`selection_lines`	Linhas selecionadas (zero para gerações)	SUM, MAX, MIN, AVG
`selection_bytes`	Bytes selecionados (zero para gerações)	SUM, MAX, MIN, AVG
`accepted`	Indica se o comando foi aceito	SUM, COUNT

Fontes do Command

COMMAND_REQUEST_SOURCE_LINE_HINT_CODE_LENS
COMMAND_REQUEST_SOURCE_DEFAULT - Uso típico do Command
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

Fontes do provedor

PROVIDER_SOURCE_COMMAND_GENERATE - Modo de geração
PROVIDER_SOURCE_COMMAND_EDIT - Modo de edição

Dados de PCW

Dados de Percent Code Written com rastreamento separado para contribuições de Autocomplete e Command.

Field Name	Description	Valid Aggregations
`percent_code_written`	Calculado como codeium_bytes / (codeium_bytes + user_bytes)	UNSPECIFIED
`codeium_bytes`	Total de bytes gerados pelo Codeium	UNSPECIFIED
`user_bytes`	Total de bytes escritos pelo usuário	UNSPECIFIED
`total_bytes`	codeium_bytes + user_bytes	UNSPECIFIED
`codeium_bytes_by_autocomplete`	Bytes do Codeium provenientes de Autocomplete	UNSPECIFIED
`codeium_bytes_by_command`	Bytes do Codeium provenientes de Command	UNSPECIFIED

Filtros do PCW

Nome do campo	Descrição	Exemplos
`language`	Linguagem de programação	KOTLIN, GO, JAVA
`ide`	IDE em uso	jetbrains, vscode
`version`	Versão do Windsurf	1.28.0, 130.0

Para filtrar por data em consultas do PCW, use start_timestamp e end_timestamp no corpo principal da requisição.

Exemplos de solicitações

Exemplo de dados do usuário

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "sua_chave_de_servico_aqui",
  "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

Exemplo de dados do Chat

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

Exemplo de dados do Command

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

Exemplo de dados do PCW

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

Resposta

queryResults

array

Array de resultados de consulta, um para cada solicitação de consulta

responseItems

array

Array de itens de resultado

item

object

Objeto contendo os campos selecionados e seus valores

Exemplos de respostas

Resposta de Dados do Usuário

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

Resposta de dados do Chat

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

Resposta de dados do Command

{
  "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"
          }
        }
      ]
    }
  ]
}

Resposta de dados do PCW

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

Notas importantes

PCW (Percent Code Written) apresenta alta variância dentro de um mesmo dia ou entre usuários — faça agregações em janelas semanais para obter insights mais consistentes
Todos os campos em selections devem ter funções de agregação, ou nenhum deles deve ter (não é possível misturar)
Campos com o padrão “distinct_*” não podem ser usados em aggregations
Os aliases de campos devem ser exclusivos em todas as selections e aggregations
Se nenhuma função de agregação for especificada, o valor padrão é UNSPECIFIED

Obter Analytics do Cascade Tratamento de erros

⌘I

​Visão geral

​Request

​Estrutura da solicitação de consulta

​Selections

​Exemplo de Seleção

​Filtros

​Exemplo de filtro

​Aggregations

​Exemplo de agregação

​Campos disponíveis

​Dados do usuário

​Dados de Chat

​Tipos de intenção do Chat

​Dados do Command

​Fontes do Command

​Fontes do provedor

​Dados de PCW

​Filtros do PCW

​Exemplos de solicitações

​Exemplo de dados do usuário

​Exemplo de dados do Chat

​Exemplo de dados do Command

​Exemplo de dados do PCW

​Resposta

​Exemplos de respostas

​Resposta de Dados do Usuário

​Resposta de dados do Chat

​Resposta de dados do Command

​Resposta de dados do PCW

​Notas importantes

Visão geral

Request

Estrutura da solicitação de consulta

Selections

Exemplo de Seleção

Filtros

Exemplo de filtro

Aggregations

Exemplo de agregação

Campos disponíveis

Dados do usuário

Dados de Chat

Tipos de intenção do Chat

Dados do Command

Fontes do Command

Fontes do provedor

Dados de PCW

Filtros do PCW

Exemplos de solicitações

Exemplo de dados do usuário

Exemplo de dados do Chat

Exemplo de dados do Command

Exemplo de dados do PCW

Resposta

Exemplos de respostas

Resposta de Dados do Usuário

Resposta de dados do Chat

Resposta de dados do Command

Resposta de dados do PCW

Notas importantes