connectors.tik_tok

Preview the data

post/connectors/tik_tok/preview

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/connectors/tik_tok/preview
  • Auth: none declared

Request body

o_auth_idstring
authorizer_idstring
nullable_fieldsboolean

Setting this parameter to true allows the use of null values. If set to false, default values for each data type will be used instead.

ensure_data_typesobject

Overrides the default data types of the produced Source schema, ensuring that each field is typed as specified.

data_typesobject

Overrides the default data types of the produced Source schema, ensuring that each field is typed as specified.

connector_idstring
template_idstring
labelstring
allow_emptyboolean

Setting this parameter to true allows extraction operations to proceed even if they produce 0 rows. If set to false, the operation will result in an error if no rows are extracted.

date_rangestring nullable
use_extraction_timestampboolean
use_hashboolean
use_date_startboolean
use_date_stopboolean
use_masked_columnsboolean
hash_columnsstring[]

Array of strings.

masked_columnsstring[]

Array of strings.

advertiserIdsstring[]

TikTok advertiser IDs.

metricsstring[]

Array of Metrics.

attributesstring[]

Array of attributes.

dataLabelsstring[]

Array of Data Labels.

reportTypestring

The report type.

dataLevelstring

The data level.

idDimensionstring

ID dimension to be included in the result

timeDimensionstring

Time dimension to be included in the result

includeDeletedAdsboolean

Include deleted ads by requesting ad_status=STATUS_ALL from TikTok.

limitinteger
audienceDimensionsstring[]

Audience dimensions to be included in the result.

advertisersstring[]

Array of Advertisers.

formIdstring

TikTok Instant Form ID to download leads from.

advertiser_idstring

TikTok advertiser ID. This field is deprecated, use advertiserIds instead

metricstring[]

Array of Metrics. This field is deprecated, use metrics instead

data_labelstring[]

Array of Data Labels. This field is deprecated, use dataLabels instead

audience_dimensionstring[]

Array of Audience Dimensions. This field is deprecated, use audienceDimensions instead

Example request

{
  "authorizer_id": "P6T8tazCWdf3pkVzIAlnZa10gh",
  "ensure_data_types": {
    "field1": "float",
    "field2": "string",
    "field3": "integer",
    "field4": "date"
  },
  "data_types": {
    "field1": "float",
    "field2": "string",
    "field3": "integer",
    "field4": "date"
  },
  "date_range": "1d1",
  "hash_columns": [
    "id",
    "date_start"
  ],
  "masked_columns": [
    "name",
    "email"
  ],
  "advertiserIds": [
    "1",
    "2"
  ],
  "metrics": [
    "Impressions",
    "Spend"
  ],
  "attributes": [
    "id",
    "status"
  ],
  "dataLabels": [
    "campaign_id",
    "campaign_name"
  ],
  "reportType": "BASIC",
  "dataLevel": "AUCTION_AD",
  "idDimension": "ad_id",
  "timeDimension": "stat_time_day",
  "audienceDimensions": [
    "gender",
    "age"
  ],
  "advertisers": [
    "11111"
  ],
  "formId": "7123456789012345678",
  "advertiser_id": "0",
  "metric": [
    "Impressions",
    "Spend"
  ],
  "data_label": [
    "Time Dimension",
    "Advertiser ID"
  ],
  "audience_dimension": [
    "gender",
    "age"
  ]
}

Response

Data preview

codestring
blobstring
messagestring
headerstring[]

Array of strings.

keystring[]

Array of strings.

typestring[]
row_countinteger
dataobject[]

Row-oriented data: a list of rows, each row a map keyed by column name.

Example response

{
  "header": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ],
  "log": [
    {
      "request_header": {
        "key": "value"
      },
      "response_header": {
        "key": "value"
      }
    }
  ],
  "key": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.