Saltar al contenido principal
GET
/
api
/
v2alpha
/
analytics
/
active-users
Obtener analíticas de usuarios activos
curl --request GET \
  --url https://server.codeium.com/api/v2alpha/analytics/active-users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "active_users": 142
    }
  ],
  "pagination": {
    "next_page_cursor": null
  },
  "metadata": {
    "data_freshness": "2026-01-16T03:00:00.000Z",
    "query_time_ms": 612,
    "team_id": "team_abc123"
  }
}
Este es un endpoint v2 que usa autenticación con token Bearer y parámetros de consulta, a diferencia de la API de Analytics v1, que usa claves de servicio en el cuerpo de la solicitud. Consulta Autenticación más abajo.
Este endpoint no está pensado para supervisar el uso en tiempo real. Los datos se agregan por hora y el límite de solicitudes es bajo (10 solicitudes por hora por equipo). Úsalo para informes periódicos y exportaciones masivas.

​
Autenticación

Este endpoint utiliza autenticación mediante Bearer token. Incluye tu clave de servicio en el encabezado Authorization: 
Authorization: Bearer <your_service_key>
La clave de servicio debe tener el permiso Analytics Read. Crea una en Team Settings, en la sección “Service Keys”.

​
Qué se considera un usuario activo

Un usuario se considera activo en un intervalo de tiempo determinado si tiene algún evento de facturación en él. El campo active_users indica el número de usuarios distintos.

​
Agrupación y granularidad

Usa granularity y group_by para controlar la estructura de los datos devueltos:
  • Sin granularidad ni agrupación — devuelve una sola fila con el recuento total de usuarios activos para todo el intervalo de fechas
  • granularity=daily — cada fila incluye un timestamp en formato YYYY-MM-DD (usuarios activos diarios)
  • granularity=monthly — cada fila incluye un timestamp en formato YYYY-MM (usuarios activos mensuales)
  • group_by=user — devuelve una fila por cada usuario activo con un user_id; el valor de active_users en cada fila es 1
A diferencia de Obtener consumo, el endpoint de usuarios activos solo admite user como valor de group_by. Otras dimensiones (model_uid, ide) no son válidas aquí.
Los resultados se paginan con un tamaño de página predeterminado de 1.000 filas (máx. 10.000). Cuando hay más resultados disponibles, la respuesta incluye un next_page_cursor en el objeto pagination. Pásalo como parámetro de consulta page_cursor para recuperar la página siguiente. Los cursores de página caducan después de 24 horas. Una solicitud posterior de página no cuenta como una nueva consulta para tu límite de solicitudes.

​
Almacenamiento en caché

Las respuestas incluyen un encabezado ETag. Para evitar transferencias de datos redundantes, incluye el encabezado If-None-Match con el valor ETag anterior; el servidor devolverá 304 Not Modified si los datos no han cambiado.

​
Límites de velocidad

Este endpoint está sujeto a un límite de 10 solicitudes por hora por equipo. Si supera este límite, el servidor devuelve 429 Too Many Requests con un encabezado Retry-After. Paginar una consulta previa (siguiendo un next_page_cursor) no se contabiliza dentro de este límite: solo se contabiliza la consulta inicial de cada informe. El límite reducido refleja que este endpoint es para informes periódicos, no para el seguimiento del uso en tiempo real.

Autorizaciones

​
Authorization
string
header
requerido

Una clave de servicio con el permiso Analytics Read, pasada como token Bearer en el encabezado Authorization.

Crea una clave de servicio en tu configuración del equipo, en la sección "Service Keys".

Encabezados

​
If-None-Match
string

Valor de ETag de una respuesta anterior. Si los datos no han cambiado, el servidor devuelve 304 Not Modified.

Parámetros de consulta

​
start_date
string<date>
requerido

Inicio del rango de fechas (incluido) en formato YYYY-MM-DD.

​
end_date
string<date>
requerido

Fin del rango de fechas (incluido) en formato YYYY-MM-DD. El rango no debe superar los 90 días.

​
product
enum<string>
requerido

Producto cuyos usuarios activos se consultarán.

Opciones disponibles:
agent
​
granularity
enum<string>

Granularidad temporal para agrupar los resultados. Cuando se especifica, cada fila incluye un campo timestamp. Si se omite, el recuento de usuarios activos se agrega para todo el rango de fechas.

Opciones disponibles:
daily,
monthly
​
group_by
enum<string>

Dimensión por la que se agrupan los resultados. El endpoint de usuarios activos solo admite user, que devuelve una fila por cada usuario activo (cada una con active_users = 1).

Opciones disponibles:
user
​
models
string

Lista separada por comas de UID de modelos para filtrar los resultados.

​
group_id
string

Filtra los resultados para incluir solo usuarios de un grupo específico. La clave de servicio debe tener acceso a este grupo.

​
user_id
string

Filtra los resultados para un usuario específico (UID de autenticación).

​
page_size
integer
predeterminado:1000

Número máximo de filas que se devuelven por página.

Rango requerido: 1 <= x <= 10000
​
page_cursor
string

Cursor opaco de pagination.next_page_cursor de una respuesta anterior para obtener la página siguiente.

Respuesta

Los datos de usuarios activos se devolvieron correctamente.

​
data
object[]
requerido

Array de filas de datos de usuarios activos.

​
pagination
object
requerido
​
metadata
object
requerido