stmz-msg-api-timeforecast
FREE-TIER1 credit per call
Great for
- Forecasting sales figures
- Predicting user traffic
- Analysing store foot traffic
Use advanced statistics to forecast into the future
High-speed
200ms/req.
(excludes upload time)
Supports single and multiple variables
Allows for a variety of use cases
High capacity
Supports high volume requests
(Pro Credits)
Cost and Modes available
Free-tier available
Modes: Async
Credit per Call: 1
API call instructions
CSV
Specification
URI
/api/message/stmz-msg-api-timeforecast
Maximum number columns
Recommended 1000 columns
Input
Sample Input
,0,1,2,3,4,5,6,7,8,9,10~
target,1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0,9.0,10.0~
exog1,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0~
exog2,2.5,2.5,2.5,2.5,2.5,2.5,2.5,2.5,2.5,2.5,2.5~
Output
result
Array of floating-point number of the forecast as specified by the input
Sample Output
,0,1,2,3,4,5,6,7,8,9,10~
target,1.0,2.0,3.0,4.0,5.0,6.0,7.0,8.0,9.0,10.0,10.997614670799326~
exog1,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0,1.0~
exog2,2.5,2.5,2.5,2.5,2.5,2.5,2.5,2.5,2.5,2.5,2.5~
CURL Request Example
$ curl --location --request POST 'https://systemize.ai/api/message/stmz-msg-api-timeforecast' \
--header 'CLIENT_KEY: XXXXXXXXXXXXXXXXX' \
--header 'CLIENT_SECRET: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Content-Type: text/csv' \
--data-binary '@/home/stmz/Desktop/sample_single.csv'
JSON
Specification
URI
/api/message/stmz-msg-api-timeforecast
Maximum array length
Recommended 1000 values
Content-Type
application/json
Response format
application/json
Input
series
An array, or array of arrays, being the past data that is to have a model built from.
horizon
An integer, which is the forecast horizon, the number of steps forecasting into the future.
exogenous
A Boolean or List, which indicates if exogenous variables should be taken into account.
Exogenous variables are extra variables which may influence the target series you are trying to forecast. For example, an exogenous variable may be the maximum temperature of the day, which could influence the foot traffic a store receives.
Note this only is possible if data is an array of arrays, meaning it is a time series with multiple variables (multivariate). If using exogenous data (extra variables), the first variable in `series` in a vector, will be the target variable that is to be forecasted. If `exogenous` is a list, it must be a list of lists that is the length of the horizon you wish to forecast.
Note: If using exogenous, horizon must be the same or less than the exogenous array length.
Sample Input
{ ~
--"data": { ~
----"series": [10.3, 10.5, 10.9, 10.3, 10.1, 9.9, 9.8, 9.9, 10.0, 10.2, 10.3, 10.5, 10.9, 10.3, 10.1, 9.9, 9.8, 9.9, 10.0, 10.2, 10.3, 10.5, 10.9, 10.3, 10.1, 9.9, 9.8, 9.9, 10.0, 10.2], ~
----"horizon": 10, ~
----"exogenous": false ~
--} ~
}
Output
result
Array of floating-point number of the forecast as specified by the input
Sample Output
{~
--"data": ~
----{~
------"result": [10.3, 10.5, 10.9, 10.3, 10.1, 9.9, 9.8, 9.9, 10.0, 10.2]~
----}~
}
CURL Request Example
$ curl --location --request POST 'https://api.systemize.ai/api/message/stmz-msg-api-timeforecast' \
--header 'CLIENT_KEY: YOUR_CLIENT_KEY' \
--header 'CLIENT_SECRET: YOUR_CLIENT_SECRET' \
--header 'Content-Type: application/json' \
--data-raw '{
"data": {
"series": [10.3, 10.5, 10.9, 10.3, 10.1, 9.9, 9.8, 9.9, 10.0, 10.2, 10.3, 10.5, 10.9, 10.3, 10.1, 9.9, 9.8, 9.9, 10.0, 10.2, 10.3, 10.5, 10.9, 10.3, 10.1, 9.9, 9.8, 9.9, 10.0, 10.2],
"horizon": 10,
"exogenous": false
}
}'