Retrieve a forecast configuration

GET

/v1/forecastconfiguration/{id}/

const url = 'https://example.com/v1/forecastconfiguration/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/forecastconfiguration/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ \
  --header 'Authorization: Bearer <token>'

Return a single forecast configuration by its ID.

Authorizations

jwtAuth
basicAuth

Parameters

Path Parameters

required

string format: uuid

A UUID string identifying this forecast configuration.

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

agent

required

string format: uuid

created_at

required

string format: date-time

deactivated_at

string format: date-time

nullable

high_metric

required

string format: uuid

nullable

required

string format: uuid

low_metric

required

string format: uuid

nullable

metric

required

string format: uuid

model_name

required

string

modified_at

required

string format: date-time

tolerance_perc

required

number format: double

type

required

1 - Linear forecast
2 - Anomaly forecast

integer

Allowed values: 1 2

Example

{
  "type": 1
}