Skip to main content
GET
Get usage
Reading it costs nothing. Without parameters it returns the current UTC month so far, split by day and engine. Add groupBy=key to see which API key spent the credits. What each field means is on Credits and limits.

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <key>.

Query Parameters

from
string<date>

First UTC date, inclusive. Default: the first day of the current UTC month.

to
string<date>

Last UTC date, inclusive. Default: today (UTC). The range spans at most 366 days, from and to included.

groupBy
string
default:day,engine

How to split the rows: a comma-separated choice of day, engine and key. Default: day,engine.

Examples:

"engine"

"day,key"

Response

Credit and task totals for the range, and one row per combination of the chosen splits that had a charge.

success
boolean
required
data
object
required