Unplugg API

Headers

To authorize your requests, add the following headers:

                    
                       x-access-token: <YOUR-ACCESS-TOKEN>
                       Content-Type: application/json
                     
                  

Payload

Payloads sent to the API will be a Json structure with three objects:

• Time Series data (data):

  Time series data will be a list of values with associated timestamps.

  Parameter	Example	Description
  timestamp	1466640000	Timestamps in Unix time format (seconds)
  value	0.27589941523037853	Integer or float value for specified timestamp

• Link for webhook callback (callback)

  The link will be used to return forecasting result to the webhook once job is finished.

  Parameter	Example	Description
  callback	http://your.domain/yourcallback	Link to which the job payload will be sent

• [Optional] Forecasting end date (forecast_to)

  The time series will be forecasted up to this date.

  Parameter	Example	Description
  forecast_to	1458136800	Timestamps in Unix time format (seconds)

                           
                           {
                              "data": [
                                 {"timestamp":1466640000,"value":0.27589941523037853},
                                 {"timestamp":1466640900,"value":0.4059699097648263},
                                 {...} ,
                                 {"timestamp":1466641800,"value":0.8376112426631153}
                              ],
                              "forecast_to":1458136800,
                              "callback": "http://your.domain/yourcallback"
                           }
                           
                        

Response

If the payload is well-behaved and sent for processing you’ll receive a job_id in the body that uniquely identifies the processing job for your data. If the time series in the payload is not equally spaced, a resampling will be applied in order to have each value separated from the next by the same amount as the first two values in the given time series. Malformed payloads will return a 422: UNPROCESSABLE ENTITY status as well as a message that should help in locating the error.

Once the job finishes your webhook will be sent a Json structure with:

• Forecasting data will be will a list of values with associated timestamps inside an object called forecast, similarly to the historic data (see Payload). The forecasted time series will be executed until the given date in parameter forecast_to or, in case it is not provided, the forecasted array will have the length of 1/8 of the number of points in the time series provided in the payload.

• Object job_id containing the job ID you’ve received earlier, associated with this specific forecasting request.

Webhook content example:

                        {
                           "forecast": [
                              {"timestamp":1466640000,"value":0.27589941523037853},
                              {"timestamp":1466640900,"value":0.4059699097648263},
                              {...} ,
                              {"timestamp":1466641800,"value":0.8376112426631153}
                           ],
                           "job_id": "y0urJ0b1d"
                        }
                     

Example usage and response

• Request (application/json)

• Body

• Headers

  x-access-token: [YOUR-ACCESS-TOKEN]

• Response 200 (application/json)

  
                             [
                                {
                                   "forecast": [
                                      {"timestamp":1458129600,"value":58.6912515906},
                                      {"timestamp":1458133200,"value":30.5359068808},
                                      {"timestamp":1458136800,"value":36.7927021395},
                                      {"timestamp":1458140400,"value":48.7672586419}
                                   ],
                                   "job_id": "y0urJ0b1d"
                                }
                             ]