Usage

Get usage and balance

Shows whether tracking is stopped or the balance is low. Also returns the prepaid balance (ledger total, pending mention charges, and the effective balance that decides pausing), daily spend and days left, running and paused keywords, and matches today and over 30 days. Pricing is $0.008 per matched mention, relevant or not, and $5 a month per active keyword, charged daily.

get/v1/usage

Request

  • Base URL: https://api.rumoro.dev
  • URL: https://api.rumoro.dev/v1/usage
  • Auth: HTTP bearer

Response

A summary of usage

stoppedboolean required

True when tracking is paused because the balance ran out. It resumes after a top-up that covers one day of every keyword.

lowBalanceboolean required

true when 20 percent or less of the last credit remains (effective balance) and tracking is on.

lastTopUpAtstring nullable required

Latest paid top-up time, or null if there is none.

Changes

No recorded changes to this operation across all 1 revision of this API.