Salesforce Custom Import

View as Markdown

Create and manage data import and export jobs.

SalesforceCustomImport: Create job

POSThttps://api.lytics.io/v2/job/salesforce-custom-import

Create a SalesforceCustomImport 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

Continuously run this export.

config.max_callsoptionalinteger

The maximum number of API calls the Lytics export can make on your behalf per day. See [our docs](https://www.contentstack.com/docs/lytics/salesforce) for tips on finding and estimating this.

config.objects_sinceoptionalstring (date-time)

Enter the earliest date from which to import objects. RFC3339 formatted (i.e. YYYY-MM-DDThh:mm:ss+00:00)

config.salesforce_fieldsrequiredstring[]

Select fields to import

config.salesforce_objectrequiredstring

config.streamrequiredstring

Select an existing stream to write to, or enter a new stream name

config.time_of_dayoptionalstring

Time of day to start import each day

config.timezoneoptionalstring

config.ts_fieldoptionalstring

Select Timestamp Field

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,
    "max_calls": 0,
    "objects_since": "2019-08-24T14:15:22Z",
    "salesforce_fields": [
      "string"
    ],
    "salesforce_object": "string",
    "stream": "string",
    "time_of_day": "string",
    "timezone": "string",
    "ts_field": "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,
      "max_calls": 0,
      "objects_since": "2019-08-24T14:15:22Z",
      "salesforce_fields": [
        "string"
      ],
      "salesforce_object": "string",
      "stream": "string",
      "time_of_day": "string",
      "timezone": "string",
      "ts_field": "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
}

SalesforceCustomImport: Get job

GEThttps://api.lytics.io/v2/job/salesforce-custom-import/{id}

SalesforceCustomImport: Update job

PUThttps://api.lytics.io/v2/job/salesforce-custom-import/{id}

{ "auth_ids": [ "string" ], "config": { "continuous_update": true, "max_calls": 0, "objects_since": "2019-08-24T14:15:22Z", "salesforce_fields": [ "string" ], "salesforce_object": "string", "stream": "string", "time_of_day": "string", "timezone": "string", "ts_field": "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, "max_calls": 0, "objects_since": "2019-08-24T14:15:22Z", "salesforce_fields": [ "string" ], "salesforce_object": "string", "stream": "string", "time_of_day": "string", "timezone": "string", "ts_field": "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 }

Salesforce Custom Import

SalesforceCustomImport: Create job

Query Parameters

Headers

Body Parameters

SalesforceCustomImport: Get job

SalesforceCustomImport: Update job

Salesforce Custom Import

SalesforceCustomImport: Create job

Query Parameters

Headers

Body Parameters

SalesforceCustomImport: Get job

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