Get usage grouped by endpoint

GET

/api/v1/usage/by-endpoint

• Local development
• Production

Returns request counts and average response times grouped by endpoint.

Authorizations

• ApiKeyHeader

Parameters

Query Parameters

days

integer

default: 30 >= 1 <= 90

Number of days to aggregate

Responses

200

Usage by endpoint

object

data

object

endpoints

Array<object>

object

endpoint

string

method

string

requests

integer

avgResponseMs

number

nullable

meta

object

requestId

string format: uuid

generatedAt

string format: date-time

apiVersion

string

Allowed values: v1

cacheHit

boolean

401

Authentication required

RFC 7807 Problem Details

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string

retryAfter

Seconds to wait before retrying (present on 429 responses)

integer

Example

{
  "type": "https://api.studyplug.org/errors/unauthorized",
  "title": "API Key Required",
  "status": 401,
  "detail": "Provide a valid API key via the X-StudyPlug-Key header."
}

429

Rate limit exceeded

RFC 7807 Problem Details

object

type

required

string format: uri

title

required

string

status

required

integer

detail

required

string

instance

string

retryAfter

Seconds to wait before retrying (present on 429 responses)

integer

Example

{
  "type": "https://api.studyplug.org/errors/rate-limited",
  "title": "Rate Limit Exceeded",
  "status": 429,
  "detail": "You have exceeded 20 requests per minute. Please wait before retrying.",
  "instance": "/api/v1/skills",
  "retryAfter": 12
}

Headers

Retry-After

integer

Seconds until rate limit resets

X-RateLimit-Limit

integer

Max requests per window

X-RateLimit-Remaining

integer

Allowed values: 0

Always 0 when rate limited