API Response Structure

Status

• status: string
  • Enum: success, no-seasonality-model-available, not-enough-data-points

Results

• results: object
  • withSeasonality: array of arrays
    • Array of tuples with the total number of requests considering seasonality.
  • withoutSeasonality: array of objects
    • Array of tuples with the total number of requests not considering seasonality.
  • bySite: object
    • The individual results broken down by Site.
    • Note: The sum of these values may not equal the global results.

Sample API Request

curl --request GET \
     --url https://api.kevel.co/v1/forecaster/auto-seasonality/preview \
     --header 'accept: application/json'

Sample API Response

{
  "status": "success",
  "results": {
    "withSeasonality": [[]],
    "withoutSeasonality": [[]]
  },
  "bySite": {
    "additionalProp": {
      "withSeasonality": [[]],
      "withoutSeasonality": [[]]
    }
  }
}