API Status — guildGetAPIStatus | Bifrost Developer Center

POSThttps://api.dev.bifrostgaming.com/v1/graphql

guildGetAPIStatus

Returns API usage statistics, error rates, and per-operation breakdowns for your guild. Data covers a rolling 4-hour window.

Operation Type

Query

Rate Limit: 1 request per 5 minutes per guild

If rate limited, the response includes success: false with retry delay in the error field.

Code Examples

curl -X POST https://api.dev.bifrostgaming.com/v1/graphql \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "{ guildGetAPIStatus { success totalRequests totalErrors overallErrorRate avgDurationMs dataWindowHours operationStats { operationName operationType requestCount errorCount errorRate avgDurationMs maxDurationMs lastRequestTime } recentErrors { requestTime operationName errorCode errorMessage durationMs } hourlyUsage { hour requestCount errorCount } error timestamp } }"
  }'

Postman Collection

Download a ready-to-use Postman collection for this endpoint. Import it into Postman to start testing immediately.

How to import into Postman

Open Postman and click Import (top-left)
Drag and drop the downloaded .json file, or click Upload Files and select it
Click Import to confirm
The collection appears in your sidebar — expand it and select the request
In the Body tab, update the placeholder values (your-partner-id, etc.) with your actual credentials
Click Send

The collection uses Postman's GraphQL body type, which provides syntax highlighting and variable editing. Make sure your Postman version is 7.2+ for GraphQL support.

Success Response200

{
  "data": {
    "guildGetApiStatus": {
      "status": "operational",
      "uptime": "99.97%",
      "version": "1.0.0",
      "servers": [
        {
          "serverId": "server-abc-123",
          "serverName": "My Community Server #1",
          "status": "online",
          "lastPing": "2025-01-15T12:34:50Z"
        }
      ],
      "timestamp": "2025-01-15T12:34:56.789Z"
    }
  }
}

Error Responses

Response Fields

Field	Type	Required	Description
`totalRequests`	Int	Optional	Total API requests within the data window
`totalErrors`	Int	Optional	Total requests that returned errors
`overallErrorRate`	Float	Optional	Error rate as a percentage (e.g., 2.5 = 2.5%)
`avgDurationMs`	Float	Optional	Weighted average response time in milliseconds
`dataWindowHours`	Float	Optional	How many hours of data is available (4-hour TTL)
`operationStats`	Array	Optional	Per-operation breakdown with requestCount, errorCount, errorRate, avgDurationMs, maxDurationMs, lastRequestTime
`recentErrors`	Array	Optional	Last 25 error responses with requestTime, operationName, errorCode, errorMessage, durationMs
`hourlyUsage`	Array	Optional	Hourly request and error counts for trend analysis

A Shrapnelworks product