Usage

GET/api/v1/usage

Answers 'why am I not receiving anything?' in one call: the plan, the keyword limit, and for today (UTC) how many alerts each keyword delivered and how many were held back by the daily cap.

Request

This endpoint does not require any path, query, or body parameters.

Response

Returns a JSON object with a data field containing the result.

Response fields

data.planstring

starter, pro or scale.

data.statusstring

active or canceled.

data.keyword_limitnumber

Active keywords allowed by the plan.

data.keywords_usednumber

Active keywords right now.

data.per_keyword_daily_capnumber

Deliveries per keyword per UTC day.

data.history_daysnumber

How far back List alerts reaches.

data.rate_limit_per_minutenumber

Read requests per minute per key.

data.delivered_todaynumber

Sum over keywords.

data.capped_todaynumber

Matches held back today.

data.today[]array

{ keyword_id, text, active, delivered, capped, cap_reached } per keyword, busiest first.

curl -H "Authorization: Bearer rsp_your_key" \
https://redship.io/api/v1/usage

Success response200

{
"data": {
  "plan": "pro",
  "status": "active",
  "keyword_limit": 100,
  "keywords_used": 37,
  "per_keyword_daily_cap": 100,
  "history_days": 90,
  "rate_limit_per_minute": 60,
  "day": "2026-08-26",
  "delivered_today": 812,
  "capped_today": 41,
  "today": [
    { "keyword_id": "5b2c…", "text": "notion alternative", "active": true, "delivered": 100, "capped": 41, "cap_reached": true },
    { "keyword_id": "9e0d…", "text": "stripe webhook", "active": true, "delivered": 12, "capped": 0, "cap_reached": false }
  ]
}
}