Lytics Seg Model

View as Markdown

Create and manage data import and export jobs.

LyticsSegModel: Create job

POSThttps://api.lytics.io/v2/job/lytics-seg-model

Create a LyticsSegModel job

Hide Parameters

Query Parameters

account_idoptionalstring

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

Headers

Authorizationoptionalstring

Body Parameters

auth_idsoptionalstring[]

Authorization IDs associated with the Job

configrequiredobject

Job configuration, unique per-workflow

config.additional_fieldsoptionalstring[]

Additional fields to use as model features

config.auto_tuneoptionalboolean

Use [Lytics Auto Tune](https://www.contentstack.com/docs/lytics/improving-lookalike-models#improving-unhealthy-models) to expand feature candidates to all available user fields

config.blocked_fieldsoptionalstring[]

Blocked fields to omit as model features

config.custom_segment_idsoptionalstring[]

Select any segments to add to the model as features

config.hiddenoptionalboolean

Hide the model from the UI

config.max_roundsoptionalinteger

"The number of rounds to iterate on the model (only for GBM types)"

config.model_nameoptionalstring

Enter a custom model name; if no name is provided, the source and target slug names will be used

config.model_onlyoptionalboolean

Check to build a sample model without deploying to all users

config.model_typeoptionalstring

Algorithm to use for model training

config.num_to_trainoptionalinteger

Size of the sample to use for model training

config.re_runoptionalboolean

Check to continuously re-train the model

config.sourceoptionalstring

Choose the audience to use for the source (seed) segment

config.tagsoptionalstring[]

Tags to apply to a model for organizational purposes

config.targetoptionalstring

Choose the audience to use for the target segment

config.use_contentoptionalboolean

Check to use content affinity in the model

config.use_scoresoptionalboolean

Check to use behavioral scores in the model

descriptionoptionalstring

A user-defined description

drop_events_during_quiet_windowoptionalboolean

expires_atoptionalstring (date-time)

monitoringoptionalobject

Inline monitoring config. On write: omit to keep, null to clear, or a config to set.

namerequiredstring

A user-defined name

quiet_periodoptionalinteger

quiet_time_of_dayoptionalstring

quiet_timezoneoptionalstring

Sample Request

{
  "auth_ids": [
    "string"
  ],
  "config": {
    "additional_fields": [
      "string"
    ],
    "auto_tune": true,
    "blocked_fields": [
      "string"
    ],
    "custom_segment_ids": [
      "string"
    ],
    "hidden": true,
    "max_rounds": 0,
    "model_name": "string",
    "model_only": true,
    "model_type": "string",
    "num_to_train": 0,
    "re_run": true,
    "source": "string",
    "tags": [
      "string"
    ],
    "target": "string",
    "use_content": true,
    "use_scores": true
  },
  "description": "string",
  "drop_events_during_quiet_window": true,
  "expires_at": "2019-08-24T14:15:22Z",
  "monitoring": {},
  "name": "string",
  "quiet_period": 0,
  "quiet_time_of_day": "string",
  "quiet_timezone": "string"
}

Sample Response

Status|201 Created

{
  "_meta": {},
  "data": {
    "account_id": "string",
    "anomaly_rule": {
      "aid": 0,
      "checks": [
        {
          "allowable_violations": 0,
          "interval": "string",
          "lookback_count": 0,
          "max_threshold": 0,
          "metric_type": "string",
          "min_threshold": 0,
          "type": "string",
          "variance_pct": 0
        }
      ],
      "created": "string",
      "id": "string",
      "subject_id": "string",
      "subject_type": "string",
      "updated": "string"
    },
    "api_token_auth_id": "string",
    "auth_ids": [
      "string"
    ],
    "config": {
      "additional_fields": [
        "string"
      ],
      "auto_tune": true,
      "blocked_fields": [
        "string"
      ],
      "custom_segment_ids": [
        "string"
      ],
      "hidden": true,
      "max_rounds": 0,
      "model_name": "string",
      "model_only": true,
      "model_type": "string",
      "num_to_train": 0,
      "re_run": true,
      "source": "string",
      "tags": [
        "string"
      ],
      "target": "string",
      "use_content": true,
      "use_scores": true
    },
    "created": "string",
    "deleted": true,
    "description": "string",
    "drop_events_during_quiet_window": true,
    "expires_at": "2019-08-24T14:15:22Z",
    "id": "string",
    "meta": {},
    "monitoring": {},
    "name": "string",
    "quiet_period": 0,
    "quiet_time_of_day": "string",
    "quiet_timezone": "string",
    "sleep_until": "string",
    "status": "runnable",
    "updated": "string",
    "user_id": "string",
    "workflow": "string",
    "workflow_id": "string"
  },
  "request_id": "string",
  "status": 0
}

LyticsSegModel: Get job

GEThttps://api.lytics.io/v2/job/lytics-seg-model/{id}

LyticsSegModel: Update job

PUThttps://api.lytics.io/v2/job/lytics-seg-model/{id}

{ "auth_ids": [ "string" ], "config": { "additional_fields": [ "string" ], "auto_tune": true, "blocked_fields": [ "string" ], "custom_segment_ids": [ "string" ], "hidden": true, "max_rounds": 0, "model_name": "string", "model_only": true, "model_type": "string", "num_to_train": 0, "re_run": true, "source": "string", "tags": [ "string" ], "target": "string", "use_content": true, "use_scores": true }, "description": "string", "drop_events_during_quiet_window": true, "expires_at": "2019-08-24T14:15:22Z", "monitoring": {}, "name": "string", "quiet_period": 0, "quiet_time_of_day": "string", "quiet_timezone": "string" }

{ "_meta": {}, "data": { "account_id": "string", "anomaly_rule": { "aid": 0, "checks": [ { "allowable_violations": 0, "interval": "string", "lookback_count": 0, "max_threshold": 0, "metric_type": "string", "min_threshold": 0, "type": "string", "variance_pct": 0 } ], "created": "string", "id": "string", "subject_id": "string", "subject_type": "string", "updated": "string" }, "api_token_auth_id": "string", "auth_ids": [ "string" ], "config": { "additional_fields": [ "string" ], "auto_tune": true, "blocked_fields": [ "string" ], "custom_segment_ids": [ "string" ], "hidden": true, "max_rounds": 0, "model_name": "string", "model_only": true, "model_type": "string", "num_to_train": 0, "re_run": true, "source": "string", "tags": [ "string" ], "target": "string", "use_content": true, "use_scores": true }, "created": "string", "deleted": true, "description": "string", "drop_events_during_quiet_window": true, "expires_at": "2019-08-24T14:15:22Z", "id": "string", "meta": {}, "monitoring": {}, "name": "string", "quiet_period": 0, "quiet_time_of_day": "string", "quiet_timezone": "string", "sleep_until": "string", "status": "runnable", "updated": "string", "user_id": "string", "workflow": "string", "workflow_id": "string" }, "request_id": "string", "status": 0 }

Lytics Seg Model

LyticsSegModel: Create job

Query Parameters

Headers

Body Parameters

LyticsSegModel: Get job

LyticsSegModel: Update job

Lytics Seg Model

LyticsSegModel: Create job

Query Parameters

Headers

Body Parameters

LyticsSegModel: Get job

LyticsSegModel: Update job

URL Parameters

Query Parameters

Headers

URL Parameters

Query Parameters

Headers

Body Parameters

URL Parameters

Query Parameters

Headers

URL Parameters

Query Parameters

Headers

Body Parameters