Usage API

Check your current usage, remaining quota, and performance analytics.

GET/v1/usage

Response

{
  "plan": "growth",
  "period": {
    "start": "2026-03-10T00:00:00.000Z",
    "end": "2026-04-09T23:59:59.999Z"
  },
  "usage": {
    "requests": 12847,
    "limit": 25000,
    "remaining": 12153,
    "percentage": 51.4
  },
  "breakdown": {
    "screenshot": 9234,
    "og_image": 2891,
    "html_to_image": 722
  },
  "cache_hit_rate": 34.2,
  "avg_response_time_ms": 1180
}

Response fields

Parameter	Type	Default	Description
`plan`	string	—	Your current plan: free, starter, growth, business, or enterprise.
`period.start`	string	—	Billing period start (ISO 8601). Anniversary-based — resets on the same day each month you signed up.
`period.end`	string	—	Billing period end.
`usage.requests`	number	—	Total requests made this period.
`usage.limit`	number	—	Monthly request limit for your plan. -1 for unlimited (Enterprise).
`usage.remaining`	number	—	Requests remaining this period.
`usage.percentage`	number	—	Percentage of quota used (0–100).
`breakdown`	object	—	Request counts by endpoint type.
`cache_hit_rate`	number	—	Percentage of requests served from Redis cache.
`avg_response_time_ms`	number	—	Average response time in milliseconds for this period.

Billing periods

SnapSharp uses anniversary-based billing — your usage resets on the same day each month that you created your account.

If you signed up on March 15, your billing period runs March 15 → April 14, then April 15 → May 14, and so on.

Dashboard analytics

The Usage dashboard provides additional visualization:

Daily usage chart — requests per day broken down by endpoint
Response time chart — p50, p95, p99 latency over time
Cache breakdown — hits vs misses ratio
Top URLs — most frequently screenshotted URLs
CSV export — download raw usage data as a CSV file

Set up webhooks to get notified when your usage hits 80% or 100% of your monthly limit.