Retrieve a forecast's analysis

gethttps://api.faraday.ai/v1/forecasts/{forecast_id}/analysis
This endpoint is experimental and may change without notice.

How the forecast's current model performed on entries it did not train on, the level correction applied to delivered values, how the training labels were handled, and the readings taken on each refresh. Written by the forecast's refresh after a build finishes; until then the request returns 404.

Authentication

Bearer Authentication

Provide your API key in the Authorization header. You can find your API key in the Settings page of the dashboard.

Authorization: Bearer YOUR_TOKEN

path parameters

forecast_idstring<uuid>required

The UUID of a forecast

Responses

200The forecast's analysis

The level correction the latest refresh applies to delivered values. Absent when the refresh recorded none.

Properties of object

Entries younger than this many days have factor applied to their forecast value remaining; older entries are delivered as the model forecasts them.

Training entries the recent cohort is compared with.

The training population's mean value realized within the window.

factornumber

The multiplier applied to the forecast value remaining of entries younger than applies_below_age. 1 when no correction could be trusted.

Example: 1.04
methodstring

How the factor is read; drift compares the newest observed cohort with what the model implied for it.

ran_atstring<date-time>

The refresh's data cutoff, the end of the last full day with data or the pinned observation date if earlier.

reasonstring

Why the factor is 1 or was held inside its band, when it was.

The recent cohort's entries are before this date.

First entry date of the recent cohort.

Entries in the recent cohort.

The recent cohort's mean value realized within the window.

refreshed_atstring<date-time>

When the refresh ran.

Days after entry the recent cohort is observed through.

The damped year-over-year ratio of the two early means, recorded for comparison and not applied.

driftobject

The drift reading of the latest refresh, on the newest cohort whose window is fully observed. Absent when the refresh recorded none.

Properties of object

Cohort entries that had already ended at the read age; they count at their realized value and the model is not read for them, as when they are scored.

rationumber

The cohort's realized value at the window age over what the model implied for it, minus one. Positive means the business runs above what the model learned.

read_ageinteger

Days after entry at which the model was read for the cohort. 1, the first age the scorer uses, when the generation trained at it; 0 for a generation that did not.

reasonstring

Why no ratio could be read, when none was.

The cohort's entries are before this date.

First entry date of the cohort.

Entries in the cohort.

Days after entry the cohort is observed through.

by_windowarray[object]

The same reading at shorter windows, each on its own newest cohort. They react sooner and overshoot, so they are recorded and not applied.

Items of array[object]

Cohort entries that had already ended at the read age; they count at their realized value and the model is not read for them, as when they are scored.

rationumber

The cohort's realized value at the window age over what the model implied for it, minus one. Positive means the business runs above what the model learned.

read_ageinteger

Days after entry at which the model was read for the cohort. 1, the first age the scorer uses, when the generation trained at it; 0 for a generation that did not.

reasonstring

Why no ratio could be read, when none was.

The cohort's entries are before this date.

First entry date of the cohort.

Entries in the cohort.

Days after entry the cohort is observed through.

dataobject

How far the streams' data reaches.

Properties of object
high_water_markstring<date-time>

The newest event on either stream.

lag_daysinteger

Days from the newest event to the refresh.

pinnedboolean

Whether the data cutoff is held by predictors.max_observation_date.

The share of its value the training population had realized by the window age.

What the cohort was expected to have realized by the window age.

The model's mean forecast for the cohort at the read age, realized value so far plus predicted remaining value; an entry already ended by then counts at its realized value.

ran_atstring<date-time>

The refresh's data cutoff.

What it did realize.

refreshed_atstring<date-time>

When the refresh ran.

The model build the analysis describes.

Properties of object

Entries whose horizon was still open at training.

balancenumber

Factor applied to the model's raw predictions so that they average to the training value.

Boosting rounds the model kept.

entriesinteger

Entries on the entry stream at training.

feature_columnsarray[string]

Identifiers of the model's inputs, named by family. age and realized_at_age are the row's position. prior_* and days_since_prior_entry are the person's history before the entry day (count, val...

finished_atstring<date-time>

When the build finished.

Entries every performance number is measured on.

Observations every performance number is measured on, each scored by a model that did not fit on its entry. With cross-validation (see performance.validation) that is every training observation.

Entries whose horizon had ended at training.

trained_as_ofstring<date-time>

The data cutoff the model was trained with.

Entries the model fit on.

Observations the model fit on. An entry observed at one age is one observation.

The earliest entry the model learned from.

The latest entry the model learned from.

With an entry_key_property_name, the share of value events whose key matched no entry.

With an entry_key_property_name, events on the value stream that passed stream_conditions. Absent for a forecast without an entry key.

horizonobject

What the matured entries the model trained on say about the horizon's length, read without a model. Each candidate window shorter than the horizon is read as if it were the horizon. Absent on a model built before this reading existed.

Properties of object
by_cohortarray[object]

The same reading on each year of entry with enough matured entries to read on its own, oldest first.

Items of array[object]
entered_ininteger

The year the entries entered.

entriesinteger

Matured entries from that year.

windowsarray[object]

The candidate windows, shortest first, ending with the horizon itself.

Items of array[object]
gininumber

Value-ordered Gini of the horizon's value when the year's entries are ordered by the value realized by the window, ties counted at their mean. Absent when either value is the same for every entry.

The year's summed value realized by the window over its summed value over the horizon.

Days after the entry event the window reaches.

Matured entries the sample was drawn from. Equal to entries when every eligible entry was read.

entriesinteger

Matured entries read, the model's training sample.

The forecast's horizon, the last window read.

The matured entries a year must have to be read on its own in by_cohort.

Example: 200

The shortest window whose realized value orders the entries by the horizon's value with a Gini of at least settled_gini. Absent when no window does.

The Gini a window must reach for the ranking to count as settled.

Example: 0.9
skippedstring

Why the reading could not be taken, when it could not; the other members are then absent.

windowsarray[object]

The candidate windows, shortest first, ending with the horizon itself.

Items of array[object]
gininumber

Value-ordered Gini of the horizon's value when the entries are ordered by the value realized by the window, entries tied on the window's value counted at their mean; 1 is the horizon's own order. Absent when either value is the same for every entry.

Share of entries not yet ended at the window.

The entries' summed value realized by the window over their summed value over the horizon. A deduction after the window lowers the horizon's value and not the window's, so where refunds dominate the share can exceed 1.

spearmannumber

Rank correlation between the value realized by the window and the value realized over the horizon. Absent when either is constant.

Share of the entries in the horizon's top tenth by value that the window's value also puts in its top tenth, a run of ties at the window's cut counted in proportion. Where entries tie at the horizon's...

Share of the horizon's value held by the tenth of entries with the most value realized by the window, a run of ties at the cut counted at its mean. Absent when either value is the same for every entry.

Days after the entry event the window reaches.

What was done to the matured values before the model learned from them.

Properties of object
agesarray[integer]

The ages at which each matured entry is observed as a training row.

The quantile of matured values the cap was set at.

Example: 0.999
cappedinteger

Entries whose value was capped.

currencyobject

What the currency rule did to the value events, when the forecast names both currency and currency_property_name. Absent unless it names both, in which case amounts were summed as recorded. The co...

Properties of object
codestring

The currency the forecast is expressed in.

Example: "USD"
convertedinteger

Value events converted from another currency at a reference rate.

propertystring

The stream property each event's currency was read from.

Example: "currency"
recordedinteger

Value events already in the forecast's currency.

Value events left out because their currency has no reference rate.

unconverted_codesarray[string]

The currency codes left out, at most twenty.

Matured entries left out for an implausible entry date.

flooredinteger

Entries whose value was negative after deductions and floored at zero.

label_capnumber

Values above this were capped at it.

Entries that produced training observations.

Training observations after label handling.

Performance of the current model's recipe on held-out entries. See validation for how they were held out.

Properties of object

Whether the model passed acceptance, which is a floor on its own validated entries and, when one exists, a comparison with the previous model. A model that does not pass is not used when an earlier ac...

Properties of object
passedbooleanrequired
reasonsarray[string]required

Why the fit did not clear the floor, empty when it did.

by_agearray[object]

Every held-out entry, scored at each age the model was trained at. These rows carry the decile calibration, the bias interval and the constant baseline when the model recorded them.

Items of array[object]
gininumber

Normalized Gini of the ranking by forecast. 1 means entries are perfectly ordered by value, 0 means no better than random order, and a negative value means the ranking is inverted.

Example: 0.3
maenumber

Mean absolute error per entry. A descriptive number; it favors forecasting low when most entries realize nothing, so the comparison with the constant baseline is on rmse.

Mean value actually realized.

Mean forecast of the value remaining.

ninteger

Held-out observations the numbers are measured on.

rmsenumber

Root mean squared error per entry, in the value's unit. The error score the model and the constant baseline are compared on; it is minimized by the mean, which is what the model forecasts.

Share of all actual value found in the tenth of entries with the highest forecasts.

Example: 0.25

Sum of the forecasts over the sum of the actual values, minus one. What a platform summing the delivered values sees; +0.1 means the forecasts added up to 10% more than reality.

Example: 0.04
ageintegerrequired

Days after the entry event at which the entries were scored.

What forecasting every entry the mean remaining value of the entries it was held out from would have read on the same held-out observations. The model is compared with it on rmse, the error the mean minimizes; it ranks nothing.

Properties of object
maenumber

Mean absolute error of the constant forecast.

The constant forecast, the training rows' mean remaining value at this age.

rmsenumber

Root mean squared error of the constant forecast. A model whose rmse is lower explains some of the spread between entries; one whose rmse is higher does worse than forecasting the same value for everyone.

Total bias of the constant forecast.

decilesarray[object]

Calibration by forecast decile.

Items of array[object]
decileintegerrequired

1 is the tenth with the highest forecasts, 10 the lowest.

Mean value actually realized in the decile.

Mean forecast of the value remaining in the decile.

nintegerrequired

Held-out observations in the decile.

This decile's share of all actual value in the held-out entries.

Sum of the forecasts over the sum of the actual values in this decile, minus one.

Where the total bias lands over bootstrap resamples of the held-out observations. It measures how much of the reading is the particular entries drawn; it is not a forecast interval.

Properties of object
highnumber

Upper end of the band.

levelnumber

The band's coverage, as a share of the resamples it contains.

Example: 0.9
lownumber

Lower end of the band.

by_prior_entriesarray[object]

Held-out entries at age 0, by how many entries the person had before. Metrics only, as for newest_entries. Absent when the model did not record the slice.

Items of array[object]
gininumber

Normalized Gini of the ranking by forecast. 1 means entries are perfectly ordered by value, 0 means no better than random order, and a negative value means the ranking is inverted.

Example: 0.3
maenumber

Mean absolute error per entry. A descriptive number; it favors forecasting low when most entries realize nothing, so the comparison with the constant baseline is on rmse.

Mean value actually realized.

Mean forecast of the value remaining.

ninteger

Held-out observations the numbers are measured on.

rmsenumber

Root mean squared error per entry, in the value's unit. The error score the model and the constant baseline are compared on; it is minimized by the mean, which is what the model forecasts.

Share of all actual value found in the tenth of entries with the highest forecasts.

Example: 0.25

Sum of the forecasts over the sum of the actual values, minus one. What a platform summing the delivered values sees; +0.1 means the forecasts added up to 10% more than reality.

Example: 0.04
prior_entriesstringrequired

How many entries the person had before this one.

Allowed values: 0, 1, 2-3, 4+

The day-0 cold start, what a scope delivers for a population member with no entry on the forecast's entry stream (fdy_forecast_<id>_basis of attributes or prior). The prior is always recorded; t...

Properties of object

Third-party attributes the attributes model was offered.

entries_fromstring<date>

Entries from this date on were offered to the attributes model, the earliest date the account's third-party data covers. Absent when every training entry qualified.

modelobject

The attributes model, a second regression on the value of an entry given only the person's third-party attributes as of the entry date. Its performance is measured on the held-out age-0 entries that t...

Properties of object
attributesinteger

Attributes the model reads, those of the offered ones the screen kept.

balancenumber

Factor applied to the model's raw predictions so that they average to the training value.

Boosting rounds the model kept.

fitobject

The same numbers on the entries the model fit on, for the gap to holdout.

Properties of object
gininumber

Normalized Gini of the ranking by forecast. 1 means entries are perfectly ordered by value, 0 means no better than random order, and a negative value means the ranking is inverted.

Example: 0.3
maenumber

Mean absolute error per entry. A descriptive number; it favors forecasting low when most entries realize nothing, so the comparison with the constant baseline is on rmse.

Mean value actually realized.

Mean forecast of the value remaining.

ninteger

Held-out observations the numbers are measured on.

rmsenumber

Root mean squared error per entry, in the value's unit. The error score the model and the constant baseline are compared on; it is minimized by the mean, which is what the model forecasts.

Share of all actual value found in the tenth of entries with the highest forecasts.

Example: 0.25

Sum of the forecasts over the sum of the actual values, minus one. What a platform summing the delivered values sees; +0.1 means the forecasts added up to 10% more than reality.

Example: 0.04
holdoutobject

Performance on the matched held-out age-0 entries; the number to set against by_age at age 0.

Properties of object
gininumber

Normalized Gini of the ranking by forecast. 1 means entries are perfectly ordered by value, 0 means no better than random order, and a negative value means the ranking is inverted.

Example: 0.3
maenumber

Mean absolute error per entry. A descriptive number; it favors forecasting low when most entries realize nothing, so the comparison with the constant baseline is on rmse.

Mean value actually realized.

Mean forecast of the value remaining.

ninteger

Held-out observations the numbers are measured on.

rmsenumber

Root mean squared error per entry, in the value's unit. The error score the model and the constant baseline are compared on; it is minimized by the mean, which is what the model forecasts.

Share of all actual value found in the tenth of entries with the highest forecasts.

Example: 0.25

Sum of the forecasts over the sum of the actual values, minus one. What a platform summing the delivered values sees; +0.1 means the forecasts added up to 10% more than reality.

Example: 0.04

Matched entries held out from the fit, on which holdout is measured.

Offered entries the attributes describe well enough to fit or score.

matched_rows over rows. How much of this population the attributes model, rather than the prior, speaks for.

Mean share of the offered attributes that were present on an offered entry.

rowsinteger

Age-0 training entries offered to the fit, after entries_from.

selectionobject

How the offered attributes were screened down to the ones the attributes model reads, on the matched training entries outside the holdout. Absent on a generation trained before the screen existed, whose model read every offered attribute.

Properties of object
attributesarray[object]

The kept attributes, by gain, descending.

Items of array[object]
attributestringrequired

The attribute's name in the account's catalog.

gainnumber

Importance gain the attribute earned in the screening fit.

p_valuenumber

The smallest p-value the attribute earned in the significance test.

filledinteger

Offered attributes present on enough of the screened entries to be tested.

offeredinteger

Attributes offered to the screen.

selectedinteger

Attributes kept by gain in a screening fit; the ones the model reads.

Filled attributes whose relation to the matured value passed the significance test, at most the screen's cap.

skippedstring

Why the screen kept nothing, when it kept nothing.

Significant attributes left after dropping one of each highly correlated pair.

Matched entries the model fit on.

priornumber

The average matured entry, the mean value of the training entries at age 0 after label handling. What a person Faraday's data does not describe is delivered, before the level correction.

Entries the prior averages.

skippedstring

Why no attributes model was fit, when none was; every person with no entry then gets the prior.

stackobject

How the attributes model's read of each training entry's person was produced for the main model's third-party columns, out of fold, so that no entry was read by a model that saw its own value. Absent when no attributes model was fit.

Properties of object
fitsarray[object]

One fit per fold, on the other folds' entries.

Items of array[object]
attributesinteger

Attributes the fold's model read after the screen.

fit_rowsinteger

Entries the fold's model fit on.

foldinteger

The fold's model on its own held-out entries.

skippedstring

Why the fold's model could not be fit, when it could not; its entries carry no value.

Entries of the fold the model valued.

foldsinteger

Folds the training entries were split into by a hash of the entry id.

rowsinteger

Training entries offered a third-party value.

skippedstring

Why no third-party value was produced at all, when none was.

Training entries that got one, the ones the attributes describe well enough whose fold's model could be fit.

The held-out entries of the newest year of the training population, the closest the training rows come to a read on the current business. Metrics and, when the model recorded it, the slice's own `tota...

Properties of object
by_agearray[object]
Items of array[object]
gininumber

Normalized Gini of the ranking by forecast. 1 means entries are perfectly ordered by value, 0 means no better than random order, and a negative value means the ranking is inverted.

Example: 0.3
maenumber

Mean absolute error per entry. A descriptive number; it favors forecasting low when most entries realize nothing, so the comparison with the constant baseline is on rmse.

Mean value actually realized.

Mean forecast of the value remaining.

ninteger

Held-out observations the numbers are measured on.

rmsenumber

Root mean squared error per entry, in the value's unit. The error score the model and the constant baseline are compared on; it is minimized by the mean, which is what the model forecasts.

Share of all actual value found in the tenth of entries with the highest forecasts.

Example: 0.25

Sum of the forecasts over the sum of the actual values, minus one. What a platform summing the delivered values sees; +0.1 means the forecasts added up to 10% more than reality.

Example: 0.04
ageintegerrequired

Days after the entry event at which the entries were scored.

What forecasting every entry the mean remaining value of the entries it was held out from would have read on the same held-out observations. The model is compared with it on rmse, the error the mean minimizes; it ranks nothing.

Properties of object
maenumber

Mean absolute error of the constant forecast.

The constant forecast, the training rows' mean remaining value at this age.

rmsenumber

Root mean squared error of the constant forecast. A model whose rmse is lower explains some of the spread between entries; one whose rmse is higher does worse than forecasting the same value for everyone.

Total bias of the constant forecast.

decilesarray[object]

Calibration by forecast decile.

Items of array[object]
decileintegerrequired

1 is the tenth with the highest forecasts, 10 the lowest.

Mean value actually realized in the decile.

Mean forecast of the value remaining in the decile.

nintegerrequired

Held-out observations in the decile.

This decile's share of all actual value in the held-out entries.

Sum of the forecasts over the sum of the actual values in this decile, minus one.

Where the total bias lands over bootstrap resamples of the held-out observations. It measures how much of the reading is the particular entries drawn; it is not a forecast interval.

Properties of object
highnumber

Upper end of the band.

levelnumber

The band's coverage, as a share of the resamples it contains.

Example: 0.9
lownumber

Lower end of the band.

entered_fromstring<date-time>

Entries on or after this date are the newest year.

out_of_timearray[object]

How the model's inputs and settings do when trained earlier and asked about later entries, one read per origin, newest first. The other members of performance score entries from the same years the m...

Items of array[object]

Boosting rounds the refit kept.

by_agearray[object]

The judged entries scored at each age the model was trained at.

Items of array[object]
ageintegerrequired

Days after the entry event at which the entries were scored.

deliveredobject

The same forecasts with the level factor in force on the day each observation would have been scored (see level). Absent below delivered_from_age.

Properties of object
gininumber

Normalized Gini of the ranking by forecast. 1 means entries are perfectly ordered by value, 0 means no better than random order, and a negative value means the ranking is inverted.

Example: 0.3
maenumber

Mean absolute error per entry. A descriptive number; it favors forecasting low when most entries realize nothing, so the comparison with the constant baseline is on rmse.

Mean value actually realized.

Mean forecast of the value remaining.

ninteger

Held-out observations the numbers are measured on.

rmsenumber

Root mean squared error per entry, in the value's unit. The error score the model and the constant baseline are compared on; it is minimized by the mean, which is what the model forecasts.

Share of all actual value found in the tenth of entries with the highest forecasts.

Example: 0.25

Sum of the forecasts over the sum of the actual values, minus one. What a platform summing the delivered values sees; +0.1 means the forecasts added up to 10% more than reality.

Example: 0.04
modelobject

The refit model alone.

Properties of object
gininumber

Normalized Gini of the ranking by forecast. 1 means entries are perfectly ordered by value, 0 means no better than random order, and a negative value means the ranking is inverted.

Example: 0.3
maenumber

Mean absolute error per entry. A descriptive number; it favors forecasting low when most entries realize nothing, so the comparison with the constant baseline is on rmse.

Mean value actually realized.

Mean forecast of the value remaining.

ninteger

Held-out observations the numbers are measured on.

rmsenumber

Root mean squared error per entry, in the value's unit. The error score the model and the constant baseline are compared on; it is minimized by the mean, which is what the model forecasts.

Share of all actual value found in the tenth of entries with the highest forecasts.

Example: 0.25

Sum of the forecasts over the sum of the actual values, minus one. What a platform summing the delivered values sees; +0.1 means the forecasts added up to 10% more than reality.

Example: 0.04
by_quarterarray[object]

The same read by the quarter the judged entries entered in.

Items of array[object]
by_agearray[object]
Items of array[object]
ageintegerrequired

Total bias with the level factor applied. Absent below delivered_from_age.

gininumber

Normalized Gini of the refit model's ranking.

Total bias of the refit model alone.

ninteger

Observations.

quarterstringrequired

Calendar quarter, as 2025Q3.

The first age a forecast is delivered for an entry. delivered is absent below it.

fit_entered_beforestring<date>

The refit used entries that entered before this date, a horizon before the origin.

Entries the refit could use.

The judged year ends before this date.

First entry date of the judged year.

Entries judged.

levelarray[object]

The level factors behind delivered, re-read every 30 days from the newest cohort observable on each date. Each applies to the observations scored from its date until the next reading. Read from the sample of entries the model trained on.

Items of array[object]
as_ofstring<date>

How far the cohort's realized value sat from what the refit model implied for it.

factornumber

Factor applied to the value remaining, below the age the level reading covers.

reasonstring

Why the factor is 1 or was clamped, when it was.

Sampled entries in the cohort read.

originstring<date>required

The date the model is refit as of.

skippedstring

Why the origin was not read, for example too few entries had matured by then. Absent when it was read.

Whether the model reads the third-party columns. Their values come from an attributes model that saw entries from after the origin, so with true the read is slightly kinder than a full replay would be.

Whether the main model reads the person's third-party data, distilled into two columns by the attributes model (its value for the person, and how well the attributes describe them), and what that boug...

Properties of object
columnsarray[string]

The columns offered to the model.

early_agesarray[integer]

The training ages the decision weighs as early, where an entry has no history of its own.

The mean held-out Gini over a set of ages, for the fit without the third-party columns and the fit with them.

Properties of object
plainnumber
stackednumber

Each fit's held-out Gini at every training age, keyed by the age in days.

Properties of object
plaindictionary[string, number]
Additional properties: allowed (values are number)
stackeddictionary[string, number]
Additional properties: allowed (values are number)
keptboolean

Whether the current model reads the third-party columns.

late_agesarray[integer]

The training ages the columns must not get in the way of.

late_giniobject

The mean held-out Gini over a set of ages, for the fit without the third-party columns and the fit with them.

Properties of object
plainnumber
stackednumber
reasonstring

The comparison's verdict in words.

How the held-out numbers were read. Absent when the model did not record any.

Properties of object
foldsinteger

Number of folds, with cross_validation.

methodstring

cross_validation: the entries are split into folds, every age of an entry in one fold, and each fold is scored by a model fit without it, so every entry is held out once and the model in use is fit ...

Allowed values: cross_validation, holdout
refreshesarray[object]

The newest refreshes of the current model, newest first, each with the level readings it recorded.

Items of array[object]

The level correction the refresh applied.

The refresh's drift reading.

entriesinteger

Entries whose horizon was open at the refresh.

ran_atstring<date-time>

The refresh's data cutoff.

refreshed_atstring<date-time>required

When the refresh ran.

With an entry_key_property_name, the share of value events whose key matched no entry at the refresh.

versionstring

Short hash of the definition the forecast's current model was trained under, the version delivered with each entry. It changes once a defining member has changed and the model has been retrained for it, not on a routine retrain.

400The request was invalid.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, INVALID_API_KEY, ACCOUNT_SUSPENDED, ACCOUNT_DELETED, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

A suggestion for fixing this error.

401No API key was supplied.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, INVALID_API_KEY, ACCOUNT_SUSPENDED, ACCOUNT_DELETED, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

A suggestion for fixing this error.

403Access to this resource was forbidden.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, INVALID_API_KEY, ACCOUNT_SUSPENDED, ACCOUNT_DELETED, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

A suggestion for fixing this error.

404The requested resource ID was not found.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, INVALID_API_KEY, ACCOUNT_SUSPENDED, ACCOUNT_DELETED, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

A suggestion for fixing this error.

500An internal server error occurred.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, INVALID_API_KEY, ACCOUNT_SUSPENDED, ACCOUNT_DELETED, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

A suggestion for fixing this error.

Tags

forecasts