Bq System Event Export

View as Markdown

Create and manage data import and export jobs.

BqSystemEventExport: Create job

POSThttps://api.lytics.io/v2/job/bq-system-event-export

Create a BqSystemEventExport 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.continuous_updateoptionalboolean

(Optional) Continuously run this export

config.datasetoptionalstring

Select the Google BigQuery Dataset you want to export system events to

config.end_dateoptionalstring

(Optional) Export system events upto this date (ex: 2020-01-01). If no end date is given then system events up to the current date will be exported.

config.projectoptionalstring

Select the Google BigQuery Project you want to export system events to

config.start_dateoptionalstring

(Optional) Export system events after this date (ex: 2020-01-01). If no start date is given then system events for last 30 days will be exported.

config.subject_idoptionalstring

(Optional) Provide the Subject ID for above system event subject type you would like to export (work_id, segment_id, account_id). Only events specific to this Subject ID will be exported.

config.subject_typeoptionalstring

(Optional) Provide the Subject Type of system events you would like to export (work, segment, account). Only events specific to this Subject Type will be exported.

config.table_nameoptionalstring

(Optional) Select the Google BigQuery table you want to export system events to. If an existing table is not selected then one will be created. If no table name is entered lytics\\_{system_event}\\_export\\_{AID} will be used

config.time_of_dayoptionalstring

(Optional) Time of day to start export each day

config.timezoneoptionalstring

(Optional) Timezone for time of day

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": {
    "continuous_update": true,
    "dataset": "string",
    "end_date": "string",
    "project": "string",
    "start_date": "string",
    "subject_id": "string",
    "subject_type": "string",
    "table_name": "string",
    "time_of_day": "string",
    "timezone": "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": {
      "continuous_update": true,
      "dataset": "string",
      "end_date": "string",
      "project": "string",
      "start_date": "string",
      "subject_id": "string",
      "subject_type": "string",
      "table_name": "string",
      "time_of_day": "string",
      "timezone": "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
}

BqSystemEventExport: Get job

GEThttps://api.lytics.io/v2/job/bq-system-event-export/{id}

BqSystemEventExport: Update job

PUThttps://api.lytics.io/v2/job/bq-system-event-export/{id}

{ "auth_ids": [ "string" ], "config": { "continuous_update": true, "dataset": "string", "end_date": "string", "project": "string", "start_date": "string", "subject_id": "string", "subject_type": "string", "table_name": "string", "time_of_day": "string", "timezone": "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": { "continuous_update": true, "dataset": "string", "end_date": "string", "project": "string", "start_date": "string", "subject_id": "string", "subject_type": "string", "table_name": "string", "time_of_day": "string", "timezone": "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 }

Bq System Event Export

BqSystemEventExport: Create job

Query Parameters

Headers

Body Parameters

BqSystemEventExport: Get job

BqSystemEventExport: Update job

Bq System Event Export

BqSystemEventExport: Create job

Query Parameters

Headers

Body Parameters

BqSystemEventExport: Get job

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