LYlytics
ML Models

Post ML Model

Changed on

Create an ML Model

post/ml

Request

  • Base URL
    https://api.lytics.io/v2
  • URL
    https://api.lytics.io/v2/ml
  • Auth
    API key in header Authorization

Query parameters

account_idstring

The account ID. Defaults to the user's default account.

Request body */*

additional_dataobject
aidinteger
author_idstring

Creator of the model

createdstring

Created timestamp

descriptionstring

Description for the model

errorstring

Error from model training; set to nil if no error or "building" if model is still training

hiddenboolean

Model is hidden from the UI

idstring

ID of the model

is_activeboolean

Has model been promoted and deployed to users

is_healthyboolean

Model health

labelstring

Label for the model

namestring

Name of the model

sourcestring

Source segment ID of the model

statestring

State of the model, "complete", "building", or "invalid"

targetstring

Target segment ID of the model

typestring

Model algorithm chosen from automatic tuning; random forest (rf), logistic regression (lr), or gradient boosting machine (gbm)

updatedstring

Updated timestamp for re-training

work_idsstring[]

Work IDs of the model; presence of multiple usually indicates an eval-only work, thus the model has been deployed at one point

Response

ML Model Response

_metaobject

Response Metadata

request_idstring
statusinteger

HTTP Status Code

Changes