Changelog is temporarily disabled for maintenance
API Reference

Returns forecast summary information

get
https://api.hcssapps.com/heavyjob/api/v1/forecastInfo

This call returns a paginated list of forecast summary information for the specified job, date range or finalized since date.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
uuid

The job guid. If omitted, returns forecasts across all jobs.

date-time

The start date in yyyy-MM-dd format. If omitted, returns forecasts from the beginning of time. (bounded by the end date).

date-time

The end date in yyyy-MM-dd format. If omitted, returns forecasts until the end of time. (bounded by the start date).

date-time

The forecast finalized datetime in utc format (e.g., 2018-06-26T08:25:48Z). If omitted, returns all forecasts between start and end date.

int32
Defaults to 1000

The maximum number of results that should be returned.

string

Optional. When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.

Responses

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

Updated 2 months ago

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 months ago