Skip to main content
GET
List Metrics History

Authorizations

Authorization
string
header
required

Clerk Machine API Key for authentication

Path Parameters

workspace_id
string
required
farm_id
string
required

Query Parameters

page
number

Page number (default: 1)

Required range: x >= 1
Example:

1

pageSize
number

Number of items per page (default: 10, max: 10000)

Required range: 1 <= x <= 10000
Example:

10

from_date
string<date>
required

Date in YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2025-09-07"

to_date
string<date>
required

Date in YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2025-09-07"

granularity
enum<string>
default:day

Time resolution of the returned metrics.

  • day (default): full daily metric set (pool / agent hashrate, online miners, BTC earnings, electricity).
  • hour / 10min: hashrate-only subset (period, pool hashrate, online / offline miner counts) aggregated from raw 10-minute samples. Sub-day query windows are bounded: 10min up to 7 days, hour up to 60 days. day is unbounded.
Available options:
day,
hour,
10min
Example:

"day"

Response

Successfully retrieved farm metric history

success
boolean
required

Indicates if the request was successful

Example:

true

data
(Farm Metric History · object | Farm Sub-Day Metric History · object)[]
required

Array of items

pagination
object
required

Pagination metadata

error
null
required

Error object (null on success)

Example:

null