Nexosis Api

API change history

Session Contests: Retrieve contest

Gets detailed data science information generated by a session

During the execution of a session, many different algorithms can be run, in order to see which algorithm produces the best results. The contest information returned from this endpoint contains details about all of the algorithms that were attempted, which one is the champion, and various scoring metrics which were used to determine the best algorithm. Note: This endpoint is not available under the community plan. Please upgrade to a paid plan if you are currently on Community. Be sure to use the Paid Subscription key if you have already upgraded.

Try it

Request URL

Request parameters

string

Format - uuid. Session identifier for which to retrieve contest details

Request headers

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

Request body

Response 200

Success

{
  "championMetric": "meanAbsoluteError",
  "champion": {
    "id": "c6aba2c7-491d-40ba-8077-1ca16fea46ab",
    "algorithm": {
      "name": "Elastic Net Regularization",
      "description": "Elastic Net Regularization"
    },
    "dataSourceProperties": [
      "Imputed",
      "Scaled"
    ],
    "metrics": {
      "meanAbsoluteError": 51895.805070633738,
      "meanAbsolutePercentError": 0.19719907591837024,
      "rootMeanSquareError": 67804.923361109948
    },
    "links": []
  },
  "contestants": [
    {
      "id": "dfc93da3-0879-43d0-a37e-e6ba546b51de",
      "algorithm": {
        "name": "SVR Linear",
        "description": "Support Vector Regression using Linear Kernel"
      },
      "dataSourceProperties": [
        "Imputed",
        "Scaled"
      ],
      "metrics": {
        "meanAbsoluteError": 52140.514522783051,
        "meanAbsolutePercentError": 0.19813899348553454,
        "rootMeanSquareError": 68120.019168145329
      },
      "links": []
    }
  ],
  "sessionId": "25ea0b7f-4792-464a-a1f9-7e527a295adf",
  "type": "model",
  "status": "completed",
  "predictionDomain": "regression",
  "supportsFeatureImportance": false,
  "modelId": "715663d7-de67-4593-8dec-3c8fdf226b08",
  "requestedDate": "0001-01-01T00:00:00+00:00",
  "statusHistory": [],
  "extraParameters": {},
  "messages": [],
  "dataSourceName": "HousingData",
  "dataSetName": "HousingData",
  "targetColumn": "SalePrice",
  "callbackUrl": "",
  "isEstimate": false,
  "links": []
}
{
  "type": "object",
  "properties": {
    "championMetric": {
      "type": "string"
    },
    "champion": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "type": "string"
        },
        "algorithm": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "key": {
              "type": "string"
            }
          }
        },
        "dataSourceProperties": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "metrics": {
          "type": "object",
          "additionalProperties": {
            "format": "double",
            "type": "number"
          }
        },
        "algorithmFeatureImportance": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "type": "number"
              },
              "error": {
                "format": "double",
                "type": "number"
              },
              "pValue": {
                "format": "double",
                "type": "number"
              },
              "inclusionProbability": {
                "format": "double",
                "type": "number"
              }
            }
          }
        },
        "links": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "rel": {
                "type": "string",
                "readOnly": true
              },
              "href": {
                "type": "string",
                "readOnly": true
              }
            }
          },
          "readOnly": true
        }
      }
    },
    "contestants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "algorithm": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "key": {
                "type": "string"
              }
            }
          },
          "dataSourceProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "metrics": {
            "type": "object",
            "additionalProperties": {
              "format": "double",
              "type": "number"
            }
          },
          "algorithmFeatureImportance": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "properties": {
                "value": {
                  "format": "double",
                  "type": "number"
                },
                "error": {
                  "format": "double",
                  "type": "number"
                },
                "pValue": {
                  "format": "double",
                  "type": "number"
                },
                "inclusionProbability": {
                  "format": "double",
                  "type": "number"
                }
              }
            }
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "rel": {
                  "type": "string",
                  "readOnly": true
                },
                "href": {
                  "type": "string",
                  "readOnly": true
                }
              }
            },
            "readOnly": true
          }
        }
      }
    },
    "sessionId": {
      "format": "uuid",
      "type": "string"
    },
    "type": {
      "enum": [
        "import",
        "forecast",
        "impact",
        "model"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "requested",
        "started",
        "completed",
        "cancelled",
        "failed",
        "estimated",
        "cancellationPending"
      ],
      "type": "string"
    },
    "eventName": {
      "type": "string"
    },
    "predictionDomain": {
      "type": "string"
    },
    "supportsFeatureImportance": {
      "type": "boolean"
    },
    "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",
              "cancellationPending"
            ],
            "type": "string"
          }
        }
      }
    },
    "extraParameters": {
      "type": "object",
      "properties": {
        "event": {
          "type": "string"
        },
        "balance": {
          "type": "boolean"
        },
        "containsAnomalies": {
          "type": "boolean"
        }
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "enum": [
              "informational",
              "warning",
              "error",
              "status",
              "debug"
            ],
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "name": {
      "type": "string"
    },
    "dataSourceName": {
      "type": "string"
    },
    "targetColumn": {
      "type": "string"
    },
    "algorithm": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "key": {
          "type": "string"
        }
      }
    },
    "callbackUrl": {
      "type": "string"
    },
    "missingValues": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "rel": {
            "type": "string",
            "readOnly": true
          },
          "href": {
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    }
  }
}
{
  "championMetric": "meanAbsoluteError",
  "champion": {
    "id": "c6aba2c7-491d-40ba-8077-1ca16fea46ab",
    "algorithm": {
      "name": "Elastic Net Regularization",
      "description": "Elastic Net Regularization"
    },
    "dataSourceProperties": [
      "Imputed",
      "Scaled"
    ],
    "metrics": {
      "meanAbsoluteError": 51895.805070633738,
      "meanAbsolutePercentError": 0.19719907591837024,
      "rootMeanSquareError": 67804.923361109948
    },
    "links": []
  },
  "contestants": [
    {
      "id": "dfc93da3-0879-43d0-a37e-e6ba546b51de",
      "algorithm": {
        "name": "SVR Linear",
        "description": "Support Vector Regression using Linear Kernel"
      },
      "dataSourceProperties": [
        "Imputed",
        "Scaled"
      ],
      "metrics": {
        "meanAbsoluteError": 52140.514522783051,
        "meanAbsolutePercentError": 0.19813899348553454,
        "rootMeanSquareError": 68120.019168145329
      },
      "links": []
    }
  ],
  "sessionId": "25ea0b7f-4792-464a-a1f9-7e527a295adf",
  "type": "model",
  "status": "completed",
  "predictionDomain": "regression",
  "supportsFeatureImportance": false,
  "modelId": "715663d7-de67-4593-8dec-3c8fdf226b08",
  "requestedDate": "0001-01-01T00:00:00+00:00",
  "statusHistory": [],
  "extraParameters": {},
  "messages": [],
  "dataSourceName": "HousingData",
  "dataSetName": "HousingData",
  "targetColumn": "SalePrice",
  "callbackUrl": "",
  "isEstimate": false,
  "links": []
}
{
  "type": "object",
  "properties": {
    "championMetric": {
      "type": "string"
    },
    "champion": {
      "type": "object",
      "properties": {
        "id": {
          "format": "uuid",
          "type": "string"
        },
        "algorithm": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string"
            },
            "description": {
              "type": "string"
            },
            "key": {
              "type": "string"
            }
          }
        },
        "dataSourceProperties": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "metrics": {
          "type": "object",
          "additionalProperties": {
            "format": "double",
            "type": "number"
          }
        },
        "algorithmFeatureImportance": {
          "type": "object",
          "additionalProperties": {
            "type": "object",
            "properties": {
              "value": {
                "format": "double",
                "type": "number"
              },
              "error": {
                "format": "double",
                "type": "number"
              },
              "pValue": {
                "format": "double",
                "type": "number"
              },
              "inclusionProbability": {
                "format": "double",
                "type": "number"
              }
            }
          }
        },
        "links": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "rel": {
                "type": "string",
                "readOnly": true
              },
              "href": {
                "type": "string",
                "readOnly": true
              }
            }
          },
          "readOnly": true
        }
      }
    },
    "contestants": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "format": "uuid",
            "type": "string"
          },
          "algorithm": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "description": {
                "type": "string"
              },
              "key": {
                "type": "string"
              }
            }
          },
          "dataSourceProperties": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "metrics": {
            "type": "object",
            "additionalProperties": {
              "format": "double",
              "type": "number"
            }
          },
          "algorithmFeatureImportance": {
            "type": "object",
            "additionalProperties": {
              "type": "object",
              "properties": {
                "value": {
                  "format": "double",
                  "type": "number"
                },
                "error": {
                  "format": "double",
                  "type": "number"
                },
                "pValue": {
                  "format": "double",
                  "type": "number"
                },
                "inclusionProbability": {
                  "format": "double",
                  "type": "number"
                }
              }
            }
          },
          "links": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "rel": {
                  "type": "string",
                  "readOnly": true
                },
                "href": {
                  "type": "string",
                  "readOnly": true
                }
              }
            },
            "readOnly": true
          }
        }
      }
    },
    "sessionId": {
      "format": "uuid",
      "type": "string"
    },
    "type": {
      "enum": [
        "import",
        "forecast",
        "impact",
        "model"
      ],
      "type": "string"
    },
    "status": {
      "enum": [
        "requested",
        "started",
        "completed",
        "cancelled",
        "failed",
        "estimated",
        "cancellationPending"
      ],
      "type": "string"
    },
    "eventName": {
      "type": "string"
    },
    "predictionDomain": {
      "type": "string"
    },
    "supportsFeatureImportance": {
      "type": "boolean"
    },
    "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",
              "cancellationPending"
            ],
            "type": "string"
          }
        }
      }
    },
    "extraParameters": {
      "type": "object",
      "properties": {
        "event": {
          "type": "string"
        },
        "balance": {
          "type": "boolean"
        },
        "containsAnomalies": {
          "type": "boolean"
        }
      }
    },
    "messages": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "enum": [
              "informational",
              "warning",
              "error",
              "status",
              "debug"
            ],
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    },
    "name": {
      "type": "string"
    },
    "dataSourceName": {
      "type": "string"
    },
    "targetColumn": {
      "type": "string"
    },
    "algorithm": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "key": {
          "type": "string"
        }
      }
    },
    "callbackUrl": {
      "type": "string"
    },
    "missingValues": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "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": {
    "sessionId": [
      "Value for sessionId must be a valid GUID"
    ]
  }
}
{
  "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": {
    "sessionId": [
      "Value for sessionId must be a valid GUID"
    ]
  }
}
{
  "type": "object",
  "properties": {
    "statusCode": {
      "format": "int32",
      "type": "integer"
    },
    "message": {
      "type": "string"
    },
    "errorType": {
      "type": "string"
    },
    "errorDetails": {
      "type": "object",
      "additionalProperties": {
        "type": "object"
      }
    }
  }
}

Response 404

notfound

{
  "statusCode": 404,
  "message": "Item of type session with identifier 25ea0b7f-4792-464a-a1f9-7e527a295adf was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "session",
    "itemId": "25ea0b7f-4792-464a-a1f9-7e527a295adf"
  }
}
{
  "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 session with identifier 25ea0b7f-4792-464a-a1f9-7e527a295adf was not found",
  "errorType": "NotFound",
  "errorDetails": {
    "itemType": "session",
    "itemId": "25ea0b7f-4792-464a-a1f9-7e527a295adf"
  }
}
{
  "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/{sessionId}/contest"
-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/{sessionId}/contest?" + 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/{sessionId}/contest");


            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
        };
      
        $.ajax({
            url: "https://ml.nexosis.com/v1/sessions/{sessionId}/contest?" + $.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/{sessionId}/contest";
    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:@"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/{sessionId}/contest');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

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

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


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