Skip to main content

API Reference

The ItsFriday API is a REST API that allows you to programmatically send and query observability data.

Base URL

https://api.itsfriday.in/v1
For self-hosted installations:
https://your-domain.com/api/v1

Authentication

All API requests require authentication using a Bearer token:
curl https://api.itsfriday.in/v1/metrics/ \
  -H "Authorization: Bearer YOUR_API_KEY"
See Authentication for details on obtaining API keys.

Request Format

  • All requests use JSON format
  • Set Content-Type: application/json header 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

{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123"
  }
}

Error Response

{
  "error": {
    "code": "validation_error",
    "message": "Invalid metric name",
    "details": {
      "field": "name",
      "reason": "Must be lowercase alphanumeric"
    }
  },
  "meta": {
    "request_id": "req_abc123"
  }
}

HTTP Status Codes

StatusDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing token
403Forbidden - Insufficient permissions
404Not Found
429Too Many Requests - Rate limited
500Internal Server Error

Rate Limiting

API requests are rate limited per API key:
PlanRequests/minute
Free60
Pro600
EnterpriseCustom
Rate limit headers are included in responses:
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 55
X-RateLimit-Reset: 1640000000

Pagination

List endpoints support pagination:
curl "https://api.itsfriday.in/v1/logs/?limit=50&offset=100"
Response includes pagination info:
{
  "data": [...],
  "meta": {
    "total": 1000,
    "limit": 50,
    "offset": 100
  }
}

Endpoints Overview

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: