Retrieve a forecast

GET

/v1/forecast/{id}/

const url = 'https://example.com/v1/forecast/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/forecast/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
  --header 'Authorization: Bearer <token>'

Return a single forecast by its ID.

Authorizations

jwtAuth
basicAuth

Parameters

Path Parameters

required

string format: uuid

A UUID string identifying this forecast.

Responses

200

application/json

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object

account

required

string format: uuid

configuration

required

string format: uuid

failed_at

string format: date-time

nullable

failure_reason

not_enough_points - Not enough points
invalid_response - Invalid response
error - Error

string

nullable

Allowed values: not_enough_points invalid_response error ""

required

string format: uuid

modified_at

required

string format: date-time

points_collected

integer

nullable >= -2147483648 <= 2147483647

points_expected

integer

nullable >= -2147483648 <= 2147483647

predicted_critical_threshold

Predicted critical threshold datetime

string format: date-time

nullable

predicted_shortage

Predicted shortage datetime

string format: date-time

nullable

predicted_warning_threshold

Predicted warning threshold datetime

string format: date-time

nullable

promql_query

required

string

ran_at

string format: date-time

nullable

threshold_critical

number format: double

nullable

threshold_shortage

number format: double

nullable

threshold_warning

number format: double

nullable

Example

{
  "failure_reason": "not_enough_points"
}