Localytics Push

View as Markdown

Create and manage data import and export jobs.

LocalyticsPush: Create job

POSThttps://api.lytics.io/v2/job/localytics-push

Create a LocalyticsPush 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.alertoptionalstring

Message in the push notification

config.alert_subtitleoptionalstring

Optional - a short string that expands on the title. This is only displayed for users running iOS 10 (and above)

config.alert_titleoptionalstring

Optional - a short string describing the purpose of the notification

config.android_attachment_urloptionalstring

Optional - specifies the url of the rich media attachment

config.android_channeloptionalstring

Optional - specifies the channel for the notification

config.android_deep_linkoptionalstring

Optional - specifies the deeplink url

config.android_priorityoptionalstring

Optional - specifies whether the notification should pre-emptively wake the device from Doze mode

config.app_idoptionalstring

Select the Localytics app to send messages from

config.customer_id_fieldoptionalstring

Field that contains the ID that uniquely identifies the Localytics customer

config.ios_attachment_typeoptionalstring

Optional - specifies the media type of the rich media attachment

config.ios_attachment_urloptionalstring

Optional - specifies the url of the rich media attachment

config.ios_badgeoptionalinteger

Optional - specifies the unread badge number to display upon delivery

config.ios_cateogryoptionalstring

Optional - specifies the category of actions (interactive push) to display to the user upon delivery

config.ios_deep_linkoptionalstring

Optional - specifies the url of the rich media attachment

config.ios_soundoptionalstring

Optional - specifies the sound file in the app bundle or in the Library/Sounds folder of the app’s data container. If the sound file doesn’t exist or default is specified as the value, the default alert sound is played

config.label1optionalstring

Optional - specifies a set of optional labels associated with this request. These labels are intended to provide a finer level of granularity in measuring and analyzing campaign performance data than just campaign_key and request_id

config.label2optionalstring

config.label3optionalstring

config.label4optionalstring

config.request_idoptionalstring

Optional - specifies the unique request. Typically, you will send a GUID/UUID for this field. Localytics will automatically de-duplicate requests within 24 hours of each other, at the app_id + customer_id level, that are received for the same request_id. Maximum of 255 characters length.

config.segment_idoptionalstring

Select a Lytics audience. Push notifications will be sent to users as they enter the audience

config.user_limitoptionalinteger

Maximum number of users to send before the limit resets at the specified time. Set to 0 for no limit.

config.user_limit_day_of_weekoptionalstring

Select the day of the week to reset the user limit count.

config.user_limit_frequencyoptionalstring

Select how frequently to reset the user limit count.

config.user_limit_time_of_dayoptionalstring

Select the time of day to reset the user limit count.

config.user_limit_timezoneoptionalstring

Select the timezone for the time of day to reset the user limit count.

config.withbackfilloptionalboolean

Check this to immediately trigger pushes to users who currently exist in the selected Lytics audience

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": {
    "alert": "string",
    "alert_subtitle": "string",
    "alert_title": "string",
    "android_attachment_url": "string",
    "android_channel": "string",
    "android_deep_link": "string",
    "android_priority": "string",
    "app_id": "string",
    "customer_id_field": "string",
    "ios_attachment_type": "string",
    "ios_attachment_url": "string",
    "ios_badge": 0,
    "ios_cateogry": "string",
    "ios_deep_link": "string",
    "ios_sound": "string",
    "label1": "string",
    "label2": "string",
    "label3": "string",
    "label4": "string",
    "request_id": "string",
    "segment_id": "string",
    "user_limit": 0,
    "user_limit_day_of_week": "string",
    "user_limit_frequency": "string",
    "user_limit_time_of_day": "string",
    "user_limit_timezone": "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": {
      "alert": "string",
      "alert_subtitle": "string",
      "alert_title": "string",
      "android_attachment_url": "string",
      "android_channel": "string",
      "android_deep_link": "string",
      "android_priority": "string",
      "app_id": "string",
      "customer_id_field": "string",
      "ios_attachment_type": "string",
      "ios_attachment_url": "string",
      "ios_badge": 0,
      "ios_cateogry": "string",
      "ios_deep_link": "string",
      "ios_sound": "string",
      "label1": "string",
      "label2": "string",
      "label3": "string",
      "label4": "string",
      "request_id": "string",
      "segment_id": "string",
      "user_limit": 0,
      "user_limit_day_of_week": "string",
      "user_limit_frequency": "string",
      "user_limit_time_of_day": "string",
      "user_limit_timezone": "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
}

LocalyticsPush: Get job

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

LocalyticsPush: Update job

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

{ "auth_ids": [ "string" ], "config": { "alert": "string", "alert_subtitle": "string", "alert_title": "string", "android_attachment_url": "string", "android_channel": "string", "android_deep_link": "string", "android_priority": "string", "app_id": "string", "customer_id_field": "string", "ios_attachment_type": "string", "ios_attachment_url": "string", "ios_badge": 0, "ios_cateogry": "string", "ios_deep_link": "string", "ios_sound": "string", "label1": "string", "label2": "string", "label3": "string", "label4": "string", "request_id": "string", "segment_id": "string", "user_limit": 0, "user_limit_day_of_week": "string", "user_limit_frequency": "string", "user_limit_time_of_day": "string", "user_limit_timezone": "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": { "alert": "string", "alert_subtitle": "string", "alert_title": "string", "android_attachment_url": "string", "android_channel": "string", "android_deep_link": "string", "android_priority": "string", "app_id": "string", "customer_id_field": "string", "ios_attachment_type": "string", "ios_attachment_url": "string", "ios_badge": 0, "ios_cateogry": "string", "ios_deep_link": "string", "ios_sound": "string", "label1": "string", "label2": "string", "label3": "string", "label4": "string", "request_id": "string", "segment_id": "string", "user_limit": 0, "user_limit_day_of_week": "string", "user_limit_frequency": "string", "user_limit_time_of_day": "string", "user_limit_timezone": "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 Push

LocalyticsPush: Create job

Query Parameters

Headers

Body Parameters

LocalyticsPush: Get job

LocalyticsPush: Update job

Localytics Push

LocalyticsPush: Create job

Query Parameters

Headers

Body Parameters

LocalyticsPush: Get job

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