---
title: "Preview the data"
method: POST
path: "/connectors/tik_tok/preview"
tags: ["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

- PostSourceTikTokInput
  - `o_auth_id` string
  - `authorizer_id` string
  - `nullable_fields` boolean: 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_types` object: Overrides the default data types of the produced Source schema, ensuring that each field is typed as specified.
  - `data_types` object: Overrides the default data types of the produced Source schema, ensuring that each field is typed as specified.
  - `connector_id` string
  - `template_id` string
  - `label` string
  - `allow_empty` boolean: 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_range` string, nullable
  - `use_extraction_timestamp` boolean
  - `use_hash` boolean
  - `use_date_start` boolean
  - `use_date_stop` boolean
  - `use_masked_columns` boolean
  - `hash_columns` string[]: Array of strings.
  - `masked_columns` string[]: Array of strings.
  - `advertiserIds` string[]: TikTok advertiser IDs.
  - `metrics` string[]: Array of Metrics.
  - `attributes` string[]: Array of attributes.
  - `dataLabels` string[]: Array of Data Labels.
  - `reportType` string: The report type.
  - `dataLevel` string: The data level.
  - `idDimension` string: ID dimension to be included in the result
  - `timeDimension` string: Time dimension to be included in the result
  - `includeDeletedAds` boolean: Include deleted ads by requesting ad_status=STATUS_ALL from TikTok.
  - `limit` integer
  - `audienceDimensions` string[]: Audience dimensions to be included in the result.
  - `advertisers` string[]: Array of Advertisers.
  - `formId` string: TikTok Instant Form ID to download leads from.
  - `advertiser_id` string: TikTok advertiser ID. This field is deprecated, use advertiserIds instead
  - `metric` string[]: Array of Metrics. This field is deprecated, use metrics instead
  - `data_label` string[]: Array of Data Labels. This field is deprecated, use dataLabels instead
  - `audience_dimension` string[]: Array of Audience Dimensions. This field is deprecated, use audienceDimensions instead

## Response `200`

Data preview

- PreviewDto
  - `code` string
  - `blob` string
  - `message` string
  - `header` string[]: Array of strings.
  - `log` Log[]
    - `request_url` string
    - `request_method` string
    - `request_header` object: Set of key/value pairs.
    - `request_body` string
    - `response_status_code` integer
    - `response_status` string
    - `response_header` object: Set of key/value pairs.
    - `response_body` string
    - `response_content_length` integer
    - `duration` number, float
    - `cached` boolean
    - `error` string, nullable
  - `key` string[]: Array of strings.
  - `type` string[]
  - `row_count` integer
  - `data` object[]: Row-oriented data: a list of rows, each row a map keyed by column name.

---

[API](https://skmtc.dev/dataddo/apis/dataddo-headless-beta-api.md) · [All operations](https://skmtc.dev/dataddo/apis/dataddo-headless-beta-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dataddo/apis/dataddo-headless-beta-api/revisions/dcfa2345bd10?raw)