Obtener el RPM máximo de un Agente
Obtener el RPM máximo (solicitudes por minuto) de un agente en un rango de tiempo determinado, y al mismo tiempo devolver el momento en que ocurre el pico, el RPM promedio y el número total de solicitudes.
Nota: Se puede consultar datos de un máximo de 31 días; solo se contabilizan los canales del espacio de desarrollo, el alcance de la estadística se detalla más abajo en "Criterios de estadística".
Método de solicitud
GET
URL de llamada
https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/rpm
Autenticación de la llamada
Use Basic Auth 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 realiza la llamada debe ser miembro de la organización correspondiente a
org_idy tener permiso de "Ver uso" (los Owner y administradores de la organización lo tienen por defecto), además debe poder ver este agente: creador del agente, Owner de la organización, o miembros a los que se les haya otorgado acceso a este agente (o a todos los agentes). - Llame a la dirección del centro de datos donde se encuentra la organización,
${endpoint}se obtiene de Consultar lista de organizaciones que devuelveregion(SG→sg,TH→th,JP→jp). Si se llama a otro centro de datos, se devolverá "No es miembro de esta organización".
Frecuencia de llamadas
- Cada clave de desarrollador puede llamar esta API un máximo de 60 veces por minuto.
- Cada llamada se contabiliza en el límite por minuto del plan de la organización de "API de estadísticas", compartiendo el límite con las llamadas de clave de API del agente a interfaces de estadísticas.
- Los datos se actualizan cada hora, 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/agent/stat/rpm?org_id=${org_id}&agent_id=${agent_id}&start_time=1788192000000&end_time=1788796800000' \
-H 'Authorization: Basic ${BASIC_TOKEN}'
Encabezado de la solicitud
| Campo | Tipo | Descripción |
|---|---|---|
| Authorization | Basic ${BASIC_TOKEN} | Usar el Basic Token en Base64 de DevKey:DevSecret. |
Parámetros de la solicitud
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| org_id | String | Sí | ID de la organización. |
| agent_id | String | Sí | ID del agente. No se admite Workflow. |
| start_time | Long | Sí | Hora de inicio, timestamp en milisegundos. Redondeado hacia abajo a la hora completa. |
| end_time | Long | Sí | Hora de finalización (excluyendo), timestamp en milisegundos. Redondeado hacia arriba a la hora completa. El período alineado no puede exceder los 31 días. |
| conversation_type | String | No | Solo ver un canal específico, como API, SHARE, EMBED, WIDGET, LIVEDESK. Solo puede ser un canal del espacio de desarrollo; si no se proporciona, se contarán todos los canales del espacio de desarrollo. |
Respuesta
Ejemplo de respuesta
{
"code": 0,
"message": "OK",
"data": {
"agent_id": "65f0c2a1b4e8d93a1c7e5b21",
"range_start": 1788192000000,
"range_end": 1788796800000,
"data_until": 1788793200000,
"peak_rpm": 42,
"peak_at": 1788512460000,
"avg_rpm": 3.18,
"total_requests": 18234
}
}
Respuesta exitosa
| Campo | Tipo | Descripción |
|---|---|---|
| agent_id | String | ID del agente. |
| range_start | Long | Inicio del intervalo estadístico real: start_time alineado hacia abajo al punto entero en milisegundos. |
| range_end | Long | Fin del intervalo estadístico real (excluido): end_time alineado hacia arriba al punto entero 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. |
| peak_rpm | Long | RPM pico: la suma de las solicitudes de todos los canales en el mismo minuto; el minuto dentro del intervalo con el mayor número de solicitudes. |
| peak_at | Long | Inicio del minuto del pico (marca de tiempo en milisegundos). Si hay varios minutos empatados, se toma el más temprano; si no hay solicitudes en el intervalo, es null. |
| avg_rpm | Number | RPM promedio: total de solicitudes ÷ número de minutos con solicitudes, conservando 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 | Detalles del error. |
Códigos de error
El código de estado HTTP corresponde a los primeros tres 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 la falta de un parámetro obligatorio o valor de parámetro no válido. |
| 40001 | Llamadas demasiado frecuentes: la clave de desarrollador excede el límite por minuto de esta interfaz. |
| 40008 | Exceso del límite por minuto del paquete de "API de estadísticas" de la organización. |
| 40010 | Interfaz temporalmente cerrada, por favor intente más tarde. |
| 40100 | Sin permiso: falta el permiso para ver el uso, o no tiene derecho a ver este Agent (incluido que el Agent no pertenece a esta organización). |
| 40105 | No es miembro de esta organización, o se llamó a la dirección de otro centro de datos. |
| 40324 | DevKey o DevSecret incorrecto. |
| 40378 | Agent eliminado. |
| 403132 | Rango de tiempo no válido: la hora de inicio no es anterior a la hora de finalización, o supera el rango máximo de consulta. |
Criterio de estadísticas
- Solicitudes: mensajes de preguntas enviados por el usuario, además de errores de conversación (incluidas las solicitudes rechazadas por exceder la frecuencia de llamadas), consistente con «Agent Insights → Solicitudes por minuto» en la consola. No es el número de solicitudes HTTP y puede diferir de los conteos de límite de paquete.
- Alcance estadístico: solo incluye los canales del espacio de desarrollo, incluyendo API, página compartida, incrustación en web, componente burbuja, LiveDesk y todos los canales de mensajería instantánea y telefónica; no incluye la vista previa de depuración, ejecución de Workflow dentro del espacio de desarrollo, ni el uso del Agent publicado en el espacio de trabajo después de la publicación.
- Frecuencia de actualización: los datos se recopilan cada hora en punto, con un retraso aproximado de 1 hora, tomando
data_untilcomo referencia. Los datos anteriores al 2026-03-09 no tienen detalles a nivel de minutos; los resultados de consulta son 0.
