Nexosis Api

API change history

Sessions: List all

Lists the sessions that have been created for the company associated with your account

Try it

Request URL

Request parameters

(optional)
string

Limits sessions to those for a particular data source

(optional)
string

Limits impact sessions to those for a particular event

(optional)
string

Format - uuid. Limits model-building sessions to those that built the specified model

(optional)
string

Format - date-time (as date-time in ISO8601). Limits sessions to those requested on or after the specified date

(optional)
string

Format - date-time (as date-time in ISO8601). Limits sessions to those requested on or before the specified date

(optional)
integer

Format - int32. Zero-based page number of sessions to retrieve

(optional)
integer

Format - int32. Count of sessions to retrieve in each page (max 1000)

Request headers

string
Subscription key which provides access to this API. Found in your Profile.

Request body

Response 200

success

{
  "items": [
    {
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "none"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "target"
        }
      },
      "sessionId": "c01700dc-7cc7-4d3f-b0f9-969bcd78bf97",
      "type": "forecast",
      "status": "completed",
      "startDate": "2017-01-01T00:00:00+00:00",
      "endDate": "2017-12-31T00:00:00+00:00",
      "requestedDate": "2017-06-30T00:00:00+00:00",
      "statusHistory": [],
      "extraParameters": {},
      "messages": [],
      "dataSourceName": "Location-C",
      "dataSetName": "Location-C",
      "targetColumn": "transactions",
      "callbackUrl": "",
      "links": []
    },
    {
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        }
      },
      "sessionId": "8dc7b499-c287-43e1-be66-92cb16512566",
      "type": "forecast",
      "status": "started",
      "startDate": "2017-01-01T00:00:00+00:00",
      "endDate": "2017-12-31T00:00:00+00:00",
      "requestedDate": "2017-06-30T00:00:00+00:00",
      "statusHistory": [],
      "extraParameters": {},
      "messages": [],
      "dataSourceName": "Location-A",
      "dataSetName": "Location-A",
      "targetColumn": "sales",
      "callbackUrl": "",
      "links": []
    },
    {
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "none"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "target"
        }
      },
      "sessionId": "19359e90-02a4-4952-aa54-90d96bfaf98f",
      "type": "impact",
      "status": "requested",
      "startDate": "2017-01-01T00:00:00+00:00",
      "endDate": "2017-12-31T00:00:00+00:00",
      "requestedDate": "2017-06-30T00:00:00+00:00",
      "statusHistory": [],
      "extraParameters": {},
      "messages": [],
      "dataSourceName": "Location-D",
      "dataSetName": "Location-D",
      "targetColumn": "transactions",
      "callbackUrl": "",
      "links": []
    }
  ],
  "pageNumber": 0,
  "totalPages": 0,
  "pageSize": 0,
  "totalCount": 0,
  "links": []
}
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "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"
          },
          "availablePredictionIntervals": {
            "type": "array",
            "items": {
              "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",
            "properties": {
              "event": {
                "type": "string"
              },
              "balance": {
                "type": "boolean"
              }
            }
          },
          "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"
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "rel": {
                  "type": "string",
                  "readOnly": true
                },
                "href": {
                  "type": "string",
                  "readOnly": true
                }
              }
            },
            "readOnly": true
          }
        }
      }
    },
    "pageNumber": {
      "format": "int32",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    },
    "pageSize": {
      "format": "int32",
      "type": "integer"
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}
{
  "items": [
    {
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "none"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "target"
        }
      },
      "sessionId": "c01700dc-7cc7-4d3f-b0f9-969bcd78bf97",
      "type": "forecast",
      "status": "completed",
      "startDate": "2017-01-01T00:00:00+00:00",
      "endDate": "2017-12-31T00:00:00+00:00",
      "requestedDate": "2017-06-30T00:00:00+00:00",
      "statusHistory": [],
      "extraParameters": {},
      "messages": [],
      "dataSourceName": "Location-C",
      "dataSetName": "Location-C",
      "targetColumn": "transactions",
      "callbackUrl": "",
      "links": []
    },
    {
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        }
      },
      "sessionId": "8dc7b499-c287-43e1-be66-92cb16512566",
      "type": "forecast",
      "status": "started",
      "startDate": "2017-01-01T00:00:00+00:00",
      "endDate": "2017-12-31T00:00:00+00:00",
      "requestedDate": "2017-06-30T00:00:00+00:00",
      "statusHistory": [],
      "extraParameters": {},
      "messages": [],
      "dataSourceName": "Location-A",
      "dataSetName": "Location-A",
      "targetColumn": "sales",
      "callbackUrl": "",
      "links": []
    },
    {
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "none"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "target"
        }
      },
      "sessionId": "19359e90-02a4-4952-aa54-90d96bfaf98f",
      "type": "impact",
      "status": "requested",
      "startDate": "2017-01-01T00:00:00+00:00",
      "endDate": "2017-12-31T00:00:00+00:00",
      "requestedDate": "2017-06-30T00:00:00+00:00",
      "statusHistory": [],
      "extraParameters": {},
      "messages": [],
      "dataSourceName": "Location-D",
      "dataSetName": "Location-D",
      "targetColumn": "transactions",
      "callbackUrl": "",
      "links": []
    }
  ],
  "pageNumber": 0,
  "totalPages": 0,
  "pageSize": 0,
  "totalCount": 0,
  "links": []
}
{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "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"
          },
          "availablePredictionIntervals": {
            "type": "array",
            "items": {
              "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",
            "properties": {
              "event": {
                "type": "string"
              },
              "balance": {
                "type": "boolean"
              }
            }
          },
          "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"
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "rel": {
                  "type": "string",
                  "readOnly": true
                },
                "href": {
                  "type": "string",
                  "readOnly": true
                }
              }
            },
            "readOnly": true
          }
        }
      }
    },
    "pageNumber": {
      "format": "int32",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    },
    "pageSize": {
      "format": "int32",
      "type": "integer"
    },
    "totalCount": {
      "format": "int32",
      "type": "integer"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}

Response 400

One or more parameters are invalid

{
  "statusCode": 400,
  "message": "Request is invalid",
  "errorType": "RequestValidation",
  "errorDetails": {
    "requestedAfterDate": [
      "Value for requestedAfterDate 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": {
    "requestedAfterDate": [
      "Value for requestedAfterDate 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 GET "https://ml.nexosis.com/v1/sessions?dataSourceName=Location&eventName={string}&modelId={string}&requestedAfterDate=05/15/2017 00:00:00&requestedBeforeDate=06/01/2017 00:00:00&page={integer}&pageSize={integer}"
-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}");

            // Request parameters
            queryString["dataSourceName"] = "Location";
            queryString["eventName"] = "{string}";
            queryString["modelId"] = "{string}";
            queryString["requestedAfterDate"] = "05/15/2017 00:00:00";
            queryString["requestedBeforeDate"] = "06/01/2017 00:00:00";
            queryString["page"] = "{integer}";
            queryString["pageSize"] = "{integer}";
            var uri = "https://ml.nexosis.com/v1/sessions?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // 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");

            builder.setParameter("dataSourceName", "Location");
            builder.setParameter("eventName", "{string}");
            builder.setParameter("modelId", "{string}");
            builder.setParameter("requestedAfterDate", "05/15/2017 00:00:00");
            builder.setParameter("requestedBeforeDate", "06/01/2017 00:00:00");
            builder.setParameter("page", "{integer}");
            builder.setParameter("pageSize", "{integer}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            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
            "dataSourceName": "Location",
            "eventName": "{string}",
            "modelId": "{string}",
            "requestedAfterDate": "05/15/2017 00:00:00",
            "requestedBeforeDate": "06/01/2017 00:00:00",
            "page": "{integer}",
            "pageSize": "{integer}",
        };
      
        $.ajax({
            url: "https://ml.nexosis.com/v1/sessions?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("api-key","{subscription key}");
            },
            type: "GET",
            // 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";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"dataSourceName=Location",
                         @"eventName={string}",
                         @"modelId={string}",
                         @"requestedAfterDate=05/15/2017 00:00:00",
                         @"requestedBeforeDate=06/01/2017 00:00:00",
                         @"page={integer}",
                         @"pageSize={integer}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_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');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'dataSourceName' => 'Location',
    'eventName' => '{string}',
    'modelId' => '{string}',
    'requestedAfterDate' => '05/15/2017 00:00:00',
    'requestedBeforeDate' => '06/01/2017 00:00:00',
    'page' => '{integer}',
    'pageSize' => '{integer}',
);

$url->setQueryVariables($parameters);

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

// 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
    'api-key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'dataSourceName': 'Location',
    'eventName': '{string}',
    'modelId': '{string}',
    'requestedAfterDate': '05/15/2017 00:00:00',
    'requestedBeforeDate': '06/01/2017 00:00:00',
    'page': '{integer}',
    'pageSize': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('ml.nexosis.com')
    conn.request("GET", "/v1/sessions?%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
    'api-key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'dataSourceName': 'Location',
    'eventName': '{string}',
    'modelId': '{string}',
    'requestedAfterDate': '05/15/2017 00:00:00',
    'requestedBeforeDate': '06/01/2017 00:00:00',
    'page': '{integer}',
    'pageSize': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('ml.nexosis.com')
    conn.request("GET", "/v1/sessions?%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')

query = URI.encode_www_form({
    # Request parameters
    'dataSourceName' => 'Location',
    'eventName' => '{string}',
    'modelId' => '{string}',
    'requestedAfterDate' => '05/15/2017 00:00:00',
    'requestedBeforeDate' => '06/01/2017 00:00:00',
    'page' => '{integer}',
    'pageSize' => '{integer}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# 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