Uid Enrichment

View as Markdown

Create and manage data import and export jobs.

UidEnrichment: Create job

POSThttps://api.lytics.io/v2/job/uid-enrichment

Create a UidEnrichment 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.email_fieldoptionalstring

Select Lytics user email field that will be mapped to the Unified ID 2.0. Only one of **Email Field** or **Email Hash Field (SHA 256)** or **Phone Field** or **Phone Hash Field (SHA 256)** must be selected.

config.email_hash_fieldoptionalstring

Select Lytics user email hash field that will be mapped to the Unified ID 2.0. Only one of **Email Field** or **Email Hash Field (SHA 256)** or **Phone Field** or **Phone Hash Field (SHA 256)** must be selected.

config.phone_fieldoptionalstring

Select Lytics user phone field that will be mapped to the Unified ID 2.0. Only one of **Email Field** or **Email Hash Field (SHA 256)** or **Phone Field** or **Phone Hash Field (SHA 256)** must be selected.

config.phone_hash_fieldoptionalstring

Select Lytics user phone hash field that will be mapped to the Unified ID 2.0. Only one of **Email Field** or **Email Hash Field (SHA 256)** or **Phone Field** or **Phone Hash Field (SHA 256)** must be selected.

config.segment_idoptionalstring

config.segment_idsoptionalstring[]

config.unified_enrich_streamoptionalstring

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": {
    "email_field": "string",
    "email_hash_field": "string",
    "phone_field": "string",
    "phone_hash_field": "string",
    "segment_id": "string",
    "segment_ids": [
      "string"
    ],
    "unified_enrich_stream": "string"
  },
  "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": {
      "email_field": "string",
      "email_hash_field": "string",
      "phone_field": "string",
      "phone_hash_field": "string",
      "segment_id": "string",
      "segment_ids": [
        "string"
      ],
      "unified_enrich_stream": "string"
    },
    "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
}

UidEnrichment: Get job

GEThttps://api.lytics.io/v2/job/uid-enrichment/{id}

UidEnrichment: Update job

PUThttps://api.lytics.io/v2/job/uid-enrichment/{id}

{ "auth_ids": [ "string" ], "config": { "email_field": "string", "email_hash_field": "string", "phone_field": "string", "phone_hash_field": "string", "segment_id": "string", "segment_ids": [ "string" ], "unified_enrich_stream": "string" }, "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": { "email_field": "string", "email_hash_field": "string", "phone_field": "string", "phone_hash_field": "string", "segment_id": "string", "segment_ids": [ "string" ], "unified_enrich_stream": "string" }, "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 }

Uid Enrichment

UidEnrichment: Create job

Query Parameters

Headers

Body Parameters

UidEnrichment: Get job

UidEnrichment: Update job

Uid Enrichment

UidEnrichment: Create job

Query Parameters

Headers

Body Parameters

UidEnrichment: Get job

UidEnrichment: 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