Get Agent Peak RPM

Retrieve the peak RPM (requests per minute) of a specific Agent over a time period, while also returning the time when the peak occurred, the average RPM, and the total number of requests.

Note: You can query up to 31 days of data; statistics only cover developer space channels. For the scope of statistics, see "Statistical Caliber" below.

Request Method

GET

Endpoint

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

Authentication

Use account-level DevKey / DevSecret for Basic authentication: Authorization: Basic ${BASIC_TOKEN}, where ${BASIC_TOKEN} is the Base64 encoding of DevKey:DevSecret.

• The calling account must be a member of the organization corresponding to org_id and have "View Usage" permission (organization Owners and administrators have this by default) and must be able to view this Agent: the Agent creator, organization Owner, or a member granted permission for this Agent (or all Agents).
• Please call the endpoint of the data center where the organization is located. ${endpoint} is obtained from the region returned by Query Organization List (SG → sg, TH → th, JP → jp). Calling a different data center will return "Not a member of this organization."

Call Frequency

• Each developer key can call this API up to 60 times per minute.
• Each call counts toward the organization's package "Statistical API" per-minute quota, shared with Agent API Key calls for statistical interfaces.
• Data is updated hourly; repeated queries within the same hour return the same result, so it is recommended to call the API once per hour.

Request

Example Request

                      
                      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}'

                    

Request Header

Request Parameters

Response

Response Example

                      
                      {
    "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
    }
}

                    

Successful Response

Failed Response

Error Codes

HTTP status code corresponds to the first three digits of the error code. For example, 40000 corresponds to 400, 40100 corresponds to 401, 403132 corresponds to 403.

Statistical Scope

• Requests: User-submitted question messages, plus dialogue errors (including requests rejected due to exceeding call frequency), consistent with "Agent Insights → Requests per Minute" in the console. It is not the number of HTTP requests, and may differ from the counting in package rate limits.
• Statistical Range: Only counts channels in the development space, including API, shared pages, web embedding, bubble components, LiveDesk, and various instant messaging and phone channels; does not include debugging previews in the development space, Workflow executions, or usage of the Agent in a workspace after deployment in that workspace.
• Update Frequency: Data is collected on the hour every hour, with about a 1-hour delay, based on data_until. Data before 2026-03-09 has no minute-level details, and query results are 0.