Nexosis Api

API change history

Datasets: Retrieve data

See also http://docs.nexosis.com/guides/retrievingdata for more details about how to retrieve your data.

Try it

Request URL

Request parameters

string

Name of the dataset for which to retrieve data

(optional)
string

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

(optional)
string

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

(optional)
integer

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

(optional)
integer

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

(optional)
array

Limits results to the specified columns

Request headers

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

Request body

Response 200

success

{
  "dataSetName": "Location-A",
  "isTimeSeries": true,
  "columns": {
    "timestamp": {
      "dataType": "date",
      "role": "timestamp"
    },
    "sales": {
      "dataType": "numeric",
      "role": "target"
    }
  },
  "data": [
    {
      "timestamp": "2013-01-01T00:00:00+00:00",
      "sales": "1500.56"
    },
    {
      "timestamp": "2013-01-02T00:00:00+00:00",
      "sales": "4078.52"
    },
    {
      "timestamp": "2013-01-03T00:00:00+00:00",
      "sales": "4545.69"
    },
    {
      "timestamp": "2013-01-04T00:00:00+00:00",
      "sales": "4872.63"
    },
    {
      "timestamp": "2013-01-05T00:00:00+00:00",
      "sales": "2420.81"
    }
  ],
  "pageNumber": 0,
  "totalPages": 0,
  "links": []
}
{
  "type": "object",
  "properties": {
    "dataSetName": {
      "type": "string"
    },
    "isTimeSeries": {
      "type": "boolean",
      "readOnly": true
    },
    "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"
          }
        }
      },
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        }
      }
    },
    "pageNumber": {
      "format": "int32",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}
{
  "dataSetName": "Location-A",
  "isTimeSeries": true,
  "columns": {
    "timestamp": {
      "dataType": "date",
      "role": "timestamp"
    },
    "sales": {
      "dataType": "numeric",
      "role": "target"
    }
  },
  "data": [
    {
      "timestamp": "2013-01-01T00:00:00+00:00",
      "sales": "1500.56"
    },
    {
      "timestamp": "2013-01-02T00:00:00+00:00",
      "sales": "4078.52"
    },
    {
      "timestamp": "2013-01-03T00:00:00+00:00",
      "sales": "4545.69"
    },
    {
      "timestamp": "2013-01-04T00:00:00+00:00",
      "sales": "4872.63"
    },
    {
      "timestamp": "2013-01-05T00:00:00+00:00",
      "sales": "2420.81"
    }
  ],
  "pageNumber": 0,
  "totalPages": 0,
  "links": []
}
{
  "type": "object",
  "properties": {
    "dataSetName": {
      "type": "string"
    },
    "isTimeSeries": {
      "type": "boolean",
      "readOnly": true
    },
    "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"
          }
        }
      },
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        }
      }
    },
    "pageNumber": {
      "format": "int32",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}
timestamp,sales
2013-01-01T00:00:00+00:00,1500.56
2013-01-02T00:00:00+00:00,4078.52
2013-01-03T00:00:00+00:00,4545.69
2013-01-04T00:00:00+00:00,4872.63
2013-01-05T00:00:00+00:00,2420.81
{
  "type": "object",
  "properties": {
    "dataSetName": {
      "type": "string"
    },
    "isTimeSeries": {
      "type": "boolean",
      "readOnly": true
    },
    "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"
          }
        }
      },
      "readOnly": true
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {
          "type": "string"
        }
      }
    },
    "pageNumber": {
      "format": "int32",
      "type": "integer"
    },
    "totalPages": {
      "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 query parameters are invalid

{
  "statusCode": 400,
  "message": "Request is invalid",
  "errorType": "RequestValidation",
  "errorDetails": {
    "page": [
      "Value for page must be a non-negative integer"
    ]
  }
}
{
  "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": {
    "page": [
      "Value for page must be a non-negative integer"
    ]
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}

Response 404

Specified dataset was not found

{
  "statusCode": 404,
  "message": "Item of type dataSet with identifier Location-A was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "dataSet",
    "itemId": "Location-A"
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "statusCode": 404,
  "message": "Item of type dataSet with identifier Location-A was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "dataSet",
    "itemId": "Location-A"
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "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/data/{dataSetName}?startDate=01/01/2013 00:00:00&endDate=01/05/2013 00:00:00&page=0&pageSize=10&include=sales"
-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["startDate"] = "01/01/2013 00:00:00";
            queryString["endDate"] = "01/05/2013 00:00:00";
            queryString["page"] = "0";
            queryString["pageSize"] = "10";
            queryString["include"] = "sales";
            var uri = "https://ml.nexosis.com/v1/data/{dataSetName}?" + 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/data/{dataSetName}");

            builder.setParameter("startDate", "01/01/2013 00:00:00");
            builder.setParameter("endDate", "01/05/2013 00:00:00");
            builder.setParameter("page", "0");
            builder.setParameter("pageSize", "10");
            builder.setParameter("include", "sales");

            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
            "startDate": "01/01/2013 00:00:00",
            "endDate": "01/05/2013 00:00:00",
            "page": "0",
            "pageSize": "10",
            "include": "sales",
        };
      
        $.ajax({
            url: "https://ml.nexosis.com/v1/data/{dataSetName}?" + $.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/data/{dataSetName}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"startDate=01/01/2013 00:00:00",
                         @"endDate=01/05/2013 00:00:00",
                         @"page=0",
                         @"pageSize=10",
                         @"include=sales",
                      ];
    
    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/data/{dataSetName}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'startDate' => '01/01/2013 00:00:00',
    'endDate' => '01/05/2013 00:00:00',
    'page' => '0',
    'pageSize' => '10',
    'include' => 'sales',
);

$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
    'startDate': '01/01/2013 00:00:00',
    'endDate': '01/05/2013 00:00:00',
    'page': '0',
    'pageSize': '10',
    'include': 'sales',
})

try:
    conn = httplib.HTTPSConnection('ml.nexosis.com')
    conn.request("GET", "/v1/data/{dataSetName}?%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
    'startDate': '01/01/2013 00:00:00',
    'endDate': '01/05/2013 00:00:00',
    'page': '0',
    'pageSize': '10',
    'include': 'sales',
})

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

query = URI.encode_www_form({
    # Request parameters
    'startDate' => '01/01/2013 00:00:00',
    'endDate' => '01/05/2013 00:00:00',
    'page' => '0',
    'pageSize' => '10',
    'include' => 'sales'
})
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