Obtener el resumen del uso de la organización

Obtenga el consumo de créditos, el número de nuevas sesiones y el total de preguntas de los usuarios de la organización por intervalo de tiempo, y despliegue paginadamente por Agente / Flujo de trabajo. Una sola llamada puede obtener los datos de todos los Agentes de la organización, no es necesario llamar a cada Agente individualmente.

Nota: se puede consultar un máximo de 31 días de datos; solo se cuenta el espacio de desarrollo, el alcance de la estadística se detalla en "Criterios de estadística" a continuación.

Método de solicitud

GET

Dirección de llamada

https://api-${endpoint}.gptbots.ai/v1/org/stat/summary

Autenticación de la llamada

Utilice la autenticación básica 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_id y tener el permiso "Ver uso" (los propietarios y administradores de la organización lo tienen por defecto).
• Por favor, llame a la dirección del centro de datos donde se encuentra la organización, ${endpoint} se obtiene de region devuelto por Consultar lista de organizaciones (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 interfaz hasta 60 veces por minuto.
• Cada llamada también cuenta para el cupo por minuto de "API de estadísticas" del plan de la organización, compartido con llamadas de interfaz de estadísticas de clave de agente (Agent API Key).
• Los resultados de consultas que incluyan hoy o ayer se almacenan en caché durante 5 minutos, los resultados de fechas anteriores se almacenan en caché durante 1 hora. Se recomienda llamar cada 5 a 15 minutos.

Solicitud

Ejemplo de solicitud

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/summary?org_id=${org_id}&start_time=1792425600000&end_time=1795017600000&page=1&page_size=20' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

                    

Encabezado de la solicitud

Parámetros de la solicitud

Respuesta

Ejemplo de respuesta

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "org_id": "65f0c2a1b4e8d93a1c7e5b20",
        "timezone": "+07:00",
        "range_start_date": "2026-10-16",
        "range_end_date": "2026-11-14",
        "data_since": "2026-10-15",
        "data_until": 1794614400000,
        "total": {
            "credits": 1234.5678,
            "unattributed_credits": 36.2011,
            "conversation_count": 5210,
            "message_count": 48213
        },
        "agents": {
            "page": 1,
            "page_size": 20,
            "total": 86,
            "list": [
                {
                    "agent_id": "65f0c2a1b4e8d93a1c7e5b21",
                    "name": "客服助手",
                    "agent_type": "AGENT",
                    "credits": 402.1200,
                    "conversation_count": 2104,
                    "message_count": 19820
                },
                {
                    "agent_id": "65f0c2a1b4e8d93a1c7e5b2a",
                    "name": "订单查询",
                    "agent_type": "WORKFLOW",
                    "credits": 130.5000,
                    "conversation_count": null,
                    "message_count": null
                }
            ]
        }
    }
}

                    

Respuesta exitosa

Respuesta fallida

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 a 401, 403132 a 403.

Criterios de estadísticas

• Alcance de las estadísticas: solo se contabiliza el espacio de desarrollo, incluyendo API, página de compartición, incrustación web, componente de burbuja, LiveDesk y todos los canales de mensajería instantánea y telefónica, así como los flujos de trabajo (Workflow) del espacio de desarrollo; no se incluye el uso del espacio de trabajo (GWork), ni la parte de los Agents publicados que se utilizan dentro del espacio de trabajo.
• Créditos: todos los tipos de consumo (excluyendo la expiración de créditos y el pago de suscripciones). El consumo de Workflow se registra a nombre del propio Workflow; el consumo generado por un Agent al llamar un Workflow no se cuenta para ese Agent. Los datos de créditos están disponibles desde la fecha de lanzamiento de la función (data_since) y no se rellenan con datos históricos.
• Número de sesiones: sesiones creadas dentro del período y que ya hayan tenido al menos un diálogo, excluyendo la previsualización de depuración del espacio de desarrollo. La ejecución de Workflow no genera sesiones; la búsqueda de AI en el espacio de trabajo no se cuenta. Los datos de sesiones y preguntas están disponibles desde 31 días antes del lanzamiento de la función.
• Número de preguntas: cantidad de mensajes de preguntas enviados por los usuarios dentro del período, excluyendo las respuestas de AI.
• Ordenamiento: agents.list se ordena por créditos de mayor a menor; en caso de empate, se ordena por número de sesiones. Los Agents que no tengan créditos, sesiones o preguntas dentro del período no se listan.
• Frecuencia de actualización: los créditos se actualizan en tiempo real; el número de sesiones y preguntas se contabiliza cada hora en punto, con un retraso aproximado de 1 hora.