Obtener RPM máximo de la organización
Obtenga el RPM máximo (solicitudes por minuto) de la organización por intervalo de tiempo: primero, sume el número de solicitudes de todos los Agentes de la organización en el mismo minuto, luego tome el minuto más alto dentro del intervalo, y al mismo tiempo devuelva el momento en que ocurrió el pico, el RPM promedio y el total de solicitudes.
Nota: se puede consultar un máximo de 31 días de datos; solo se contabilizan los canales del espacio de desarrollo, el alcance del conteo se encuentra a continuación en «Criterios de conteo».
Método de solicitud
GET
URL de llamada
https://api-${endpoint}.gptbots.ai/v1/org/stat/rpm
Verificación de llamada
Use la autenticación Basic con DevKey / DevSecret a nivel de cuenta: Authorization: Basic ${BASIC_TOKEN}, donde ${BASIC_TOKEN} es la codificación Base64 de DevKey:DevSecret.
- La cuenta que llama debe ser miembro de la organización correspondiente a
org_idy tener el permiso de «Ver uso» (el Owner y los administradores de la organización lo tienen por defecto). - Por favor, llame a la URL del centro de datos donde se encuentra la organización, tomando
${endpoint}del resultado de Consultar lista de organizaciones comoregion(SG→sg,TH→th,JP→jp). Llamar a otro centro de datos devolverá «No es miembro de esta organización».
Frecuencia de llamadas
- Cada clave de desarrollador puede llamar a esta API un máximo de 60 veces por minuto.
- Cada llamada se contabiliza en el límite por minuto de la API de tipo estadístico del paquete de la organización, compartido con las llamadas de la interfaz tipo estadística de Agent API Key.
- Los datos se actualizan cada hora, y las consultas repetidas dentro de la misma hora devuelven el mismo resultado. Se recomienda llamar una vez por hora.
Solicitud
Ejemplo de solicitud
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/rpm?org_id=${org_id}&start_time=1788192000000&end_time=1788796800000' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
Encabezados de la solicitud
| Campo | Tipo | Descripción |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | Utiliza el token Basic después de DevKey:DevSecret en Base64. |
Parámetros de la solicitud
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| org_id | String | Sí | ID de la organización. |
| start_time | Long | Sí | Hora de inicio, marca de tiempo en milisegundos. Alineada hacia abajo a la hora completa más cercana. |
| end_time | Long | Sí | Hora de finalización (no incluida), marca de tiempo en milisegundos. Alineada hacia arriba a la hora completa más cercana. El intervalo alineado no debe superar los 31 días. |
Respuesta
Ejemplo de respuesta
{
"code": 0,
"message": "OK",
"data": {
"org_id": "65f0c2a1b4e8d93a1c7e5b20",
"range_start": 1788192000000,
"range_end": 1788796800000,
"data_until": 1788793200000,
"data_since": 1786125600000,
"peak_rpm": 186,
"peak_at": 1788512460000,
"avg_rpm": 12.40,
"total_requests": 2083411
}
}
Respuesta exitosa
| Campo | Tipo | Descripción |
|---|---|---|
| org_id | String | ID de la organización. |
| range_start | Long | Inicio del intervalo estadístico real: start_time alineado hacia abajo al entero de la hora como marca de tiempo en milisegundos. |
| range_end | Long | Fin del intervalo estadístico real (excluido): end_time alineado hacia arriba al entero de la hora como marca de tiempo en milisegundos. |
| data_until | Long | Momento hasta el cual se han contabilizado los datos (marca de tiempo en milisegundos). La parte del intervalo posterior a este momento aún no tiene datos. |
| data_since | Long | El primer punto de tiempo desde el cual la organización tiene datos de RPM (marca de tiempo en milisegundos, igual para todas las organizaciones en el mismo centro de datos, aproximadamente 31 días antes del lanzamiento de la función). La parte del intervalo anterior a este momento no tiene datos; si no hay datos, es null. |
| peak_rpm | Long | RPM máximo: la suma de solicitudes de todos los Agentes de la organización en un mismo minuto, siendo la mayor cantidad de solicitudes en un minuto dentro del intervalo. |
| peak_at | Long | Inicio del minuto en que ocurrió el pico (marca de tiempo en milisegundos). Si hay varios minutos con el mismo valor máximo, se toma el primero; si no hay solicitudes en el intervalo, es null. |
| avg_rpm | Number | RPM promedio: número total de solicitudes ÷ número de minutos con solicitudes, con 2 decimales. |
| total_requests | Long | Número total de solicitudes en el intervalo. |
Respuesta fallida
| Campo | Tipo | Descripción |
|---|---|---|
| code | Integer | Código de error. |
| message | String | Detalle del error. |
Códigos de error
El código de estado HTTP corresponde a los tres primeros dígitos del código de error, por ejemplo 40000 corresponde a 400, 40100 corresponde a 401, 403132 corresponde a 403.
| Código de error | Descripción |
|---|---|
| 40000 | Error de parámetro, como falta de parámetros obligatorios o valores de parámetros no válidos. |
| 40001 | Llamadas demasiado frecuentes: esta clave de desarrollador ha superado el límite por minuto de esta interfaz. |
| 40008 | Se ha superado la cuota por minuto del plan de organización para "APIs de estadísticas". |
| 40010 | La interfaz está temporalmente cerrada, por favor inténtelo más tarde. |
| 40100 | Sin permisos: falta el permiso para ver el uso. |
| 40105 | No es miembro de esta organización, o se ha llamado a la dirección de otro centro de datos. |
| 40324 | DevKey o DevSecret incorrectos. |
| 403132 | Rango de tiempo no válido: la hora de inicio no es anterior a la hora de finalización, o se supera el rango máximo de consulta. |
Criterios estadísticos
- Solicitudes: Mensajes de pregunta enviados por el usuario, incluyendo errores en el diálogo (incluidas las solicitudes rechazadas por exceder la frecuencia de llamadas), consistentes con "Agent Insights → Solicitudes por minuto" en la consola. No se refiere al número de solicitudes HTTP, y el conteo puede diferir del límite de paquete.
- Alcance estadístico: Solo se cuentan las solicitudes de Agent en el espacio de desarrollo a través de los canales de desarrollo, incluyendo API, páginas compartidas, incrustaciones web, componentes de burbuja, LiveDesk y varios canales de mensajería instantánea y telefónica; no incluye la vista previa de depuración en el espacio de desarrollo, Workflow (incluidas las llamadas a la API de Workflow rechazadas por exceso de frecuencia), búsquedas de AI en el espacio de trabajo, ni el uso de agentes publicados en el espacio de trabajo.
- Alcance de los datos: Los datos están disponibles desde 31 días antes del lanzamiento de la función; para períodos anteriores, se usa
data_since. - Frecuencia de actualización: Los datos se cuentan una vez cada hora en punto, con un retraso aproximado de 1 hora, según
data_until. - Diferencia con la página "Organización → Uso → RPM" de la consola: La consola muestra segmentos de 24 horas de un día; esta interfaz devuelve un solo valor máximo para todo el período y el momento en que ocurrió.
