Localytics Export Audience

View as Markdown

Create and manage data import and export jobs.

LocalyticsExportAudience: Create job

POSThttps://api.lytics.io/v2/job/localytics-export-audience

Create a LocalyticsExportAudience 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.app_idoptionalstring

Select the Localytics app to send your Lytics audiences to

config.attributesoptionalstring[]

Select the field in the Lytics audience user that you would like to send as Localytics profile attributes

config.audience_membershipoptionalboolean

Check to send Lytics audience membership as an attribute of Localytics profile. Checking this will create a set attribute in Localytics with name lytics_audiences and populate it with Lytics audience slugs that the user is part of

config.profile_id_fieldoptionalstring

Select the field in the Lytics audience user that corresponds to Localytics profile ID. If a user does not exist for this ID in Localytics, then we will create the user with this ID. **Note:** Lytics users who do not have the selected ID field will be dropped

config.segment_idsoptionalstring[]

Choose the audiences to export to Localytics app

config.special_attributesoptionalstring[]

Select the fields in the Lytics audience user that are special profile IDs in Localytics. Please refer to the [Localytics documentation](https://docs.localytics.com/dev/profile-api.html#profile-special-ids) for more information on this

config.withbackfilloptionalboolean

Export users who are already in the selected Lytics audiences

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": {
    "app_id": "string",
    "attributes": [
      "string"
    ],
    "audience_membership": true,
    "profile_id_field": "string",
    "segment_ids": [
      "string"
    ],
    "special_attributes": [
      "string"
    ],
    "withbackfill": 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": {
      "app_id": "string",
      "attributes": [
        "string"
      ],
      "audience_membership": true,
      "profile_id_field": "string",
      "segment_ids": [
        "string"
      ],
      "special_attributes": [
        "string"
      ],
      "withbackfill": 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
}

LocalyticsExportAudience: Get job

GEThttps://api.lytics.io/v2/job/localytics-export-audience/{id}

LocalyticsExportAudience: Update job

PUThttps://api.lytics.io/v2/job/localytics-export-audience/{id}

{ "auth_ids": [ "string" ], "config": { "app_id": "string", "attributes": [ "string" ], "audience_membership": true, "profile_id_field": "string", "segment_ids": [ "string" ], "special_attributes": [ "string" ], "withbackfill": 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": { "app_id": "string", "attributes": [ "string" ], "audience_membership": true, "profile_id_field": "string", "segment_ids": [ "string" ], "special_attributes": [ "string" ], "withbackfill": 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 }

Localytics Export Audience

LocalyticsExportAudience: Create job

Query Parameters

Headers

Body Parameters

LocalyticsExportAudience: Get job

LocalyticsExportAudience: Update job

Localytics Export Audience

LocalyticsExportAudience: Create job

Query Parameters

Headers

Body Parameters

LocalyticsExportAudience: Get job

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