API Reference

QRY provides a comprehensive REST API for programmatic access to all platform features.

Authentication

All API endpoints require authentication via Bearer token:

Authorization: Bearer <your-api-token>

Obtain your API token from Settings > API Keys in the QRY application.

Base URL

https://your-qry-instance.com/api

Available APIs

Dashboards API

Create and manage dashboards, tiles, and sharing programmatically.

• Dashboard CRUD operations
• Tile management
• Query execution
• Public sharing
• Snapshot caching

Response Format

All API responses use JSON format:

{
  "id": "uuid",
  "data": { ... },
  "created_at": "2025-01-15T10:00:00Z"
}

Error Handling

Error Response Format

{
  "detail": "Error message description"
}

Common Status Codes

Code	Description
200	Success
201	Created
204	No Content (successful deletion)
400	Bad Request - Invalid parameters
401	Unauthorized - Invalid or missing token
403	Forbidden - Insufficient permissions
404	Not Found
500	Internal Server Error

Rate Limiting

API requests are subject to rate limiting. Current limits:

• Standard: 100 requests/minute
• Burst: 200 requests/minute (short bursts allowed)

Rate limit headers are included in responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1705312800

Pagination

List endpoints support pagination:

GET /api/dashboards/?limit=50&offset=0

Parameter	Type	Default	Description
limit	integer	50	Max results (1-100)
offset	integer	0	Number of items to skip