Skip to content

TIM API

v5.1.17 [2021-09-21] (current stable release)

New features

Forecasting:

  • Enabled additional filtering during retrieval of lists of forecasting jobs:
    • on minimal date and time of creation (from)
    • on maximal date and time of creation (to)
  • Added DELETE /forecast-jobs endpoint for deleting multiple forecasting jobs
  • Enabled filtering during deletion of multiple forecasting jobs:
    • on experiment
    • on use case
    • on type
    • on status
    • on parent job
    • on minimal date and time of creation (from)
    • on maximal date and time of creation (to)

Anomaly Detection:

  • Enabled additional filtering during retrieval of lists of anomaly detection jobs:
    • on minimal date and time of creation (from)
    • on maximal date and time of creation (to)
  • Added DELETE /detection-jobs endpoint for deleting multiple anomaly detection jobs
  • Enabled filtering during deletion of multiple anomaly detection jobs:
    • on experiment
    • on use case
    • on type
    • on status
    • on parent job
    • on minimal date and time of creation (from)
    • on maximal date and time of creation (to)

Datasets:

  • Enabled additional filtering during retrieval of lists of datasets:
    • on minimal date and time of creation (from)
    • on maximal date and time of creation (to)
    • on status
  • Added DELETE /datasets endpoint for deleting multiple datasets
  • Enabled filtering during deletion of multiple datasets:
    • on minimal date and time of creation (from)
    • on maximal date and time of creation (to)
    • on workspace

Changes

  • Unified JSON log format
  • Improved parameter descriptions in Swagger
  • Hierarchical API request bodies
  • Hierarchical API responses

Forecasting:

  • For POST /forecast-jobs/{id}/execute, changed HTTP response status code for successful requests from 200 (OK) to 202 (Accepted)

Anomaly Detection:

  • Improved handling of invalid API calls
  • For POST /detection-jobs/{id}/execute, changed HTTP response status code for successful requests from 200 (OK) to 202 (Accepted)

Bug fixes

Forecasting:

  • Handled scenario throwing exception during holiday column validation
  • In POST /forecast-jobs/{id}/predict, improved schema validation
  • Handled job registration (build, rebuild, predict) with dataset version that has not yet finished uploading
  • Fixed issue of no out-of-sample rows when relativeRange is used
  • For GET /forecast-jobs/{id}/results/table, updated example response
  • For GET /forecast-jobs and GET /forecast-jobs/{id}, updated Swagger response schema to include calculationTime key

Anomaly Detection:

  • Handled job registration (build, rebuild, detect) with dataset version that has not yet finished uploading
  • Handled scenario throwing exception during holiday column validation
  • Improved recognition of endpoints
  • For GET /detection-jobs/{id}/results/table, updated example response

Datasets:

  • Fixed dataset upload remaining stuck in status Registered
  • Fixed foreign key violation on dataset log update
  • In DELETE /datasets/{id} and DELETE /datasets/{id}/versions/{version}, remove use cases using that dataset instead of returning error
  • In POST /datasets/{id}/versions/{version}/slice, fixed handling of imputation type
  • Fixed bug in update of dataset with columns in a different order than in previous versions

Workflow:

  • Improved example responses in Swagger
  • In DELETE /workspaces/{id}, remove datasets inside that workspace instead of returning error

Licenses & Users:

  • Fixed creation of default workspace

v5.1.16 [2021-08-12]

Changes

Forecasting:

  • Improved Swagger response for GET /forecast-jobs/{id}/results/rca

Bug fixes

  • Fixed handling of header X-User-Id
  • Added the following headers to Swagger:
    • tokenAuth
    • X-Log-Reference
    • X-Tim-Client

Forecasting:

  • In POST /forecast-jobs/{id}/rca, made modelIndex required
  • In POST /forecast-jobs/build-model and POST /forecast-jobs/{id}/rebuild model, disabled setting rollingWindow to 0

v5.1.15 [2021-08-10]

Changes

  • Formatted console logs as JSONs
  • Hid deprecated warnings from stdout

Bug fixes

Datasets:

  • Expanded handling of CSV files with a Byte Order Mark (BOM)

v5.1.14 [2021-08-06]

New features

Forecasting:

  • Enabled sorting during retrieval of lists of forecasting jobs:
    • ASC and DESC
    • on created_at, executed_at, completed_at and priority
  • Enabled additional filtering during retrieval of lists of forecasting jobs:
    • on status
    • on parent job
  • Added POST /forecast-jobs/{id}/predict endpoint for forecasting with an existing model

Anomaly Detection:

  • Enabled sorting during retrieval of lists of anomaly detection jobs:
    • ASC and DESC
    • on created_at, executed_at, completed_at and priority
  • Enabled additional filtering during retrieval of lists of forecasting jobs:
    • on status
    • on parent job

Datasets:

  • Enabled sorting during retrieval of lists of datasets:
    • ASC and DESC
    • on created_at
  • Enabled additional filtering during retrieval of lists of datasets:
    • on workspace

Workflow:

  • Enabled sorting during retrieval of lists of workspaces:
    • ASC and DESC
    • on created_at, updated_at and title
  • Enabled sorting during retrieval of lists of use cases:
    • ASC and DESC
    • on created_at, updated_at, title, dataset and accuracy impact
  • Enabled sorting during retrieval of lists of experiments:
    • ASC and DESC
    • on created_at, updated_at and title

Licenses & Users:

  • Error codes for error and exception logging

Changes

  • Unification of Swagger file structure

Forecasting:

  • Removed default value for maxModelComplexity in configuration or build model jobs and rebuild model jobs
  • Attempts at executing an already executed job return status 200 instead of 400
  • In GET /forecast-jobs/{id}/results/rca, renamed the parameter lag to radius

Anomaly Detection:

  • Attempts at executing an already executed job return status 200 instead of 400
  • In GET /detection-jobs/{id}/results/rca, renamed the parameter lag to radius

Bug fixes

Forecasting:

  • Catch job fails due to too large of a dataset slice upon registration (instead of during execution)
  • Fixed handling of registration of a model building job with an invalid use case ID

Anomaly Detection:

  • Catch job fails due to too large of a dataset slice upon registration (instead of during execution)
  • Fixed handling of registration of a model building job with an invalid use case ID

Datasets:

  • Add size limit for download (POST /datasets/{id}/versions/{version}/slice)

v5.1.13 [2021-07-23]

New features

  • Error messages expanded:
    • with codes identifying domain, endpoint and specific error
    • with human-readable message
  • Logging in Apache format for all resources
  • For all list retrieval endpoints:
    • made pagination default to (OFFSET 0, LIMIT 100)
    • introduced sorting options ASC and DESC
    • made sorting default to created_at DESC (most recently created entities returned first)

Forecasting:

  • In GET /forecast-jobs, return jobLoad

Anomaly Detection:

  • In GET /detection-jobs, return jobLoad

Datasets:

  • Added support for timestamp format "yyyy-mm-ddTHH:MM:SSZ" (including Z indicator for Zulu)

Licenses & Users:

  • Made sorting for list of users default to DESC on name (first and last)

Changes

Forecasting:

  • Improved Swagger responses

Anomaly Detection:

  • Improved Swagger responses

Workflow:

  • Hierarchical API responses

Bug fixes

Forecasting:

  • Create a new RCA job if execution of the existing RCA job has failed (instead of returning the ID of the existing RCA job upon attempt to register)
  • Introduced X-Tim-Client header (for /execute endpoint)
  • Return error if expectedResultsTableSize is infinite
  • Fixed bug in calculation of expectedResultsTableSize related to rollingWindow parameter for registration of a model building job

Anomaly Detection:

  • Create a new RCA job if execution of the existing RCA job has failed (instead of returning the ID of the existing RCA job upon attempt to register)
  • Fixed functionality to copy jobs

Datasets:

  • Fixed formatting of X-Total-Count response header in list retrieval endpoints

v5.1.12 [2021-07-16]

New features

  • Accept X-Log-Reference, X-User-Id and X-Tim-Client request headers
  • Logging of API errors

Forecasting:

  • Only one RCA job created per parent:
    • all registration attempts return the same ID
    • trying to execute an executed RCA job returns a message informing the user that the job has already been executed
  • Introduced X-Tim-Client header (for /execute endpoint)
  • In GET /forecast-jobs, added the possibility to filter on multiple job types in a single request (allowed array in type query parameters)

Anomaly Detection:

  • Only one RCA job created per parent:
    • all registration attempts return the same ID
    • trying to execute an executed RCA job returns a message informing the user that the job has already been executed
  • In GET /detection-jobs, the possibility to filter on multiple job types in a single request (allowed array in type query parameters)

Bug fixes

  • Fixed issues with logging
  • Fixed header names

Forecasting:

  • Made POST /forecast-jobs/{id}/execute return JSON instead of plain text

Anomaly Detection:

  • Made POST /detection-jobs/{id}/execute return JSON instead of plain text

v5.1.11 [2021-07-13]

New features

Licenses & Users:

  • Sorting during retrieval of lists of:
    • license log
    • users
    • user log
    • user groups

Changes

  • Unified API error responses

Forecasting:

  • Improved Swagger responses for Forecasting Job Management endpoints: removed "###" from implemented keys

Anomaly Detection:

  • Improved Swagger response for GET /detection-jobs/{id}/results/rca

Licenses & Users:

  • Hierarchical API responses

Bug fixes

  • Fixed API error message creation in API error handler

Forecasting:

  • Removed unimplemented elements (sequences) from Swagger

Anomaly Detection:

  • Introduced X-Tim-Client header (for /execute endpoint)
  • Removed unimplemented elements (sequences) from Swagger

Datasets:

  • Fixed upload of CSV files containing format with hidden characters (quotes)

v5.1.10 [2021-07-12]

Changes

Forecasting:

  • Improved Swagger request body for Forecasting Job Management endpoints

Bug fixes

Forecasting:

  • Disallowed jobs to be registered with an empty columns selection
  • Fixed bug in determination of job load category (light or heavy)

Anomaly Detection:

  • Disallowed jobs to be registered with an empty columns selection

v5.1.9 [2021-07-09]

New features

Forecasting:

  • Job load categorization: light and heavy job loads are recognized and send to an appropriate queue

Bug fixes

Datasets:

  • Updated Swagger response of GET /datasets/{id}/log (renamed timestamp to createdAt for consistency)

v5.1.8 [2021-07-07]

New features

Forecasting:

  • During the creation of a forecast job, if no experiment ID is passed and no parent job exists, a default forecasting experiment is created in the relevant use case, in which the job is then created
  • Enabled parallel processing of API requests

Anomaly Detection:

  • During the creation of an anomaly detection job, if no experiment ID is passed and no parent job exists, a default anomaly detection experiment is created in the relevant use case, in which the job is then created
  • Added an "Info" log message about job load category
  • Enabled parallel processing of API requests

Workflow:

  • Introduced X-Tim-Client header
  • Enabled parallel processing of API requests

Changes

  • Improved deployment pipelines

Datasets:

  • Changed response type of POSTS /datasets/{id}/versions/{version}/slice from JSON object to CSV file
  • Changed edit endpoints from PUT to PATCH
  • Improved Swagger UI for Dataset Management endpoints

Bug fixes

Forecasting:

  • Forecasting job registration no longer fails if "from" equals "to" in rows ranges (inSampleRows and outOfSampleRows in configuration of model building and model rebuilding jobs, outOfSampleRows in configuration of predicting jobs)

Anomaly Detection:

  • Fixed handling of empty registration body
  • Anomaly detection job registration no longer fails if "from" equals "to" in rows ranges (rows in data configuration of model building, model rebuilding jobs and detection jobs)
  • Fixed failing RCA jobs related to the calculation of expectedResultsTableSize

v5.1.7 [2021-06-28]

New features

Anomaly Detection:

  • Job load categorization: light and heavy job loads are recognized and send to an appropriate queue

Datasets:

  • Added POST /datasets/sql/preview endpoint for downloading a preview of a dataset from a connected SQL database

Changes

Workflow:

  • Changed edit endpoints from PUT to PATCH

v5.1.6 [2021-06-24]

Changes

Workflow:

  • Improved Swagger response for POST /use-cases

Bug fixes

Workflow:

  • Fixed error handling of import and export of use cases

v5.1.5 [2021-06-23]

New features

Anomaly Detection:

  • Added expectedResultsTableSize (the expected size of the table returned in the job results (in MB).) to the response of
    • POST /detection-jobs/build-model
    • POST /detection-jobs/{id}/rebuild-model
    • POST /detection-jobs/{id}/detect

Changes

Workflow:

  • Removed creation of default experiments upon creation of use case
  • Allowed default forecasting experiment and default anomaly detection experiment of a use case to be set during edit of use case
  • Improved Swagger request body for PUT /use-cases

Bug fixes

Workflow:

  • Fixed encryption of .tw files containing an exported use case

v5.1.4 [2021-06-22]

New features

Forecasting:

  • Added plotlyFriendly parameter in GET /forecast-jobs/{id}/results/table (if set to true (default), gaps in timestamps for all forecastTypes and bins will be filled; if modelIndex is chosen this setting is ignored)

Datasets:

  • Enabled parallel processing of API requests

Changes

Workflow:

  • Improved Swagger UI for GET /workspaces

Bug fixes

Forecasting:

  • Allow predictionIntervals to be set in the configuration of a forecasting job
  • Fixed handling of explicitly set target column

Anomaly Detection:

  • Made detectionIntervals in the model building configuration require at least one interval - sending empty detectionIntervals now fails during job registration

Licenses & Users:

  • Fixed inconsistencies in License and User Management endpoints

v5.1.3 [2021-06-14]

New features

Forecasting:

  • Added expectedResultsTableSize (the expected size of the table returned in the job results (in MB).) to the response of
    • POST /forecast-jobs/build-model
    • POST /forecast-jobs/{id}/rebuild-model

Bug fixes

  • Updated Swagger documentation version to v5

Workflow:

  • Fixed issue with job sizes in export of use cases
  • Fixed issue with regenerating IDs of jobs in import of use cases

v5.1.2 [2021-06-07]

Bug fixes

  • Fixed dynamic URL filling in Swagger

v5.1.1 [2021-06-06]

Changes

  • Dynamic URL filling in Swagger

v5.1.0 [2021-06-04]

New features

Anomaly Detection:

  • Ensured result table is sorted chronologically

Datasets:

  • Enabled parallel processing of dataset uploads

Workflow:

  • Added GET /use-cases/{id}/export for exporting of use cases
  • Added POST /use-cases/import for importing of use cases
  • Enabled additional filtering during retrieval of lists of use cases:
    • on user group

Changes

Datasets:

  • Added custom validation for UUIDs, in:
    • GET /datasets/{id}
    • PUT /datasets/{id}
    • GET /datasets/{id}/versions/{version}
    • GET /datasets/{id}/versions/{version}/status
    • POST /datasets/{id}/versions/{version}/slice

Bug fixes

Datasets:

  • Fixed handling of CSV files with a Byte Order Mark (BOM)
  • Queue reconnection

Forecasting:

  • Made a list of from-to ranges in configuration require at least one range
  • Updated response of GET /forecast-jobs/{id}/status (renamed timestamp to createdAt for consistency)

Anomaly Detection:

  • Made a list of from-to ranges in configuration require at least one range

Licenses & Users:

  • Made email case-insensitive

v5.0.0 [2021-05-28]

New features

Forecasting:

  • Forecast-related requests organized and managed as jobs
  • Forecasting jobs can be:
    • retrieved,
    • relevant logs can be retrieved, their status and the progress of an execution can be retrieved
    • registered (i.e. created, but not yet executed), available job types are:
      • model building,
      • model rebuilding,
      • predicting, and
      • root cause analysis,
    • executed (after being registered),
    • their results (in-sample, out-of-sample and production) can be retrieved,
    • the production forecast can be retrieved separately,
    • root cause analysis results can be retrieved,
    • the models that were built for a job can be retrieved,
    • the accuracies (error measures) can be retrieved,
    • copied to another experiment, and
    • deleted

Anomaly detection:

  • Anomaly detection-related requests organized and managed as jobs
  • Anomaly detection jobs can be:
    • retrieved,
    • relevant logs can be retrieved, their status and the progress of an execution can be retrieved
    • registered (i.e. created, but not yet executed), available job types are:
      • model building,
      • model rebuilding,
      • detecting, and
      • root cause analysis,
    • executed (after being registered),
    • their results can be retrieved,
    • the models that were built for a job can be retrieved,
    • root cause analysis results can be retrieved,
    • copied to another experiment, and
    • deleted

Datasets:

  • Datasets can be:
    • retrieved,
    • relevant logs can be retrieved,
    • uploaded as a CSV file,
    • uploaded via connection to an SQL database (supported options are PostgreSQL, MySQL, MariaDB and SQL_Server),
    • updated with a CSV file - this creates a new dataset version,
    • updated via SQL connection to an SQL database (supported options are PostgreSQL, MySQL, MariaDB and SQL_Server) - this creates a new dataset version,
    • updated in terms of metadata, and
    • deleted
  • Dataset versions can be:
    • retrieved,
    • their status and the progress of an upload can be retrieved
    • created, which is done by uploading or updating a dataset,
    • downloaded, and
    • deleted

Workflow:

  • Structured analytics work in a tree-like hierarchy:
    • starting from (forecasting or anomaly detection) jobs that contain molecular requests such as those of model building and model application
    • jobs are grouped in experiments, allowing users to iterate over jobs to optimize the configuration of the particular challenge at hand
    • experiments revolve around use cases, each of which is linked to a single dataset
    • use cases are organized in workspaces
  • Each of the elements in this hierarchy can be
    • retrieved,
    • created,
    • edited, and
    • deleted

Licenses & Users:

  • Support for authentication, logging in and logging out
  • License management; licenses can be:
    • retrieved
    • relevant logs and information about storage and limits can be retrieved, and
    • edited by administrator users
  • Users can be:
    • retrieved,
    • relevant logs can be retrieved,
    • created by administrator users, and
    • edited and deactivated
  • User groups provide the basis for collaboration and sharing of work
  • User groups can be
    • retrieved,
    • created,
    • edited, and
    • deleted

v4.5 [2020-10-23]

New features

  • added in-sample results for RTInstantML​
  • added backtesting results for RTInstantML for fast sampling rates​
  • added model view and accuracy through different forecasting horizons​
  • reworked extended importances to match (non-)daily cycle
  • improved execution time (sampling rate agnostic performance) in anomaly detection
  • added isTimeSpecific flag in the response JSON indicating whether Model Zoo is time specific
  • reworked sampling period computation for irregular data with using median

Non-breaking changes

  • removed constraint of backtesting length in RTInstantML
  • holiday column name if do not exist in csv data return warning
  • several bugfixes for irregular data​

Breaking changes

This release does not contain any breaking changes.

v4.4 [2020-08-31]

New features

Non-breaking changes

Breaking changes

This release does not contain any breaking changes but does not support the old Anomaly model from previous versions.

v4.3 [2020-08-06]

New features

Non-breaking changes

Breaking changes

This release does not contain any breaking changes.

v4.2 [2020-04-15]

New features

Non-breaking changes

  • dictionary Simple Moving Average is now applied to all predictors (not just target)
  • added option to use CSV schema for data in JSON requests
  • reworked treemap strings
  • added an option to return normal behavior signal (forecast) in anomaly detection

Breaking changes

This release does not contain any breaking changes.

v4.1 [2020-01-30]

New features

  • authentication via access tokens
  • customizable interpolation of missing values
  • new dictionaries: Identity and Simple Moving Average
  • added option to turn off offsets
  • support for data with regular gaps

Non-breaking changes

  • data doesn't have to be aligned
  • optional HTTP headers X-Client-Name and X-Client-Version
  • changed warnings for extreme values coming to prediction to IQR standard instead of relative difference
  • turned off Piecewise Linearity dictionary for too short datasets
  • turned off Weekdays and Weekrest dictionaries for datasets with too few Mondays
  • fixed bug with predictors that are updated not every day of week
  • not using low quality predictions in anomaly detection

Breaking changes

This release does not contain any breaking changes.

v4.0 [2019-10-15]

New features

  • support for general sampling rates

Non-breaking changes

  • using JSON schemas for request validation (affects error messages)
  • API definition greatly simplified and converted to OpenAPI 3.0 (previously Swagger 2.0)

Breaking changes

  • new licensing system, License-Key HTTP header is required
  • Api-Key HTTP header is required
  • removed "OneTime" usage (deprecated by RTInstantML)
  • removed meteo support
  • refactored anomaly detection features