Nexosis Api

API change history

Views: List all

Gets the list of view definitions that have been created

Try it

Request URL

Request parameters

(optional)
string

Limits results to only those view definitions with names containing the specified value

(optional)
string

Limits results to only those view definitions that reference the specified dataset

(optional)
integer

Format - int32. Zero-based page number of view definitions to retrieve

(optional)
integer

Format - int32. Count of view definitions 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": [
    {
      "viewName": "LocationWithHolidays-A",
      "dataSetName": "Location-A",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "holidayName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "dataSet": {
            "name": "Holidays"
          },
          "columnOptions": {
            "holidayDate": {
              "joinInterval": "day"
            }
          }
        }
      ]
    },
    {
      "viewName": "LocationWithHolidays-B",
      "dataSetName": "Location-B",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "eventTimestamp": {
          "dataType": "date",
          "role": "none"
        },
        "calendarName": {
          "dataType": "string",
          "role": "feature"
        },
        "eventName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "calendar": {
            "name": "Nexosis.Holidays-US"
          },
          "columnOptions": {
            "eventTimestamp": {
              "joinInterval": "day"
            }
          }
        }
      ]
    },
    {
      "viewName": "LocationWithHolidays-C",
      "dataSetName": "Location-C",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "holidayName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "dataSet": {
            "name": "Holidays"
          },
          "columnOptions": {
            "holidayDate": {
              "joinInterval": "day"
            }
          }
        }
      ]
    },
    {
      "viewName": "LocationWithHolidays-D",
      "dataSetName": "Location-D",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "holidayName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "dataSet": {
            "name": "Holidays"
          },
          "columnOptions": {
            "holidayDate": {
              "joinInterval": "day"
            }
          }
        }
      ]
    }
  ]
}
{
  "items": [
    {
      "viewName": "LocationWithHolidays-A",
      "dataSetName": "Location-A",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "holidayName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "dataSet": {
            "name": "Holidays"
          },
          "columnOptions": {
            "holidayDate": {
              "joinInterval": "day"
            }
          }
        }
      ]
    },
    {
      "viewName": "LocationWithHolidays-B",
      "dataSetName": "Location-B",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "eventTimestamp": {
          "dataType": "date",
          "role": "none"
        },
        "calendarName": {
          "dataType": "string",
          "role": "feature"
        },
        "eventName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "calendar": {
            "name": "Nexosis.Holidays-US"
          },
          "columnOptions": {
            "eventTimestamp": {
              "joinInterval": "day"
            }
          }
        }
      ]
    },
    {
      "viewName": "LocationWithHolidays-C",
      "dataSetName": "Location-C",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "holidayName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "dataSet": {
            "name": "Holidays"
          },
          "columnOptions": {
            "holidayDate": {
              "joinInterval": "day"
            }
          }
        }
      ]
    },
    {
      "viewName": "LocationWithHolidays-D",
      "dataSetName": "Location-D",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "holidayName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "dataSet": {
            "name": "Holidays"
          },
          "columnOptions": {
            "holidayDate": {
              "joinInterval": "day"
            }
          }
        }
      ]
    }
  ]
}
{
  "items": [
    {
      "viewName": "LocationWithHolidays-A",
      "dataSetName": "Location-A",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "holidayName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "dataSet": {
            "name": "Holidays"
          },
          "columnOptions": {
            "holidayDate": {
              "joinInterval": "day"
            }
          }
        }
      ]
    },
    {
      "viewName": "LocationWithHolidays-B",
      "dataSetName": "Location-B",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "eventTimestamp": {
          "dataType": "date",
          "role": "none"
        },
        "calendarName": {
          "dataType": "string",
          "role": "feature"
        },
        "eventName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "calendar": {
            "name": "Nexosis.Holidays-US"
          },
          "columnOptions": {
            "eventTimestamp": {
              "joinInterval": "day"
            }
          }
        }
      ]
    },
    {
      "viewName": "LocationWithHolidays-C",
      "dataSetName": "Location-C",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "holidayName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "dataSet": {
            "name": "Holidays"
          },
          "columnOptions": {
            "holidayDate": {
              "joinInterval": "day"
            }
          }
        }
      ]
    },
    {
      "viewName": "LocationWithHolidays-D",
      "dataSetName": "Location-D",
      "columns": {
        "timestamp": {
          "dataType": "date",
          "role": "timestamp"
        },
        "sales": {
          "dataType": "numeric",
          "role": "target"
        },
        "transactions": {
          "dataType": "numeric",
          "role": "none"
        },
        "holidayName": {
          "dataType": "string",
          "role": "feature"
        }
      },
      "joins": [
        {
          "dataSet": {
            "name": "Holidays"
          },
          "columnOptions": {
            "holidayDate": {
              "joinInterval": "day"
            }
          }
        }
      ]
    }
  ]
}

Response 400

One or more query parameters are invalid

{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "statusCode": 0,
  "message": "string",
  "errorType": "string",
  "errorDetails": {}
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}
{
  "statusCode": 0,
  "message": "string",
  "errorType": "string",
  "errorDetails": {}
}
{
  "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/views?partialName=LocationWithHolidays&dataSetName={string}&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["partialName"] = "LocationWithHolidays";
            queryString["dataSetName"] = "{string}";
            queryString["page"] = "{integer}";
            queryString["pageSize"] = "{integer}";
            var uri = "https://ml.nexosis.com/v1/views?" + 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/views");

            builder.setParameter("partialName", "LocationWithHolidays");
            builder.setParameter("dataSetName", "{string}");
            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
            "partialName": "LocationWithHolidays",
            "dataSetName": "{string}",
            "page": "{integer}",
            "pageSize": "{integer}",
        };
      
        $.ajax({
            url: "https://ml.nexosis.com/v1/views?" + $.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/views";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"partialName=LocationWithHolidays",
                         @"dataSetName={string}",
                         @"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/views');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'partialName' => 'LocationWithHolidays',
    'dataSetName' => '{string}',
    '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
    'partialName': 'LocationWithHolidays',
    'dataSetName': '{string}',
    'page': '{integer}',
    'pageSize': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('ml.nexosis.com')
    conn.request("GET", "/v1/views?%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
    'partialName': 'LocationWithHolidays',
    'dataSetName': '{string}',
    'page': '{integer}',
    'pageSize': '{integer}',
})

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

query = URI.encode_www_form({
    # Request parameters
    'partialName' => 'LocationWithHolidays',
    'dataSetName' => '{string}',
    '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