Skip to main content
Get a project's channel-hours by state per calendar period

Path Parameters

project_id
string<uuid>
required

Query Parameters

start
string<date-time>
required

Start of the range, ISO 8601 (a date is read as UTC midnight). Snapped back to its period's boundary; at most 3660 days ago.

granularity
enum<string>
default:month

Calendar period each point covers, in UTC

Available options:
day,
week,
month,
quarter,
year

Response

Successful Response

Utilization per calendar period, oldest first, ending with the current one.

project_id
string
required

Project the history covers

granularity
enum<string>
required

Calendar period each point covers

Available options:
day,
week,
month,
quarter,
year
start
string<date-time>
required

Start of the first point: the requested start snapped back to its period's boundary, or later if no channel existed yet

generated_at
string<date-time>
required

When the history was computed

trimmed_to_first_channel
boolean
default:false

Whether periods before the project's first channel were dropped, so the series starts later than requested

points
UtilizationHistoryPoint · object[]

One point per period, oldest first