Obtener la distribución del uso de créditos de la organización

Obtenga la proporción de créditos o tokens de la organización por Agente / Flujo de trabajo, así como la tendencia diaria, semanal y mensual. Puede ver solo por Agente o solo por Flujo de trabajo.

Nota: se pueden consultar datos de hasta 92 días; solo se contabilizan los espacios de desarrollo, el alcance estadístico se detalla en la sección «Criterios de estadística» más abajo.

Método de solicitud

GET

Dirección de la API

https://api-${endpoint}.gptbots.ai/v1/org/usage/distribution

Autenticación de la solicitud

Utilice 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 realiza la solicitud debe ser miembro de la organización correspondiente a org_id y tener el permiso «Ver uso» (el propietario y el administrador de la organización tienen este permiso por defecto).
• Por favor, llame a la dirección del centro de datos donde se encuentra la organización, con ${endpoint} tomado de region devuelto por Consultar la 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 API hasta 10 veces por minuto.
• Cada llamada cuenta al mismo tiempo para el límite por minuto de la categoría de API «Estadísticas» del plan de la organización, compartido con el uso de la clave de agente en las interfaces de estadística.
• Los resultados de la consulta se almacenan en caché durante 10 minutos, se recomienda realizar la llamada una vez al día.

Solicitud

Ejemplo de solicitud

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/usage/distribution?org_id=${org_id}&start_time=1792425600000&end_time=1792684800000&agent_type=WORKFLOW&granularity=DAY' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

                    

Encabezado de solicitud

Parámetros de solicitud

Respuesta

Ejemplo de respuesta

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "timezone": "+07:00",
        "data_since": "2026-10-15",
        "buckets": ["2026-10-16", "2026-10-17", "2026-10-18"],
        "total": 812.4411,
        "series": [
            {
                "row_type": "ITEM",
                "agent_id": "65f0c2a1b4e8d93a1c7e5b2a",
                "name": "订单查询",
                "agent_type": "WORKFLOW",
                "total": 402.1200,
                "share": 49.49,
                "points": [130.5000, 141.0200, 130.6000]
            },
            {
                "row_type": "OTHER",
                "agent_id": null,
                "name": null,
                "agent_type": null,
                "total": 410.3211,
                "share": 50.51,
                "points": [120.1000, 150.2000, 140.0211]
            }
        ],
        "ranking": [
            {
                "row_type": "ITEM",
                "agent_id": "65f0c2a1b4e8d93a1c7e5b2a",
                "name": "订单查询",
                "agent_type": "WORKFLOW",
                "total": 402.1200,
                "share": 49.49
            }
        ]
    }
}

                    

Respuesta exitosa

Respuesta de error

Códigos de error

Los tres primeros dígitos del código de error HTTP corresponden al código de estado, por ejemplo, 40000 corresponde a 400, 40100 corresponde a 401, 403132 corresponde a 403.

Alcance estadístico

• Alcance de la estadística: Solo se cuentan los espacios de desarrollo, incluidos API, páginas para compartir, incrustaciones web, componentes de burbuja, LiveDesk y todos los canales de mensajería instantánea y llamadas, así como los Workflows del espacio de desarrollo; no se incluye el uso del espacio de trabajo (GWork), ni tampoco la parte de los Agents ya publicados que se utilizan en el espacio de trabajo. Por lo tanto, el total puede ser ligeramente inferior al mismo período en la página "Organización → Uso" de la consola.
• Créditos: Todos los tipos de consumo (excepto expiración de créditos y pagos de suscripción); el consumo de Workflow se registra bajo el propio Workflow.
• Inicio de los datos: Disponible a partir del día de lanzamiento de la función (data_since), sin retroalimentación histórica.
• Frecuencia de actualización: Actualización en tiempo real.