Tiktok App Events

View as Markdown

Create and manage data import and export jobs.

TiktokAppEvents: Create job

POSThttps://api.lytics.io/v2/job/tiktok-app-events

Create a TiktokAppEvents 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_idrequiredstring

Enter the App ID associated with these conversions

config.app_nameoptionalstring

Enter the App Name associated with these conversions

config.app_versionoptionalstring

Enter the version number of the app associated with these conversions

config.audience_eventsoptionalstring

Select which type of audience trigger events to send to TikTok. By default both enters and exits with be sent.

One of: enters_only, exits_only

config.event_namerequiredstring

Select the action source for this conversion. If Action Source is not mapped or the user field is empty, this value will be used

config.event_sourcerequiredstring

Select the Event Name associated with this conversion. If Event Name is not mapped or the user field is empty, this value will be used

config.event_timeoptionalstring

Select user field that contains the event time

config.field_changesoptionalstring[]

Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user field change event will be sent to the TikTok API.

config.identifier_mappingrequiredobject[]

Map all the identifier fields from Lytics to TikTok by selecting the Lytics field on the left, and its TikTok destination on the right

config.property_mappingrequiredobject[]

Map all the property fields from Lytics to TikTok by selecting the Lytics field on the left, and its TikTok destination on the right

config.segment_idsrequiredstring[]

Select the audiences to export

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",
    "app_name": "string",
    "app_version": "string",
    "audience_events": "enters_only",
    "event_name": "string",
    "event_source": "string",
    "event_time": "string",
    "field_changes": [
      "string"
    ],
    "identifier_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "property_mapping": [
      {
        "property1": "string",
        "property2": "string"
      }
    ],
    "segment_ids": [
      "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": {
      "app_id": "string",
      "app_name": "string",
      "app_version": "string",
      "audience_events": "enters_only",
      "event_name": "string",
      "event_source": "string",
      "event_time": "string",
      "field_changes": [
        "string"
      ],
      "identifier_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "property_mapping": [
        {
          "property1": "string",
          "property2": "string"
        }
      ],
      "segment_ids": [
        "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
}

TiktokAppEvents: Get job

GEThttps://api.lytics.io/v2/job/tiktok-app-events/{id}

TiktokAppEvents: Update job

PUThttps://api.lytics.io/v2/job/tiktok-app-events/{id}

{ "auth_ids": [ "string" ], "config": { "app_id": "string", "app_name": "string", "app_version": "string", "audience_events": "enters_only", "event_name": "string", "event_source": "string", "event_time": "string", "field_changes": [ "string" ], "identifier_mapping": [ { "property1": "string", "property2": "string" } ], "property_mapping": [ { "property1": "string", "property2": "string" } ], "segment_ids": [ "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": { "app_id": "string", "app_name": "string", "app_version": "string", "audience_events": "enters_only", "event_name": "string", "event_source": "string", "event_time": "string", "field_changes": [ "string" ], "identifier_mapping": [ { "property1": "string", "property2": "string" } ], "property_mapping": [ { "property1": "string", "property2": "string" } ], "segment_ids": [ "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 }

Tiktok App Events

TiktokAppEvents: Create job

Query Parameters

Headers

Body Parameters

TiktokAppEvents: Get job

TiktokAppEvents: Update job

Tiktok App Events

TiktokAppEvents: Create job

Query Parameters

Headers

Body Parameters

TiktokAppEvents: Get job

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