Nexosis Api

API change history

Sessions: Create forecast session

Queues a new forecast session to run

Forecast sessions are used to predict future values for a data source. To create a forecast session, specify the data source to forecast, as well as the start and end dates of the forecast period. The Nexosis API will execute a series of machine learning algorithms to approximate future values for the data source.
The forecast start date should be on the same day as (or before) the last date in the data source. If there is a gap between your forecast start date and the date of the last record in your data set, the Nexosis API will behave as if there is no gap.
See http://docs.nexosis.com/guides/forecast for more information about creating a forecast session. Note that the query string parameters to this API operation are deprecated. All parameters can be passed in the JSON body of the request.

Try it

Request URL

Request headers

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "dataSourceName": "Location-A",
  "startDate": "2017-01-01T00:00:00Z",
  "endDate": "2017-01-05T00:00:00Z",
  "columns": {
    "timestamp": {
      "dataType": "date",
      "role": "timestamp"
    },
    "sales": {
      "dataType": "numeric",
      "role": "target"
    }
  }
}
{
  "type": "object",
  "properties": {
    "dataSourceName": {
      "description": "Name of the dataset or view to forecast",
      "type": "string"
    },
    "targetColumn": {
      "description": "Column in the specified data source to forecast",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "description": "First date to forecast",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "Last date to forecast",
      "type": "string"
    },
    "resultInterval": {
      "description": "The interval at which predictions should be generated.  Possible values are `Hour`, `Day`, `Week`, `Month`, and `Year`.  Defaults to `Day`",
      "enum": [
        "hour",
        "day",
        "week",
        "month",
        "year"
      ],
      "type": "string"
    },
    "callbackUrl": {
      "description": "The Webhook url that will receive updates when the Session status changes<br />\r\nIf you provide a callback url, your response will contain a header named Nexosis-Webhook-Token.  You will receive this \r\nsame header in the request message to your Webhook, which you can use to validate that the message came from Nexosis.",
      "type": "string"
    },
    "isEstimate": {
      "description": "If specified, the session will not be processed.  The returned `Nexosis-Request-Cost` header will be populated with the estimated cost that the request would have incurred.",
      "type": "boolean"
    },
    "columns": {
      "description": "Metadata about each column in the data source",
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "numeric",
              "logical",
              "date",
              "numericMeasure"
            ],
            "type": "string"
          },
          "role": {
            "enum": [
              "none",
              "timestamp",
              "target",
              "feature",
              "key"
            ],
            "type": "string"
          },
          "imputation": {
            "enum": [
              "zeroes",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          },
          "aggregation": {
            "enum": [
              "sum",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          }
        }
      }
    }
  },
  "example": {
    "dataSourceName": "Location-A",
    "startDate": "2017-01-01T00:00:00Z",
    "endDate": "2017-01-05T00:00:00Z",
    "columns": {
      "timestamp": {
        "dataType": "date",
        "role": "timestamp"
      },
      "sales": {
        "dataType": "numeric",
        "role": "target"
      }
    }
  }
}
{
  "dataSourceName": "Location-A",
  "startDate": "2017-01-01T00:00:00Z",
  "endDate": "2017-01-05T00:00:00Z",
  "columns": {
    "timestamp": {
      "dataType": "date",
      "role": "timestamp"
    },
    "sales": {
      "dataType": "numeric",
      "role": "target"
    }
  }
}
{
  "type": "object",
  "properties": {
    "dataSourceName": {
      "description": "Name of the dataset or view to forecast",
      "type": "string"
    },
    "targetColumn": {
      "description": "Column in the specified data source to forecast",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "description": "First date to forecast",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "description": "Last date to forecast",
      "type": "string"
    },
    "resultInterval": {
      "description": "The interval at which predictions should be generated.  Possible values are `Hour`, `Day`, `Week`, `Month`, and `Year`.  Defaults to `Day`",
      "enum": [
        "hour",
        "day",
        "week",
        "month",
        "year"
      ],
      "type": "string"
    },
    "callbackUrl": {
      "description": "The Webhook url that will receive updates when the Session status changes<br />\r\nIf you provide a callback url, your response will contain a header named Nexosis-Webhook-Token.  You will receive this \r\nsame header in the request message to your Webhook, which you can use to validate that the message came from Nexosis.",
      "type": "string"
    },
    "isEstimate": {
      "description": "If specified, the session will not be processed.  The returned `Nexosis-Request-Cost` header will be populated with the estimated cost that the request would have incurred.",
      "type": "boolean"
    },
    "columns": {
      "description": "Metadata about each column in the data source",
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "numeric",
              "logical",
              "date",
              "numericMeasure"
            ],
            "type": "string"
          },
          "role": {
            "enum": [
              "none",
              "timestamp",
              "target",
              "feature",
              "key"
            ],
            "type": "string"
          },
          "imputation": {
            "enum": [
              "zeroes",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          },
          "aggregation": {
            "enum": [
              "sum",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          }
        }
      }
    }
  },
  "example": {
    "dataSourceName": "Location-A",
    "startDate": "2017-01-01T00:00:00Z",
    "endDate": "2017-01-05T00:00:00Z",
    "columns": {
      "timestamp": {
        "dataType": "date",
        "role": "timestamp"
      },
      "sales": {
        "dataType": "numeric",
        "role": "target"
      }
    }
  }
}

Response 200

success

{
  "columns": {
    "timestamp": {
      "dataType": "date",
      "role": "timestamp"
    },
    "sales": {
      "dataType": "numeric",
      "role": "target"
    }
  },
  "sessionId": "03086249-3b85-4a6a-ace8-3817adf8c9aa",
  "type": "forecast",
  "status": "requested",
  "startDate": "2017-01-01T00:00:00+00:00",
  "endDate": "2017-01-05T00:00:00+00:00",
  "requestedDate": "0001-01-01T00:00:00+00:00",
  "statusHistory": [],
  "extraParameters": {},
  "messages": [],
  "dataSourceName": "Location-A.03086249-3b85-4a6a-ace8-3817adf8c9aa",
  "dataSetName": "Location-A.03086249-3b85-4a6a-ace8-3817adf8c9aa",
  "targetColumn": "sales",
  "callbackUrl": "",
  "isEstimate": false,
  "links": []
}
{
  "type": "object",
  "properties": {
    "columns": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "numeric",
              "logical",
              "date",
              "numericMeasure"
            ],
            "type": "string"
          },
          "role": {
            "enum": [
              "none",
              "timestamp",
              "target",
              "feature",
              "key"
            ],
            "type": "string"
          },
          "imputation": {
            "enum": [
              "zeroes",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          },
          "aggregation": {
            "enum": [
              "sum",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          }
        }
      }
    },
    "sessionId": {
      "format": "uuid",
      "type": "string"
    },
    "type": {
      "enum": [
        "import",
        "forecast",
        "impact",
        "model"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "requested",
        "started",
        "completed",
        "cancelled",
        "failed",
        "estimated"
      ],
      "type": "string"
    },
    "eventName": {
      "type": "string"
    },
    "predictionDomain": {
      "type": "string"
    },
    "modelId": {
      "format": "uuid",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "type": "string"
    },
    "resultInterval": {
      "enum": [
        "hour",
        "day",
        "week",
        "month",
        "year"
      ],
      "type": "string"
    },
    "requestedDate": {
      "format": "date-time",
      "type": "string"
    },
    "statusHistory": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "enum": [
              "requested",
              "started",
              "completed",
              "cancelled",
              "failed",
              "estimated"
            ],
            "type": "string"
          }
        }
      }
    },
    "extraParameters": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "enum": [
              "informational",
              "warning",
              "error",
              "debug"
            ],
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "dataSourceName": {
      "type": "string"
    },
    "targetColumn": {
      "type": "string"
    },
    "callbackUrl": {
      "type": "string"
    },
    "isEstimate": {
      "type": "boolean"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}
{
  "columns": {
    "timestamp": {
      "dataType": "date",
      "role": "timestamp"
    },
    "sales": {
      "dataType": "numeric",
      "role": "target"
    }
  },
  "sessionId": "03086249-3b85-4a6a-ace8-3817adf8c9aa",
  "type": "forecast",
  "status": "requested",
  "startDate": "2017-01-01T00:00:00+00:00",
  "endDate": "2017-01-05T00:00:00+00:00",
  "requestedDate": "0001-01-01T00:00:00+00:00",
  "statusHistory": [],
  "extraParameters": {},
  "messages": [],
  "dataSourceName": "Location-A.03086249-3b85-4a6a-ace8-3817adf8c9aa",
  "dataSetName": "Location-A.03086249-3b85-4a6a-ace8-3817adf8c9aa",
  "targetColumn": "sales",
  "callbackUrl": "",
  "isEstimate": false,
  "links": []
}
{
  "type": "object",
  "properties": {
    "columns": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "dataType": {
            "enum": [
              "string",
              "numeric",
              "logical",
              "date",
              "numericMeasure"
            ],
            "type": "string"
          },
          "role": {
            "enum": [
              "none",
              "timestamp",
              "target",
              "feature",
              "key"
            ],
            "type": "string"
          },
          "imputation": {
            "enum": [
              "zeroes",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          },
          "aggregation": {
            "enum": [
              "sum",
              "mean",
              "median",
              "mode",
              "min",
              "max"
            ],
            "type": "string"
          }
        }
      }
    },
    "sessionId": {
      "format": "uuid",
      "type": "string"
    },
    "type": {
      "enum": [
        "import",
        "forecast",
        "impact",
        "model"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "requested",
        "started",
        "completed",
        "cancelled",
        "failed",
        "estimated"
      ],
      "type": "string"
    },
    "eventName": {
      "type": "string"
    },
    "predictionDomain": {
      "type": "string"
    },
    "modelId": {
      "format": "uuid",
      "type": "string"
    },
    "startDate": {
      "format": "date-time",
      "type": "string"
    },
    "endDate": {
      "format": "date-time",
      "type": "string"
    },
    "resultInterval": {
      "enum": [
        "hour",
        "day",
        "week",
        "month",
        "year"
      ],
      "type": "string"
    },
    "requestedDate": {
      "format": "date-time",
      "type": "string"
    },
    "statusHistory": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "date": {
            "format": "date-time",
            "type": "string"
          },
          "status": {
            "enum": [
              "requested",
              "started",
              "completed",
              "cancelled",
              "failed",
              "estimated"
            ],
            "type": "string"
          }
        }
      }
    },
    "extraParameters": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "enum": [
              "informational",
              "warning",
              "error",
              "debug"
            ],
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "dataSourceName": {
      "type": "string"
    },
    "targetColumn": {
      "type": "string"
    },
    "callbackUrl": {
      "type": "string"
    },
    "isEstimate": {
      "type": "boolean"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}

Response 400

One or more parameter values are invalid

{
  "statusCode": 400,
  "message": "Request is invalid",
  "errorType": "RequestValidation",
  "errorDetails": {
    "startDate": [
      "Value for startDate must be a valid date"
    ]
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "statusCode": 400,
  "message": "Request is invalid",
  "errorType": "RequestValidation",
  "errorDetails": {
    "startDate": [
      "Value for startDate must be a valid date"
    ]
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://ml.nexosis.com/v1/sessions/forecast"
-H "Content-Type: application/json"
-H "api-key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("api-key", "{subscription key}");

            var uri = "https://ml.nexosis.com/v1/sessions/forecast?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://ml.nexosis.com/v1/sessions/forecast");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("api-key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://ml.nexosis.com/v1/sessions/forecast?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("api-key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://ml.nexosis.com/v1/sessions/forecast";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"api-key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://ml.nexosis.com/v1/sessions/forecast');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'api-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'api-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('ml.nexosis.com')
    conn.request("POST", "/v1/sessions/forecast?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'api-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('ml.nexosis.com')
    conn.request("POST", "/v1/sessions/forecast?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://ml.nexosis.com/v1/sessions/forecast')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['api-key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body