--- title: "LocalyticsPush: Get job" method: GET path: "/job/localytics-push/{id}" tags: ["Jobs"] --- # LocalyticsPush: Get job `GET /job/localytics-push/{id}` Get the summary of a LocalyticsPush job ## Path parameters - `id` string, required ## Query parameters - `account_id` string ## Response `200` LocalyticsPush Job - object - `_meta` object — Response Metadata - `data` object — Response Payload - `account_id` string — Lytics Account ID - `anomaly_rule` ModelsAnomalyRuleResp - `aid` integer - `checks` ModelsRuleCheckConfigReq[] - `allowable_violations` integer - `interval` string - `lookback_count` integer - `max_threshold` integer - `metric_type` string - `min_threshold` integer - `type` string - `variance_pct` number - `created` string - `id` string - `subject_id` string - `subject_type` string - `updated` string - `api_token_auth_id` string — this is set when work is create using access token - `auth_ids` string[] — Authorization IDs associated with the Job - `config` object, required — Job configuration, unique per-workflow - `alert` string — Message in the push notification - `alert_subtitle` string — Optional - a short string that expands on the title. This is only displayed for users running iOS 10 (and above) - `alert_title` string — Optional - a short string describing the purpose of the notification - `android_attachment_url` string — Optional - specifies the url of the rich media attachment - `android_channel` string — Optional - specifies the channel for the notification - `android_deep_link` string — Optional - specifies the deeplink url - `android_priority` string — Optional - specifies whether the notification should pre-emptively wake the device from Doze mode - `app_id` string — Select the Localytics app to send messages from - `customer_id_field` string — Field that contains the ID that uniquely identifies the Localytics customer - `ios_attachment_type` string — Optional - specifies the media type of the rich media attachment - `ios_attachment_url` string — Optional - specifies the url of the rich media attachment - `ios_badge` integer — Optional - specifies the unread badge number to display upon delivery - `ios_cateogry` string — Optional - specifies the category of actions (interactive push) to display to the user upon delivery - `ios_deep_link` string — Optional - specifies the url of the rich media attachment - `ios_sound` string — 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 - `label1` string — 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 - `label2` string — 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 - `label3` string — 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 - `label4` string — 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 - `request_id` string — 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. - `segment_id` string — Select a Lytics audience. Push notifications will be sent to users as they enter the audience - `user_limit` integer — Maximum number of users to send before the limit resets at the specified time. Set to 0 for no limit. - `user_limit_day_of_week` string — Select the day of the week to reset the user limit count. - `user_limit_frequency` string — Select how frequently to reset the user limit count. - `user_limit_time_of_day` string — Select the time of day to reset the user limit count. - `user_limit_timezone` string — Select the timezone for the time of day to reset the user limit count. - `withbackfill` boolean — Check this to immediately trigger pushes to users who currently exist in the selected Lytics audience - `created` string - `deleted` boolean — The Job has been deleted - `description` string — A user-defined description - `drop_events_during_quiet_window` boolean - `expires_at` string, date-time - `id` string — A Lytics-assigned, immutable unique ID for the Job - `meta` object — Extra meta data about the job - `monitoring` object — Inline monitoring config. On write: omit to keep, null to clear, or a config to set. - `name` string, required — A user-defined name - `quiet_period` integer - `quiet_time_of_day` string - `quiet_timezone` string - `sleep_until` string - `status` 'runnable' | 'sleeping' | 'paused' | 'completed' | 'fault' | 'failed' | 'killed' | 'deleted' | 'unknown' — The status of the job - `updated` string - `user_id` string — The user ID that created or updated the job - `workflow` string — The workflow slug - `workflow_id` string — The workflow ID - `request_id` string - `status` integer — HTTP Status Code ## Other responses - `404` — Not Found - `500` — Internal Server Error --- [API](https://skmtc.net/lytics/apis/lytics-api.md) · [All operations](https://skmtc.net/lytics/apis/lytics-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lytics/lytics-api/versions/366eeabcb6de/schema)