IOionworks
Lab

Get a project's channel-hours by state per calendar period

Changed on

Return channel-hours by state for each calendar period from start to now.

Each point splits the period's channel-hours into occupied, stale, free, and out of service, with the Lab wall's precedence, so it describes the whole period rather than one instant. The last point is the period in progress, computed up to now and flagged partial. At most 400 points.

get/projects/{project_id}/lab/utilization-history

Request

  • Base URL
    https://api.ionworks.com
  • URL
    https://api.ionworks.com/projects/{project_id}/lab/utilization-history
  • Auth
    none declared

Path parameters

project_idstring uuid required

Query parameters

startstring 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'day' | 'week' | 'month' | 'quarter' | 'year'

The calendar period each history point covers, in UTC.

Calendar period each point covers, in UTC

Response

Successful Response

project_idstring required

Project the history covers

granularity'day' | 'week' | 'month' | 'quarter' | 'year' required

The calendar period each history point covers, in UTC.

startstring 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

trimmed_to_first_channelboolean

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

generated_atstring date-time required

When the history was computed

Changes