API Reference
The ItsFriday API is a REST API that allows you to programmatically send and query observability data.Base URL
Authentication
All API requests require authentication using a Bearer token:Request Format
- All requests use JSON format
- Set
Content-Type: application/jsonheader for POST/PUT requests - Timestamps should be ISO 8601 format:
2024-01-15T10:30:00Z
Response Format
All responses return JSON with a consistent structure:Success Response
Error Response
HTTP Status Codes
| Status | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid or missing token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found |
| 429 | Too Many Requests - Rate limited |
| 500 | Internal Server Error |
Rate Limiting
API requests are rate limited per API key:| Plan | Requests/minute |
|---|---|
| Free | 60 |
| Pro | 600 |
| Enterprise | Custom |
Pagination
List endpoints support pagination:Endpoints Overview
Metrics
Send and query time-series metrics
Logs
Send and search structured logs
Traces
Send and query distributed traces
Health
Health check endpoints
SDKs
Official SDKs are available for:- Python:
pip install itsfriday - JavaScript:
npm install @itsfriday/sdk - Go:
go get github.com/itsfriday-in/sdk-go
Interactive API Docs
Explore the API interactively:- Swagger UI: /api/v1/docs
- OpenAPI Spec: /api/v1/openapi.json