Overview

Usage API (1.0.0)

SheepCRM usage metrics API. Query client record counts and storage usage.

Authentication

All endpoints require authentication via session cookie from the web interface, or an API key in the X-API-Key header for programmatic access.

Quick Start

1. List clients: GET /api/v1/clients
2. Get client detail: GET /api/v1/clients/{bucket_id}
3. View history: GET /api/v1/clients/{bucket_id}/history
4. Daily snapshots: GET /api/v1/snapshots/{date}

Rate Limits

• Manual collection trigger: 1 request per 5 minutes per bucket

• SheepCRM Engineering: support@sheepcrm.com
• OpenAPI version: 3.1.0

Authentication

cookieAuth

Session cookie from web login

Security scheme type: apiKey

Cookie parameter name: session

apiKey

Admin API key for programmatic access

Security scheme type: apiKey

Header parameter name: X-API-Key