API de Analytics (Enterprise SaaS)

Resumen

Devin Desktop incluye una API de analítica personalizada. Permite consultar datos de Autocomplete, chat y Command, además de aplicar diversos filtros, agrupaciones y agregaciones. Incluimos todos los ejemplos en curl; luego pueden traducirse a solicitudes HTTP en otros lenguajes.

La API de Analytics está disponible para los planes Enterprise

Especificación de la API de analítica de datos de usuarios

Los datos de la tabla Users de la página Teams se pueden obtener con el siguiente comando:

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "<SERVICE_KEY>",
  "group_name": "<GROUP_NAME>",
  "start_timestamp": "<START_TIMESTAMP>",
  "end_timestamp": "<END_TIMESTAMP>"
}' \
https://server.codeium.com/api/v1/UserPageAnalytics

SERVICE_KEY: La clave de servicio: un usuario Admin puede crearla desde la sección de claves de servicio de la página de Settings. El rol de la clave de servicio debe tener permisos de “Teams de solo lectura”. GROUP_NAME: El nombre de un grupo para filtrar. Este campo es opcional. START_TIMESTAMP/END_TIMESTAMP: Marcas de tiempo en formato RFC 3339, por ejemplo, 2023-01-01T00:00:00Z

Ejemplo de salida

{
  "userTableStats": [
    {
      "name": "Alice",
      "email": "alice@cognition.ai",
      "lastUpdateTime": "2024-10-10T22:56:10.771591Z",
      "apiKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
      "activeDays": 178,
      "teamStatus": "USER_TEAM_STATUS_APPROVED"
    },
    {
      "name": "Bob",
      "email": "bob@cognition.ai",
      "lastUpdateTime": "2024-10-10T18:11:23.980237Z",
      "apiKey": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb",
      "activeDays": 462,
      "teamStatus": "USER_TEAM_STATUS_APPROVED"
    },
    {
      "name": "Charlie",
      "email": "charlie@cognition.ai",
      "lastUpdateTime": "2024-10-10T16:43:46.117870Z",
      "apiKey": "cccccccc-cccc-cccc-cccc-cccccccccccc",
      "activeDays": 237,
      "teamStatus": "USER_TEAM_STATUS_PENDING"
    }
  ]
}

Especificación de la API de Analytics de Cascade

Los datos específicos de Cascade que aparecen en la página de analytics pueden consultarse a través de la API.

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "<SERVICE_KEY>",
  "group_name": "<GROUP_NAME>",
  "start_timestamp": "<START_TIMESTAMP>",
  "end_timestamp": "<END_TIMESTAMP>",
  "emails": ["<EMAIL>","<EMAIL>,..."],
  "ide_types": ["<IDE_TYPE>","<IDE_TYPE>,..."],
  "query_requests": [
   {
    "<CASCADE_DATA_SOURCE>": {}
   }
  ]
}' \
https://server.codeium.com/api/v1/CascadeAnalytics

SERVICE_KEY: La clave de servicio; un usuario Admin puede crear una nueva desde Team Settings GROUP_NAME: El nombre de un grupo por el que filtrar. Este campo es opcional. No se puede establecer si emails está establecido. START_TIMESTAMP/END_TIMESTAMP: Marcas de tiempo en formato RFC 3339, por ejemplo, 2023-01-01T00:00:00Z EMAILS: Una lista de correos electrónicos por los que filtrar. Este campo es opcional. No se puede establecer si group_name está establecido. IDE_TYPES: Una lista de tipos de IDE por los que filtrar. Este campo es opcional. Los valores posibles se describen a continuación. QUERY_REQUESTS: Una lista de consultas que se deben realizar. Este campo es obligatorio. Los valores posibles de CASCADE_DATA_SOURCE se describen a continuación.

Consulta de ejemplo

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "my_random_test_key",
  "group_name": "my_group_name",
  "start_timestamp": "2025-01-01T00:00:00Z",
  "end_timestamp": "2025-01-02T00:00:00Z",
  "emails": ["my_email@cognition.ai", "my_email2@cognition.ai"],
  "ide_types": ["editor"],
  "query_requests": [
   {
    "cascade_lines": {}
   },
   {
    "cascade_runs": {}
   }
  ]
}' \
https://server.codeium.com/api/v1/CascadeAnalytics

Tipos de IDE

Dividimos los datos de cascade en categorías según el tipo de IDE. Si se excluye el campo ide_types de la query, se devuelven datos de todos ellos. Si quieres consultar datos de solo uno de los IDE, puedes usar cualquiera de las siguientes opciones:

“editor” para el editor de Devin Desktop
“jetbrains” para el plugin de JetBrains
“cli” para Devin CLI

Al filtrar por Devin CLI ("cli"), solo cascade_runs devuelve datos. Las fuentes de datos cascade_lines y cascade_tool_usage no son compatibles con Devin CLI y devolverán resultados vacíos.

Fuentes de datos de Cascade

Hay tres valores posibles para CASCADE_DATA_SOURCE

Fuente: cascade_lines

Usa cascade_lines para consultar datos sobre las líneas de Cascade sugeridas y aceptadas cada día. Ejemplo de salida:

{
  "queryResults": [
    {
      "cascadeLines": {
        "cascadeLines": [
          {
            "day": "2025-05-01T00:00:00Z",
            "linesSuggested": "206",
            "linesAccepted": "157"
          },
          {
            "day": "2025-05-02T00:00:00Z",
            "linesSuggested": "16"
          },
          {
            "day": "2025-05-03T00:00:00Z",
            "linesSuggested": "169",
            "linesAccepted": "168"
          }
        ]
      }
    }
  ]
}

linesSuggested: El número de líneas sugeridas ese día. linesAccepted: El número de líneas aceptadas ese día.

Fuente: cascade_runs

Utiliza cascade_runs para consultar datos sobre el uso del modelo, el consumo de créditos y el modo. Resultado de ejemplo:

{
  "queryResults": [
    {
      "cascadeRuns": {
        "cascadeRuns": [
          {
            "day": "2025-05-01T00:00:00Z",
            "model": "Claude 3.7 Sonnet (Thinking)",
            "mode": "CONVERSATIONAL_PLANNER_MODE_DEFAULT",
            "messagesSent": "1",
            "cascadeId": "0d35c1f7-0a85-41d0-ac96-a04cd2d64444"
          },
          {
            "day": "2025-05-01T00:00:00Z",
            "model": "SWE-1",
            "mode": "UNKNOWN",
            "promptsUsed": "125",
            "cascadeId": "0d35c1f7-0a85-41d0-ac96-a04cd2d64444"
          },
          {
            "day": "2025-05-01T00:00:00Z",
            "model": "GPT-4.1 (promo)",
            "mode": "CONVERSATIONAL_PLANNER_MODE_DEFAULT",
            "messagesSent": "5",
            "cascadeId": "1f450ba3-06aa-4ba5-9e12-d3b98c2d33d3"
          },
        ]
      }
    }
  ]
}

day: La fecha de la ejecución. model: El modelo utilizado para el mensaje. mode: El modo de la ejecución. Uno de CONVERSATIONAL_PLANNER_MODE_DEFAULT (para el modo de escritura), CONVERSATIONAL_PLANNER_MODE_READ_ONLY (para el modo de solo lectura), CONVERSATIONAL_PLANNER_MODE_NO_TOOL (para el modo heredado) o UNKNOWN. messagesSent: El número de mensajes enviados. cascadeId: El ID de la ejecución. Este ID puede usarse para comprender cuántas conversaciones distintas se han iniciado (y no cuántas veces el usuario envía un mensaje). promptsUsed: La cantidad de créditos utilizada. Este valor se devuelve en centavos. Por ejemplo, 0.25 créditos se devuelve como 25 y 1 crédito se devuelve como 100. Los datos devueltos por la API están en formato sin procesar, lo que puede explicar cualquier valor “UNKNOWN”. Si usas esta fuente de datos para tus propias métricas, se recomienda agregar según las métricas específicas que te interesen (p. ej., sumar el campo promptsUsed para comprender los patrones de uso del usuario, messagesSent para comprender la interacción del usuario, etc.), ya que es posible que los datos de mode y prompt estén divididos entre varias entradas.

Fuente: cascade_tool_usage

Usa cascade_tool_usage para consultar datos sobre el uso de herramientas. Ten en cuenta que esto devuelve un recuento agregado del uso de herramientas durante el período proporcionado. Resultado de ejemplo:

{
  "queryResults": [
    {
      "cascadeToolUsage": {
        "cascadeToolUsage": [
          {
            "tool": "CODE_ACTION",
            "count": "15"
          },
          {
            "tool": "LIST_DIRECTORY",
            "count": "20"
          },
          {
            "tool": "MCP_TOOL",
            "count": "12"
          },
          {
            "tool": "MEMORY",
            "count": "4"
          }
        ]
      }
    }
  ]
}

tool: La herramienta utilizada en el mensaje. count: El número de veces que se utilizó la herramienta. A continuación se muestra una correspondencia entre los enums devueltos y el nombre legible, tal como aparece en la UI:

CODE_ACTION: ‘Editar código’
VIEW_FILE: ‘Ver archivo’
RUN_COMMAND: ‘Ejecutar comando’
FIND: ‘Herramienta Find’
GREP_SEARCH: ‘Búsqueda Grep’
VIEW_FILE_OUTLINE: ‘Ver esquema del archivo’
MQUERY: ‘Riptide’
LIST_DIRECTORY: ‘Listar directorio’
MCP_TOOL: ‘Herramienta MCP’
PROPOSE_CODE: ‘Proponer código’
SEARCH_WEB: ‘Buscar en la web’
MEMORY: ‘Memoria’
PROXY_WEB_SERVER: ‘Vista previa del navegador’
DEPLOY_WEB_APP: ‘Desplegar aplicación web’

Especificación de la Custom Analytics API

Ciertas fuentes de datos permiten realizar consultas personalizables mediante la Custom Analytics API. Los esquemas completos de selecciones, filtros, agregaciones y ordenaciones se encuentran en la siguiente sección, en formato JSON. Al final del documento se incluyen consultas de ejemplo para cada una de las tres fuentes de datos, así como consejos para depurar consultas.

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": "<SERVICE_KEY>",
  "group_name": "<GROUP_NAME>",
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_<DATA_SOURCE>",
      "selections": [
        <LIST OF SELECTIONS>
      ],
      "filters": [
        <LIST OF FILTERS>
      ],
      "aggregations": [
        <LIST OF AGGREGATIONS>
      ],
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

DATA_SOURCE: selecciona USER_DATA, CHAT_DATA, COMMAND_DATA, PCW_DATA o CASCADE_DATA según busques datos de Autocomplete, chat, Command, PCW o Cascade. SERVICE_KEY: La clave de servicio; un usuario Admin puede crear una nueva desde Team Settings. El rol de la clave de servicio debe tener el permiso “Analytics Read”. GROUP_NAME: El nombre de un grupo para filtrar. Este campo es opcional.

Esquemas

Selecciones

Las selecciones son obligatorias. Cada selección corresponde a un valor que se va a consultar.

{
  "field": "<FIELD_NAME>",
  "name": "<NAME>",
  "aggregation_function": "QUERY_AGGREGATION_<AGGREGATION_FUNCTION>"
}

FIELD_NAME: El campo que desea consultar. Consulte la sección Campos disponibles a continuación. NAME: Un alias para el campo. Si no se especifica, será la versión en minúsculas de <AGGREGATION_FUNCTION>_<FIELD_NAME>, p. ej., sum_num_acceptances. Debe ser distinto de todos los demás nombres de campos y agregaciones. AGGREGATION_FUNCTION: Debe ser uno de UNSPECIFIED, COUNT, SUM, AVG, MAX, MIN. Si no se proporciona “aggregation_function”, el valor predeterminado es UNSPECIFIED.

Filtros

Los filtros se utilizan para limitar los datos de modo que solo incluyan elementos que cumplan ciertos criterios. Son opcionales.

{
  "name": "<NAME>",
  "value": "<VALUE>",
  "filter": "QUERY_FILTER_<FILTER>"
}

NAME: El nombre del campo que quieres filtrar. Si el elemento filtrado es el mismo que una Selección/Agregación, debe ser igual al nombre del campo o de la agregación. VALUE: el valor que se compara. FILTER: Uno de EQUAL, NOT_EQUAL, GREATER_THAN, LESS_THAN, GE (mayor o igual), LE (menor o igual).

Agregaciones

Las agregaciones se utilizan para dividir los datos en grupos según un criterio específico. Son opcionales.

{
  "field": <FIELD_NAME>,
  "name": <NAME>
}

FIELD_NAME: El campo que quieres consultar. Consulta la sección Campos disponibles. NAME: Un alias del campo. Debe ser distinto de todos los demás nombres de campos y agregaciones.

Campos disponibles

Datos de usuario

Todos los datos de la fuente USER_DATA se agregan por usuario y por hora. Nota: PCW (porcentaje de código escrito) ahora tiene su propia tabla y no depende de la tabla user_data.

Nombre del campo	Descripción	Agregaciones válidas
api_key	El hash de la API key del usuario.	UNSPECIFIED, COUNT
date	La fecha en UTC del Autocomplete.	UNSPECIFIED, COUNT
date UTC-x	La fecha del Autocomplete, con un desfase de zona horaria. Por ejemplo, PST sería “date UTC-8”.	UNSPECIFIED, COUNT
hour	La hora en UTC de los Autocomplete.	UNSPECIFIED, COUNT
language	El lenguaje de programación utilizado.	UNSPECIFIED, COUNT
ide	El IDE utilizado.	UNSPECIFIED, COUNT
version	La versión de Devin Desktop utilizada	UNSPECIFIED, COUNT
num_acceptances	La cantidad de veces que el usuario aceptó un Autocomplete. Esto ocurre cuando el usuario escribe algo de código, ve texto en gris y pulsa Tab.	SUM, MAX, MIN, AVG
num_lines_accepted	Líneas de código aceptadas de Autocomplete.	SUM, MAX, MIN, AVG
num_bytes_accepted	Bytes aceptados de Autocomplete.	SUM, MAX, MIN, AVG
distinct_users	Usuarios únicos.	UNSPECIFIED, COUNT
distinct_developer_days	Tuplas únicas de (usuarios, día).	UNSPECIFIED, COUNT
distinct_developer_hours	Tuplas únicas de (usuarios, hora del día).	UNSPECIFIED, COUNT

Datos del chat

Ten en cuenta que todos los datos proporcionados en la API de datos del chat corresponden a las respuestas del modelo de chat, no a las preguntas del usuario.

Nombre del campo	Descripción	Agregaciones válidas
api_key	Un hash de la API key del usuario	UNSPECIFIED, COUNT
model_id	El ID del modelo de chat, establecido en el momento del despliegue.	UNSPECIFIED, COUNT
date	La fecha UTC de la respuesta del chat.	UNSPECIFIED, COUNT
date UTC-x	La fecha de la respuesta del chat, con un desfase de zona horaria. Por ejemplo, PST sería “date UTC-8”.	UNSPECIFIED, COUNT
ide	El IDE que se estaba utilizando	UNSPECIFIED, COUNT
version	La versión de Devin Desktop utilizada	UNSPECIFIED, COUNT
latest_intent_type	Indica si la respuesta del modelo se genera a partir de un code lens o de un chat normal. Los chats normales corresponderán a: CHAT_INTENT_GENERIC mientras que los code lens corresponderán a uno de los siguientes: CHAT_INTENT_FUNCTION_EXPLAIN CHAT_INTENT_FUNCTION_DOCSTRING CHAT_INTENT_FUNCTION_REFACTOR CHAT_INTENT_CODE_BLOCK_EXPLAIN CHAT_INTENT_CODE_BLOCK_REFACTOR CHAT_INTENT_PROBLEM_EXPLAIN CHAT_INTENT_FUNCTION_UNIT_TESTS	UNSPECIFIED, COUNT
num_chats_received	Número de mensajes de chat enviados desde Devin Desktop al usuario.	SUM, MAX, MIN, AVG
chat_accepted	True si se envió un bloque de código en la respuesta de chat de Devin Desktop y se hizo clic en el botón de pulgar hacia arriba.	SUM, COUNT
chat_inserted_at_cursor	True si se envió un bloque de código en la respuesta de chat de Devin Desktop y se hizo clic en el botón “Insert”.	SUM, COUNT
chat_applied	True si se envió un bloque de código en la respuesta de chat de Devin Desktop y se hizo clic en el botón “Apply Diff”.	SUM, COUNT
chat_loc_used	Líneas de código utilizadas si se envió un bloque de código en el chat de Devin Desktop y se presionó cualquiera de los botones “Insert”, “Copy” o “Apply Diff”.	SUM, MAX, MIN, AVG

Datos de Command

Ten en cuenta que la fuente de datos de Command contiene todos los comandos, incluidos los que se rechazaron. El campo “accepted” puede usarse para filtrar solo los comandos aceptados.

Nombre del campo	Descripción	Agregaciones válidas
api_key	Un hash de la API key del usuario.	UNSPECIFIED, COUNT
date	La fecha UTC del comando.	UNSPECIFIED, COUNT
timestamp	La marca de tiempo UTC del comando.	UNSPECIFIED, COUNT
language	El lenguaje de programación que se está usando.	UNSPECIFIED, COUNT
ide	El IDE que se estaba usando.	UNSPECIFIED, COUNT
version	La versión de Devin Desktop utilizada	UNSPECIFIED, COUNT
command_source	El motivo por el que se activó el comando. Los valores válidos son: COMMAND_REQUEST_SOURCE_LINE_HINT_CODE_LENS COMMAND_REQUEST_SOURCE_DEFAULT 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 COMMAND_REQUEST_SOURCE_DEFAULT corresponde al uso habitual de Command.	UNSPECIFIED, COUNT
provider_source	Determina si el comando se activó en modo de generación o de edición. Los valores válidos son: PROVIDER_SOURCE_COMMAND_GENERATE PROVIDER_SOURCE_COMMAND_EDIT	UNSPECIFIED, COUNT
lines_added	Número de líneas de código agregadas por el comando.	SUM, MAX, MIN, AVG
lines_removed	Número de líneas de código eliminadas por el comando.	SUM, MAX, MIN, AVG
bytes_added	Número de bytes agregados por el comando.	SUM, MAX, MIN, AVG
bytes_removed	Número de bytes eliminados por el comando.	SUM, MAX, MIN, AVG
selection_lines	Número de líneas de código seleccionadas por el comando. Siempre debe ser cero en las generaciones.	SUM, MAX, MIN, AVG
selection_bytes	Número de bytes seleccionados por el comando. Siempre debe ser cero en las generaciones.	SUM, MAX, MIN, AVG
accepted	Indica si el comando fue aceptado.	SUM, COUNT

Datos de PCW

Selecciones válidas

Nombre del campo	Descripción	Agregaciones válidas
percent_code_written	Porcentaje de código escrito. Se calcula como (número de bytes de codeium generados) / (número de bytes de codeium generados + número de bytes generados por el usuario). Esta métrica puede tener una alta variabilidad en un solo día o entre usuarios, por lo que recomendamos agregarla por semanas.	UNSPECIFIED
codeium_bytes	número total de bytes de codeium, que equivale a codeium_bytes_by_autocomplete + codeium_bytes_by_command	UNSPECIFIED
user_bytes	número total de bytes generados por el usuario	UNSPECIFIED
total_bytes	codeium_bytes + user_bytes	UNSPECIFIED
codeium_bytes_by_autocomplete	número total de bytes de codeium generados a partir de Autocomplete	UNSPECIFIED
codeium_bytes_by_command	número total de bytes de codeium generados a partir de Command	UNSPECIFIED

Datos de Cascade

La fuente de datos de Cascade contiene una entrada por cada mensaje que se envía a Cascade.

Para acceder a todos los campos que se enumeran a continuación, asegúrate de usar la versión 1.11.2 o posterior.

Nombre del campo	Descripción	Agregaciones válidas
api_key	Un hash de la API key del usuario.	UNSPECIFIED, COUNT
date	La fecha UTC del comando.	UNSPECIFIED, COUNT
prompts_used	La cantidad de créditos de prompt usados en el prompt para Cascade, devuelta en centavos. Por ejemplo, 0.25 créditos se devuelve como 25 y 1 crédito se devuelve como 100.	UNSPECIFIED, SUM, AVG, MIN, MAX
flex_credits_used	La cantidad de créditos adicionales o compartidos usados del total de prompts_used en un prompt para Cascade, devuelta en centavos. Por ejemplo, 0.25 créditos se devuelve como 25 y 1 crédito se devuelve como 100.	UNSPECIFIED, SUM, AVG, MIN, MAX
model	El modelo usado para el mensaje enviado a Cascade.	UNSPECIFIED, COUNT
metadata	Un objeto que contiene metadatos relacionados con el entorno de desarrollo. Los campos actualmente rellenados incluyen: ideVersion	UNSPECIFIED, COUNT

Filtros válidos


Nombre del campo	Descripción	Algunos ejemplos
api_key	Un hash de la API key del usuario.
language	El lenguaje de programación utilizado.	KOTLIN, GO, JAVA
ide	El IDE utilizado.	jetbrains, vscode
version	La versión de Devin Desktop utilizada	1.28.0, 130.0

Para filtrar por fecha, usa start_timestamp y end_timestamp, que deben estar en formato RFC 3339 (p. ej., 2023-01-01T00:00:00Z; consulta el ejemplo a continuación).

Ejemplos

Datos de usuario

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

Esta consulta calcula el porcentaje total de código escrito durante el mes de enero de 2024. Respuesta de ejemplo (JSON formateado para facilitar la lectura):

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "num_acceptances": "125",
            "num_lines_accepted": "863"
          }
        }
      ]
    }
  ]
}

Datos del chat

curl -X POST --header "Content-Type: application/json" \
--data '{
  "service_key": SERVICE_KEY,
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_CHAT_DATA",
      "selections": [
        {
          "field": "chat_loc_used",
          "name": "chat_loc_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"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

Esta consulta muestra el número de líneas de código aceptadas mediante el code lens “Generate Docstring” a lo largo de todo el tiempo, agrupadas por IDE. Respuesta de ejemplo:

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "chat_loc_used": "74",
            "ide": "jetbrains"
          },
        },
        {
          "item": {
            "chat_loc_used":"41",
            "ide":"vscode"
          },
        }
      ]
    }
  ]
}

Datos de Command

curl -X POST --header "Content-Type: application/json" \
--data '{
 "service_key": SERVICE_KEY,
  "query_requests": [
    {
      "data_source": "QUERY_DATA_SOURCE_COMMAND_DATA",
     "selections": [
        {
          "field": "lines_added",
          "name": "lines_added",
          "aggregation_function": "QUERY_AGGREGATION_SUM"
        },
        {
          "field": "lines_removed",
          "name": "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": "language"
        }
      ]
    }
  ]
}' \
https://server.codeium.com/api/v1/Analytics

Esta consulta devuelve la cantidad de líneas agregadas y eliminadas en los comandos “edit”, agrupadas por lenguaje de programación. Respuesta de ejemplo:

{
  "queryResults": [
    {
      "responseItems": [
        {
          "item": {
            "language": "SHELL",
            "lines_added": "5",
            "lines_removed": "3"
          }
        },
        {
          "item": {
            "language": "GO",
            "lines_added": "31",
            "lines_removed": "27"
          }
        },
        {
          "item": {
            "language": "PYTHON",
            "lines_added": "21",
            "lines_removed": "5"
          }
        },
        {
          "item": {
            "language": "UNSPECIFIED",
            "lines_added": "91",
            "lines_removed": "71"
          }
        },
        {
          "item": {
            "language": "STARLARK",
            "lines_added": "13",
            "lines_removed": "1"
          }
        }
      ]
    }
  ]
}

Datos de PCW

curl -X POST --header "Content-Type: application/json" \
--data '{
    "service_key": SERVICE_KEY,
    "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": "percent_code_written"
          },
          {
             "field": "codeium_bytes",
             "name": "codeium_bytes"
          },
          {
             "field": "total_bytes",
             "name": "total_bytes"
          },
          {
             "field": "codeium_bytes_by_autocomplete",
            "name": "codeium_bytes_by_autocomplete"
          },
          {
             "field": "codeium_bytes_by_command",
             "name": "codeium_bytes_by_command"
          }
       ],
     "filters": [
         {
            "filter": "QUERY_FILTER_EQUAL",
            "name": "language",
            "value": "GO"
         }
      ]
    }
  ],
}' \
https: //server.codeium.com/api/v1/Analytics

Esta consulta devuelve los datos de PCW (porcentaje de código escrito), junto con los bytes filtrados por el lenguaje Go. Respuesta de ejemplo:

{
  "queryResults": [
    {
      "responseItems": [
         {
            "item": {
               "codeium_bytes": "6018",
               "codeium_bytes_by_autocomplete": "4593",
               "codeium_bytes_by_command": "1425",
               "percent_code_written": "0.61",
               "total_bytes": "9900"
             }
         }
     ]
   }
  ]
}

Depuración de consultas

A partir de la versión 1.10.0, las consultas no válidas devolverán un mensaje de error. Esta sección incluye algunos mensajes de error comunes, qué significan y cómo depurar las consultas correspondientes.

Mensaje de error	Explicación
at least one field or aggregation is required	No se detectó ninguna selección ni agregación; asegúrate de que la solicitud de consulta contenga al menos una.
invalid aggregation function for string type field ide: QUERY_AGGREGATION_SUM	Una de las selecciones usó una función de agregación no válida. En este caso, se intentó usar SUM en el campo “ide”, pero solo admite COUNT y UNSPECIFIED.
invalid query table: QUERY_DATA_SOURCE_UNSPECIFIED	Probablemente haya un error tipográfico en el campo data_source; vuelve a comprobar la ortografía.
all selection fields should have an aggregation function, or none of them should	Si hay múltiples campos de selección, todos deben contener un aggregation_function o ninguno debe contenerlo. Por ejemplo, esta selección no es válida porque num_acceptances se suma, pero num_lines_accepted no: `"selections": [ { "field": "num_acceptances", "name": "total_acceptances", "aggregation_function": "QUERY_AGGREGATION_SUM" }, { "field": "num_lines_accepted", "name": "total_lines_accepted", "aggregation_function": "QUERY_AGGREGATION_UNSPECIFIED" } ]` Nota: PCW siempre se considera agregado. Si no se elige explícitamente ningún aggregation_function, se considera no especificado. Si quieres información sobre ambos campos, usa dos consultas separadas.
invalid aggregation function for string type field ide: QUERY_AGGREGATION_SUM	No todos los campos admiten todas las funciones de agregación; consulta la sección de campos disponibles para ver cuáles corresponden. En este caso, la consulta usó la función de agregación QUERY_AGGREGATION_SUM con el campo “ide”, lo cual no es válido.
tried to aggregate on a distinct field: distinct_developer_days. Consider aggregating on the non-distinct fields instead: [api_key date]	Los campos con el patrón “distinct_*” no pueden estar en la sección aggregations; el error sugiere uno o varios campos alternativos sobre los que agregar. Así que, en lugar de: `"aggregations": [ { "field": "distinct_developer_days", "name": "distinct_developer_days" } ]` Prueba: `"aggregations": [ { "field": "api_key", "name": "api_key" }, { "field": "date", "name": "date" } ]`
duplicate field alias for selection/aggregation: num_acceptances	Todas las selecciones y agregaciones deben tener un nombre distinto. Ten en cuenta que, si no se especifica el nombre, de forma predeterminada se establece como <AGGREGATION_FUNCTION>_<FIELD_NAME>.
invalid group name: GroupName	No se encontró el grupo con el nombre especificado; vuelve a comprobar la ortografía.

​Resumen

​Especificación de la API de analítica de datos de usuarios

​Ejemplo de salida

​Especificación de la API de Analytics de Cascade

​Consulta de ejemplo

​Tipos de IDE

​Fuentes de datos de Cascade

​Fuente: cascade_lines

​Fuente: cascade_runs

​Fuente: cascade_tool_usage

​Especificación de la Custom Analytics API

​Esquemas

​Selecciones

​Filtros

​Agregaciones

​Campos disponibles

​Datos de usuario

​Datos del chat

​Datos de Command

​Datos de PCW

​Selecciones válidas

​Datos de Cascade

​Filtros válidos

​Ejemplos

​Datos de usuario

​Datos del chat

​Datos de Command

​Datos de PCW

​Depuración de consultas

Resumen

Especificación de la API de analítica de datos de usuarios

Ejemplo de salida

Especificación de la API de Analytics de Cascade

Consulta de ejemplo

Tipos de IDE

Fuentes de datos de Cascade

Fuente: cascade_lines

Fuente: cascade_runs

Fuente: cascade_tool_usage

Especificación de la Custom Analytics API

Esquemas

Selecciones

Filtros

Agregaciones

Campos disponibles

Datos de usuario

Datos del chat

Datos de Command

Datos de PCW

Selecciones válidas

Datos de Cascade

Filtros válidos

Ejemplos

Datos de usuario

Datos del chat

Datos de Command

Datos de PCW

Depuración de consultas