# TikTok ## Overview TikTok is a popular social media app that allows users to create, watch, and share videos. With its personalized feeds of short videos set to music and sound effects, the app is notable for its high levels of engagement. This document provides context on what kind of data is being gathered through this extractor, which endpoints that data is coming from, and how the extracted tables relate to each other. ## Integration Availability This integration is available for: * Enterprise * Growth ## API Endpoints The Daasity TikTok extractor is built based on this [TikTok API Documentation](https://ads.tiktok.com/marketing_api/docs?id=1735712062490625\&rid=kg7mw1dlmpa). The following endpoints are used by Daasity to replicate data from TikTok: * [Ad](https://ads.tiktok.com/marketing_api/docs?id=1735735588640770) * [Ad Group](https://ads.tiktok.com/marketing_api/docs?id=1739314558673922) * [Advertisers](https://ads.tiktok.com/marketing_api/docs?id=1708503202263042) * [Campaigns](https://ads.tiktok.com/marketing_api/docs?id=1739315828649986) * [Reports](https://ads.tiktok.com/marketing_api/docs?id=1707957200780290) ## Entity Relationship Diagram (ERD) [Click here to view the ERD for the Daasity TikTok integration](https://lucid.app/documents/embedded/7295b9e8-aa1b-4821-9d73-836edac27902) illustrating the different tables and keys to join across tables. ## TikTok Schema The Daasity TikTok extractor creates these tables using the endpoints and replication methods listed. The data is mapped from the source API endpoint to the table based on the mapping logic outlined in each table. * [Ad Groups](#a-d-groups) * [Ad Group Audience](#a-d-group-audience) * [Ad Group Device Model](#a-d-group-device-model) * [Ad Group Placement](#a-d-group-placement) * [Ads](#a-ds) * [Ad Spend Auction Metrics](#a-d-spend-auction-metrics) * [Ad Spend Auction Ad](#a-d-spend-auction-ad) * [Ad Spend Auction Ad Group](#a-d-spend-auction-ad-group) * [Ad Spend Auction Campaign](#a-d-spend-auction-campaign) * [Ad Spend Reservation Metrics](#a-d-spend-reservation-metrics) * [Ad Spend Reservation Ad](#a-d-spend-reservation-ad) * [Ad Spend Reservation Ad Group](#a-d-spend-reservation-ad-group) * [Ad Spend Reservation Campaign](#a-d-spend-reservation-campaign) * [Advertisers](#a-dvertisers) * [Campaigns](#campaigns) ### **Ad Groups** * Endpoint: [Ad Group](https://ads.tiktok.com/marketing_api/docs?id=1739314558673922) * Update Method: UPSERT * Table Name: \[`tiktok.ad_groups`] | JSON Element | Database Column | | ------------------------------------------------- | ---------------------------------------- | | advertiser\_id | advertiser\_id | | campaign\_id | campaign\_id | | adgroup\_id | adgroup\_id | | adgroup\_name | adgroup\_name | | split\_test\_group\_id | split\_test\_group\_id | | split\_test\_status | split\_test\_status | | share\_disabled | share\_disabled | | placement\_type | placement\_type | | inventory\_filter\_enabled | inventory\_filter\_enabled | | comment\_disabled | comment\_disabled | | app\_id | app\_id | | promotion\_type | promotion\_type | | store\_id | store\_id | | store\_authorized\_bc\_id | store\_authorized\_bc\_id | | identity\_id | identity\_id | | identity\_type | identity\_type | | identity\_authorized\_bc\_id | identity\_authorized\_bc\_id | | app\_download\_url | app\_download\_url | | pixel\_id | pixel\_id | | optimization\_event | optimization\_event | | secondary\_optimization\_event | secondary\_optimization\_event | | creative\_material\_mode | creative\_material\_mode | | audience\_type | audience\_type | | is\_hfss | is\_hfss | | gender | gender | | min\_android\_version | min\_android\_version | | min\_ios\_version | min\_ios\_version | | ios14\_targeting | ios14\_targeting | | budget\_mode | budget\_mode | | budget | budget | | scheduled\_budget | scheduled\_budget | | schedule\_type | schedule\_type | | schedule\_start\_time | schedule\_start\_time | | schedule\_end\_time | schedule\_end\_time | | dayparting | dayparting | | optimization\_goal | optimization\_goal | | bid\_display\_mode | bid\_display\_mode | | cpv\_video\_duration | cpv\_video\_duration | | conversion\_window | conversion\_window | | pacing | pacing | | billing\_event | billing\_event | | skip\_learning\_phase | skip\_learning\_phase | | bid\_type | bid\_type | | bid\_price | bid\_price | | conversion\_bid\_price | conversion\_bid\_price | | deep\_bid\_type | deep\_bid\_type | | deep\_cpa\_bid | deep\_cpa\_bid | | next\_day\_retention | next\_day\_retention | | secondary\_status | secondary\_status | | operation\_status | operation\_status | | frequency | frequency | | frequency\_schedule | frequency\_schedule | | statistic\_type | statistic\_type | | video\_download\_disabled | video\_download\_disabled | | rf\_purchased\_type | rf\_purchased\_type | | purchased\_impression | purchased\_impression | | purchased\_reach | purchased\_reach | | rf\_estimated\_cpr | rf\_estimated\_cpr | | rf\_estimated\_frequency | rf\_estimated\_frequency | | is\_new\_structure | is\_new\_structure | | catalog\_id | catalog\_id | | product\_set\_id | product\_set\_id | | catalog\_authorized\_bc\_id | catalog\_authorized\_bc\_id | | shopping\_ads\_retargeting\_type | shopping\_ads\_retargeting\_type | | brand\_safety\_type | brand\_safety\_type | | brand\_safety\_partner | brand\_safety\_partner | | promotion\_website\_type | promotion\_website\_type | | ios\_quota\_type | ios\_quota\_type | | roas\_bid | roas\_bid | | auto\_targeting\_enabled | auto\_targeting\_enabled | | targeting\_expansion::expansion\_enabled | targeting\_expansion\_expansion\_enabled | | targeting\_expansion::expansion\_type | targeting\_expansion\_expansion\_types | | adgroup\_app\_profile\_page\_state | adgroup\_app\_profile\_page\_state | | shopping\_ads\_type | shopping\_ads\_type | | product\_source | product\_source | | MD5(advertiser\_id + adgroup\_id + campaign\_id ) | \_\_sync\_key | ### **Ad Group Audience** * Endpoint: [Ad Group](https://ads.tiktok.com/marketing_api/docs?id=1739314558673922) * Update Method: UPSERT * Table Name: \[`tiktok.adgroup_audience`] | JSON Element | Database Column | | ---------------------------------------------------------------- | --------------- | | advertiser\_id | advertiser\_id | | campaign\_id | campaign\_id | | adgroup\_id | adgroup\_id | | audience\_id | audience\_id | | MD5(advertiser\_id + campaign\_id + adgroup\_id + audience\_id) | \_\_sync\_key | ### **Ad Group Device Model** * Endpoint: [Ad Group](https://ads.tiktok.com/marketing_api/docs?id=1739314558673922) * Update Method: UPSERT * Table Name: \[`tiktok.adgroup_device_model`] | JSON Element | Database Column | | -------------------------------------------------------------------- | ----------------- | | advertiser\_id | advertiser\_id | | campaign\_id | campaign\_id | | adgroup\_id | adgroup\_id | | device\_model\_id | device\_model\_id | | MD5(advertiser\_id + campaign\_id + adgroup\_id + device\_model\_id) | \_\_sync\_key | ### **Ad Group Placement** * Endpoint: [Ad Group](https://ads.tiktok.com/marketing_api/docs?id=1739314558673922) * Update Method: UPSERT * Table Name: \[`tiktok.adgroup_placement`] | JSON Element | Database Column | | --------------------------------------- | --------------- | | advertiser\_id | advertiser\_id | | campaign\_id | campaign\_id | | adgroup\_id | adgroup\_id | | placement | placement | | MD5(advertiser\_id + campaign\_id + ad) | \_\_sync\_key | ### **Ads** * Endpoint: [Ad](https://ads.tiktok.com/marketing_api/docs?id=1735735588640770) * Update Method: UPSERT * Table Name: \[`tiktok.ads`] | | | | ---------------------------------------------------------- | --------------------------------- | | **JSON Element** | **Database Columnd** | | advertiser\_id | advertiser\_id | | campaign\_id | campaign\_id | | campaign\_name | campaign\_name | | adgroup\_id | adgroup\_id | | adgroup\_name | adgroup\_name | | ad\_id | ad\_id | | ad\_name | ad\_name | | identity\_id | identity\_id | | identity\_type | identity\_type | | identity\_authorized\_bc\_id | identity\_authorized\_bc\_id | | call\_to\_action | call\_to\_action | | call\_to\_action\_id | call\_to\_action\_id | | card\_id | card\_id | | secondary\_status | secondary\_status | | operation\_status | operation\_status | | is\_aco | is\_aco | | ad\_format | ad\_format | | ad\_text | ad\_text | | ad\_texts | ad\_texts | | video\_id | video\_id | | tiktok\_item\_id | tiktok\_item\_id | | app\_name | app\_name | | landing\_page\_url | landing\_page\_url | | landing\_page\_urls | landing\_page\_urls | | display\_name | display\_name | | profile\_image\_url | profile\_image\_url | | impression\_tracking\_url | impression\_tracking\_url | | click\_tracking\_url | click\_tracking\_url | | deeplink | deeplink | | deeplink\_type | deeplink\_type | | fallback\_type | fallback\_type | | playable\_url | playable\_url | | page\_id | page\_id | | vast\_moat\_enabled | vast\_moat\_enabled | | creative\_authorized | creative\_authorized | | is\_new\_structure | is\_new\_structure | | create\_time | create\_time | | modify\_time | modify\_time | | shopping\_ads\_fallback\_type | shopping\_ads\_fallback\_type | | shopping\_ads\_deeplink\_type | shopping\_ads\_deeplink\_type | | shopping\_ads\_video\_package\_id | shopping\_ads\_video\_package\_id | | promotional\_music\_disabled | promotional\_music\_disabled | | dark\_post\_status | dark\_post\_status | | branded\_content\_disabled | branded\_content\_disabled | | item\_duet\_status | item\_duet\_status | | item\_stitch\_status | item\_stitch\_status | | brand\_safety\_postbid\_partner | brand\_safety\_postbid\_partner | | product\_specific\_type | product\_specific\_type | | catalog\_id | catalog\_id | | product\_set\_id | product\_set\_id | | sku\_ids | sku\_ids | | dynamic\_format | dynamic\_format | | vertical\_video\_strategy | vertical\_video\_strategy | | dynamic\_destination | dynamic\_destination | | MD5((advertiser\_id + ad\_id + adgroup\_id + campaign\_id) | \_\_sync\_key | ### **Ad Spend Auction Metrics** * API Endpoint: [Reports](https://ads.tiktok.com/marketing_api/docs?id=1707957200780290) * Update Method: UPSERT * Table Names: tiktok.adspend\_auction\_ad, tiktok.adspend\_auction\_adgroup, tiktok.adspend\_auction\_campaign {% hint style="info" %} The following metrics are extracted from the Reports API Endpoint and can be queried at the ad, ad group, and campaign level for all Ad Spend Auction tables. The metrics included are: {% endhint %} | JSON Element | Database Column | | -------------------------------------------- | -------------------------------------------- | | campaign\_name | campaign\_name | | objective\_type | objective\_type | | adgroup\_name | adgroup\_name | | placement\_type | placement\_type | | ad\_name | ad\_name | | ad\_text | ad\_text | | tt\_app\_id | tt\_app\_id | | tt\_app\_name | tt\_app\_name | | mobile\_app\_id | mobile\_app\_id | | promotion\_type | promotion\_type | | dpa\_target\_audience\_type | dpa\_target\_audience\_type | | spend | spend | | cpc | cpc | | cpm | cpm | | impressions | impressions | | clicks | clicks | | ctr | ctr | | reach | reach | | cost\_per\_1000\_reached | cost\_per\_1000\_reached | | conversion | conversion | | cost\_per\_conversion | cost\_per\_conversion | | conversion\_rate | conversion\_rate | | real\_time\_conversion | real\_time\_conversion | | real\_time\_cost\_per\_conversion | real\_time\_cost\_per\_conversion | | result | result | | cost\_per\_result | cost\_per\_result | | result\_rate | result\_rate | | real\_time\_result | real\_time\_result | | real\_time\_cost\_per\_result | real\_time\_cost\_per\_result | | real\_time\_result\_rate | real\_time\_result\_rate | | secondary\_goal\_result | secondary\_goal\_result | | cost\_per\_secondary\_goal\_result | cost\_per\_secondary\_goal\_result | | secondary\_goal\_result\_rate | secondary\_goal\_result\_rate | | frequency | frequency | | currency | currency | | video\_play\_actions | video\_play\_actions | | video\_watched\_2s | video\_watched\_2s | | video\_watched\_6s | video\_watched\_6s | | average\_video\_play | average\_video\_play | | average\_video\_play\_per\_user | average\_video\_play\_per\_user | | video\_views\_p25 | video\_views\_p25 | | video\_views\_p50 | video\_views\_p50 | | video\_views\_p75 | video\_views\_p75 | | video\_views\_p100 | video\_views\_p100 | | profile\_visits | profile\_visits | | profile\_visits\_rate | profile\_visits\_rate | | likes | likes | | comments | comments | | shares | shares | | follows | follows | | real\_time\_app\_install | real\_time\_app\_install | | real\_time\_app\_install\_cost | real\_time\_app\_install\_cost | | app\_install | app\_install | | cost\_per\_app\_install | cost\_per\_app\_install | | registration | registration | | cost\_per\_registration | cost\_per\_registration | | registration\_rate | registration\_rate | | total\_registration | total\_registration | | cost\_per\_total\_registration | cost\_per\_total\_registration | | purchase | purchase | | cost\_per\_purchase | cost\_per\_purchase | | purchase\_rate | purchase\_rate | | total\_purchase | total\_purchase | | cost\_per\_total\_purchase | cost\_per\_total\_purchase | | value\_per\_total\_purchase | value\_per\_total\_purchase | | total\_purchase\_value | total\_purchase\_value | | total\_active\_pay\_roas | total\_active\_pay\_roas | | app\_event\_add\_to\_cart | app\_event\_add\_to\_cart | | cost\_per\_app\_event\_add\_to\_cart | cost\_per\_app\_event\_add\_to\_cart | | app\_event\_add\_to\_cart\_rate | app\_event\_add\_to\_cart\_rate | | total\_app\_event\_add\_to\_cart | total\_app\_event\_add\_to\_cart | | cost\_per\_total\_app\_event\_add\_to\_cart | cost\_per\_total\_app\_event\_add\_to\_cart | | value\_per\_total\_app\_event\_add\_to\_cart | value\_per\_total\_app\_event\_add\_to\_cart | | total\_app\_event\_add\_to\_cart\_value | total\_app\_event\_add\_to\_cart\_value | | checkout | checkout | | cost\_per\_checkout | cost\_per\_checkout | | checkout\_rate | checkout\_rate | | total\_checkout | total\_checkout | | cost\_per\_total\_checkout | cost\_per\_total\_checkout | | value\_per\_checkout | value\_per\_checkout | | total\_checkout\_value | total\_checkout\_value | | view\_content | view\_content | | cost\_per\_view\_content | cost\_per\_view\_content | | view\_content\_rate | view\_content\_rate | | total\_view\_content | total\_view\_content | | cost\_per\_total\_view\_content | cost\_per\_total\_view\_content | | value\_per\_total\_view\_content | value\_per\_total\_view\_content | | total\_view\_content\_value | total\_view\_content\_value | | next\_day\_open | next\_day\_open | | cost\_per\_next\_day\_open | cost\_per\_next\_day\_open | | next\_day\_open\_rate | next\_day\_open\_rate | | total\_next\_day\_open | total\_next\_day\_open | | cost\_per\_total\_next\_day\_open | cost\_per\_total\_next\_day\_open | | add\_payment\_info | add\_payment\_info | | cost\_per\_add\_payment\_info | cost\_per\_add\_payment\_info | | add\_payment\_info\_rate | add\_payment\_info\_rate | | total\_add\_payment\_info | total\_add\_payment\_info | | cost\_total\_add\_payment\_info | cost\_total\_add\_payment\_info | | add\_to\_wishlist | add\_to\_wishlist | | cost\_per\_add\_to\_wishlist | cost\_per\_add\_to\_wishlist | | add\_to\_wishlist\_rate | add\_to\_wishlist\_rate | | total\_add\_to\_wishlist | total\_add\_to\_wishlist | | cost\_per\_total\_add\_to\_wishlist | cost\_per\_total\_add\_to\_wishlist | | value\_per\_total\_add\_to\_wishlist | value\_per\_total\_add\_to\_wishlist | | total\_add\_to\_wishlist\_value | total\_add\_to\_wishlist\_value | | launch\_app | launch\_app | | cost\_per\_launch\_app | cost\_per\_launch\_app | | launch\_app\_rate | launch\_app\_rate | | total\_launch\_app | total\_launch\_app | | cost\_per\_total\_launch\_app | cost\_per\_total\_launch\_app | | complete\_tutorial | complete\_tutorial | | cost\_per\_complete\_tutorial | cost\_per\_complete\_tutorial | | complete\_tutorial\_rate | complete\_tutorial\_rate | | total\_complete\_tutorial | total\_complete\_tutorial | | cost\_per\_total\_complete\_tutorial | cost\_per\_total\_complete\_tutorial | | value\_per\_total\_complete\_tutorial | value\_per\_total\_complete\_tutorial | | total\_complete\_tutorial\_value | total\_complete\_tutorial\_value | | create\_group | create\_group | | cost\_per\_create\_group | cost\_per\_create\_group | | create\_group\_rate | create\_group\_rate | | total\_create\_group | total\_create\_group | | cost\_per\_total\_create\_group | cost\_per\_total\_create\_group | | value\_per\_total\_create\_group | value\_per\_total\_create\_group | | total\_create\_group\_value | total\_create\_group\_value | | join\_group | join\_group | | cost\_per\_join\_group | cost\_per\_join\_group | | join\_group\_rate | join\_group\_rate | | total\_join\_group | total\_join\_group | | cost\_per\_total\_join\_group | cost\_per\_total\_join\_group | | value\_per\_total\_join\_group | value\_per\_total\_join\_group | | total\_join\_group\_value | total\_join\_group\_value | | create\_gamerole | create\_gamerole | | cost\_per\_create\_gamerole | cost\_per\_create\_gamerole | | create\_gamerole\_rate | create\_gamerole\_rate | | total\_create\_gamerole | total\_create\_gamerole | | cost\_per\_total\_create\_gamerole | cost\_per\_total\_create\_gamerole | | value\_per\_total\_create\_gamerole | value\_per\_total\_create\_gamerole | | total\_create\_gamerole\_value | total\_create\_gamerole\_value | | spend\_credits | spend\_credits | | cost\_per\_spend\_credits | cost\_per\_spend\_credits | | spend\_credits\_rate | spend\_credits\_rate | | total\_spend\_credits | total\_spend\_credits | | cost\_per\_total\_spend\_credits | cost\_per\_total\_spend\_credits | | value\_per\_total\_spend\_credits | value\_per\_total\_spend\_credits | | total\_spend\_credits\_value | total\_spend\_credits\_value | | achieve\_level | achieve\_level | | cost\_per\_achieve\_level | cost\_per\_achieve\_level | | achieve\_level\_rate | achieve\_level\_rate | | total\_achieve\_level | total\_achieve\_level | | cost\_per\_total\_achieve\_level | cost\_per\_total\_achieve\_level | | value\_per\_total\_achieve\_level | value\_per\_total\_achieve\_level | | total\_achieve\_level\_value | total\_achieve\_level\_value | | unlock\_achievement | unlock\_achievement | | cost\_per\_unlock\_achievement | cost\_per\_unlock\_achievement | | unlock\_achievement\_rate | unlock\_achievement\_rate | | total\_unlock\_achievement | total\_unlock\_achievement | | cost\_per\_total\_unlock\_achievement | cost\_per\_total\_unlock\_achievement | | value\_per\_total\_unlock\_achievement | value\_per\_total\_unlock\_achievement | | total\_unlock\_achievement\_value | total\_unlock\_achievement\_value | | sales\_lead | sales\_lead | | cost\_per\_sales\_lead | cost\_per\_sales\_lead | | sales\_lead\_rate | sales\_lead\_rate | | total\_sales\_lead | total\_sales\_lead | | cost\_per\_total\_sales\_lead | cost\_per\_total\_sales\_lead | | value\_per\_total\_sales\_lead | value\_per\_total\_sales\_lead | | total\_sales\_lead\_value | total\_sales\_lead\_value | | in\_app\_ad\_click | in\_app\_ad\_click | | cost\_per\_in\_app\_ad\_click | cost\_per\_in\_app\_ad\_click | | in\_app\_ad\_click\_rate | in\_app\_ad\_click\_rate | | total\_in\_app\_ad\_click | total\_in\_app\_ad\_click | | cost\_per\_total\_in\_app\_ad\_click | cost\_per\_total\_in\_app\_ad\_click | | value\_per\_total\_in\_app\_ad\_click | value\_per\_total\_in\_app\_ad\_click | | total\_in\_app\_ad\_click\_value | total\_in\_app\_ad\_click\_value | | in\_app\_ad\_impr | in\_app\_ad\_impr | | cost\_per\_in\_app\_ad\_impr | cost\_per\_in\_app\_ad\_impr | | in\_app\_ad\_impr\_rate | in\_app\_ad\_impr\_rate | | total\_in\_app\_ad\_impr | total\_in\_app\_ad\_impr | | cost\_per\_total\_in\_app\_ad\_impr | cost\_per\_total\_in\_app\_ad\_impr | | value\_per\_total\_in\_app\_ad\_impr | value\_per\_total\_in\_app\_ad\_impr | | total\_in\_app\_ad\_impr\_value | total\_in\_app\_ad\_impr\_value | | loan\_apply | loan\_apply | | cost\_per\_loan\_apply | cost\_per\_loan\_apply | | loan\_apply\_rate | loan\_apply\_rate | | total\_loan\_apply | total\_loan\_apply | | cost\_per\_total\_loan\_apply | cost\_per\_total\_loan\_apply | | loan\_credit | loan\_credit | | cost\_per\_loan\_credit | cost\_per\_loan\_credit | | loan\_credit\_rate | loan\_credit\_rate | | total\_loan\_credit | total\_loan\_credit | | cost\_per\_total\_loan\_credit | cost\_per\_total\_loan\_credit | | loan\_disbursement | loan\_disbursement | | cost\_per\_loan\_disbursement | cost\_per\_loan\_disbursement | | loan\_disbursement\_rate | loan\_disbursement\_rate | | total\_loan\_disbursement | total\_loan\_disbursement | | cost\_per\_total\_loan\_disbursement | cost\_per\_total\_loan\_disbursement | | login | login | | cost\_per\_login | cost\_per\_login | | login\_rate | login\_rate | | total\_login | total\_login | | cost\_per\_total\_login | cost\_per\_total\_login | | ratings | ratings | | cost\_per\_ratings | cost\_per\_ratings | | ratings\_rate | ratings\_rate | | total\_ratings | total\_ratings | | cost\_per\_total\_ratings | cost\_per\_total\_ratings | | value\_per\_total\_ratings | value\_per\_total\_ratings | | total\_ratings\_value | total\_ratings\_value | | search | search | | cost\_per\_search | cost\_per\_search | | search\_rate | search\_rate | | total\_search | total\_search | | cost\_per\_total\_search | cost\_per\_total\_search | | start\_trial | start\_trial | | cost\_per\_start\_trial | cost\_per\_start\_trial | | start\_trial\_rate | start\_trial\_rate | | total\_start\_trial | total\_start\_trial | | cost\_per\_total\_start\_trial | cost\_per\_total\_start\_trial | | subscribe | subscribe | | cost\_per\_subscribe | cost\_per\_subscribe | | subscribe\_rate | subscribe\_rate | | total\_subscribe | total\_subscribe | | cost\_per\_total\_subscribe | cost\_per\_total\_subscribe | | value\_per\_total\_subscribe | value\_per\_total\_subscribe | | total\_subscribe\_value | total\_subscribe\_value | | vta\_app\_install | vta\_app\_install | | vta\_conversion | vta\_conversion | | cost\_per\_vta\_conversion | cost\_per\_vta\_conversion | | vta\_registration | vta\_registration | | cost\_per\_vta\_registration | cost\_per\_vta\_registration | | vta\_purchase | vta\_purchase | | cost\_per\_vta\_purchase | cost\_per\_vta\_purchase | | cta\_app\_install | cta\_app\_install | | cta\_conversion | cta\_conversion | | cost\_per\_cta\_conversion | cost\_per\_cta\_conversion | | cta\_registration | cta\_registration | | cost\_per\_cta\_registration | cost\_per\_cta\_registration | | cta\_purchase | cta\_purchase | | cost\_per\_cta\_purchase | cost\_per\_cta\_purchase | | complete\_payment\_roas | complete\_payment\_roas | | complete\_payment | complete\_payment | | cost\_per\_complete\_payment | cost\_per\_complete\_payment | | complete\_payment\_rate | complete\_payment\_rate | | value\_per\_complete\_payment | value\_per\_complete\_payment | | total\_complete\_payment\_rate | total\_complete\_payment\_rate | | page\_browse\_view | page\_browse\_view | | cost\_per\_page\_browse\_view | cost\_per\_page\_browse\_view | | page\_browse\_view\_rate | page\_browse\_view\_rate | | total\_page\_browse\_view\_value | total\_page\_browse\_view\_value | | value\_per\_page\_browse\_view | value\_per\_page\_browse\_view | | button\_click | button\_click | | cost\_per\_button\_click | cost\_per\_button\_click | | button\_click\_rate | button\_click\_rate | | value\_per\_button\_click | value\_per\_button\_click | | total\_button\_click\_value | total\_button\_click\_value | | online\_consult | online\_consult | | cost\_per\_online\_consult | cost\_per\_online\_consult | | online\_consult\_rate | online\_consult\_rate | | value\_per\_online\_consult | value\_per\_online\_consult | | total\_online\_consult\_value | total\_online\_consult\_value | | user\_registration | user\_registration | | cost\_per\_user\_registration | cost\_per\_user\_registration | | user\_registration\_rate | user\_registration\_rate | | value\_per\_user\_registration | value\_per\_user\_registration | | total\_user\_registration\_value | total\_user\_registration\_value | | product\_details\_page\_browse | product\_details\_page\_browse | | cost\_per\_product\_details\_page\_browse | cost\_per\_product\_details\_page\_browse | | product\_details\_page\_browse\_rate | product\_details\_page\_browse\_rate | | value\_per\_product\_details\_page\_browse | value\_per\_product\_details\_page\_browse | | total\_product\_details\_page\_browse\_value | total\_product\_details\_page\_browse\_value | | web\_event\_add\_to\_cart | web\_event\_add\_to\_cart | | cost\_per\_web\_event\_add\_to\_cart | cost\_per\_web\_event\_add\_to\_cart | | web\_event\_add\_to\_cart\_rate | web\_event\_add\_to\_cart\_rate | | value\_per\_web\_event\_add\_to\_cart | value\_per\_web\_event\_add\_to\_cart | | total\_web\_event\_add\_to\_cart\_value | total\_web\_event\_add\_to\_cart\_value | | on\_web\_order | on\_web\_order | | cost\_per\_on\_web\_order | cost\_per\_on\_web\_order | | on\_web\_order\_rate | on\_web\_order\_rate | | value\_per\_on\_web\_order | value\_per\_on\_web\_order | | total\_on\_web\_order\_value | total\_on\_web\_order\_value | | initiate\_checkout | initiate\_checkout | | cost\_per\_initiate\_checkout | cost\_per\_initiate\_checkout | | initiate\_checkout\_rate | initiate\_checkout\_rate | | value\_per\_initiate\_checkout | value\_per\_initiate\_checkout | | total\_initiate\_checkout\_value | total\_initiate\_checkout\_value | | add\_billing | add\_billing | | cost\_per\_add\_billing | cost\_per\_add\_billing | | add\_billing\_rate | add\_billing\_rate | | value\_per\_add\_billing | value\_per\_add\_billing | | total\_add\_billing\_value | total\_add\_billing\_value | | page\_event\_search | page\_event\_search | | cost\_per\_page\_event\_search | cost\_per\_page\_event\_search | | page\_event\_search\_rate | page\_event\_search\_rate | | value\_per\_page\_event\_search | value\_per\_page\_event\_search | | total\_page\_event\_search\_value | total\_page\_event\_search\_value | | form | form | | cost\_per\_form | cost\_per\_form | | form\_rate | form\_rate | | value\_per\_form | value\_per\_form | | total\_form\_value | total\_form\_value | | download\_start | download\_start | | cost\_per\_download\_start | cost\_per\_download\_start | | download\_start\_rate | download\_start\_rate | | value\_per\_download\_start | value\_per\_download\_start | | total\_download\_start\_value | total\_download\_start\_value | | on\_web\_add\_to\_wishlist | on\_web\_add\_to\_wishlist | | cost\_per\_on\_web\_add\_to\_wishlist | cost\_per\_on\_web\_add\_to\_wishlist | | on\_web\_add\_to\_wishlist\_per\_click | on\_web\_add\_to\_wishlist\_per\_click | | value\_per\_on\_web\_add\_to\_wishlist | value\_per\_on\_web\_add\_to\_wishlist | | total\_on\_web\_add\_to\_wishlist\_value | total\_on\_web\_add\_to\_wishlist\_value | | on\_web\_subscribe | on\_web\_subscribe | | cost\_per\_on\_web\_subscribe | cost\_per\_on\_web\_subscribe | | on\_web\_subscribe\_per\_click | on\_web\_subscribe\_per\_click | | value\_per\_on\_web\_subscribe | value\_per\_on\_web\_subscribe | | total\_on\_web\_subscribe\_value | total\_on\_web\_subscribe\_value | | onsite\_shopping\_roas | onsite\_shopping\_roas | | onsite\_shopping | onsite\_shopping | | onsite\_initiate\_checkout\_count | onsite\_initiate\_checkout\_count | | onsite\_on\_web\_detail | onsite\_on\_web\_detail | | onsite\_add\_to\_wishlist | onsite\_add\_to\_wishlist | | onsite\_add\_billing | onsite\_add\_billing | | onsite\_on\_web\_cart | onsite\_on\_web\_cart | | onsite\_form | onsite\_form | | onsite\_download\_start | onsite\_download\_start | | ix\_page\_view\_count | ix\_page\_view\_count | | ix\_button\_click\_count | ix\_button\_click\_count | | ix\_product\_click\_count | ix\_product\_click\_count | ### **Ad Spend Auction Ad** * Endpoint: [Reports](https://ads.tiktok.com/marketing_api/docs?id=1707957200780290) * Update Method: UPSERT * Table Name: \[`tiktok.adspend_auction_ad`] | JSON Element | Database Column | | --------------------------------------------------------------------------- | -------------------------------------------------------------- | | campaign\_id | campaign\_id | | adgroup\_id | adgroup\_id | | ad\_id | ad\_id | | stat\_time\_day | \_date | | MD5(advertiser\_id + adgroup\_id + campaign\_id + ad\_id + stat\_time\_day) | \_\_sync\_key | | metrics\[] | All columns specified in Ad Spend Auction Metrics schema above | {% hint style="info" %} **NOTE**: There are two extractions being made for this report, due to dimension limits within an extraction. The primary table will contain the full set of columns while their stage tables (tables ending in *\_stg*) will have a subset of metrics. Stage tables are stitched together to complete the primary table, updating rows with matching sync keys. {% endhint %} ### **Ad Spend Auction Ad Group** * Endpoint: [Reports](https://ads.tiktok.com/marketing_api/docs?id=1707957200780290) * Update Method: UPSERT * Table Name: \[`tiktok.adspend_auction_adgroup`] | JSON Element | Database Column | | ------------------------------------------------------------------ | -------------------------------------------------------------- | | campaign\_id | campaign\_id | | adgroup\_id | adgroup\_id | | stat\_time\_day | \_date | | MD5(advertiser\_id + adgroup\_id + campaign\_id + stat\_time\_day) | \_\_sync\_key | | metrics\[] | All columns specified in Ad Spend Auction Metrics schema above | {% hint style="info" %} **NOTE**: There are two extractions being made for this report, due to dimension limits within an extraction. The primary table will contain the full set of columns while their stage tables (tables ending in *\_stg*) will have a subset of metrics. Stage tables are stitched together to complete the primary table, updating rows with matching sync keys. {% endhint %} ### **Ad Spend Auction Campaign** * Endpoint: [Reports](https://ads.tiktok.com/marketing_api/docs?id=1707957200780290) * Update Method: UPSERT * Table Name: \[`tiktok.adspend_auction_campaign`] | **JSON Element** | **Database Column** | | ---------------------------------------------------- | -------------------------------------------------------------- | | campaign\_id | campaign\_id | | stat\_time\_day | \_date | | MD5(advertiser\_id + campaign\_id + stat\_time\_day) | \_\_sync\_key | | metrics\[] | All columns specified in Ad Spend Auction Metrics schema above | {% hint style="info" %} **NOTE**: There are two extractions being made for this report, due to dimension limits within an extraction. The primary table will contain the full set of columns while their stage tables (tables ending in *\_stg*) will have a subset of metrics. Stage tables are stitched together to complete the primary table, updating rows with matching sync keys. {% endhint %} ### **Ad Spend Reservation Metrics** * Endpoint: [Reports](https://ads.tiktok.com/marketing_api/docs?id=1707957200780290) * Update Method: UPSERT * Table Name: \[`tiktok.adspend_reservation_ad`], \[`tiktok.adspend_reservation_adgroup`], \[`tiktok.adspend_reservation_campaign`] {% hint style="info" %} The following metrics are extracted from the Reports API Endpoint and can be queried at the ad, ad group, and campaign level for all Ad Spend Auction tables. The metrics included are: {% endhint %} | JSON Element | Database Column | | ------------------------------- | ------------------------------- | | campaign\_name | campaign\_name | | adgroup\_name | adgroup\_name | | ad\_name | ad\_name | | spend | spend | | impressions | impressions | | clicks | clicks | | ctr | ctr | | reach | reach | | cost\_per\_1000\_reached | cost\_per\_1000\_reached | | frequency | frequency | | currency | currency | | video\_play\_actions | video\_play\_actions | | video\_watched\_2s | video\_watched\_2s | | video\_watched\_6s | video\_watched\_6s | | video\_views\_p25 | video\_views\_p25 | | video\_views\_p50 | video\_views\_p50 | | video\_views\_p75 | video\_views\_p75 | | video\_views\_p100 | video\_views\_p100 | | average\_video\_play | average\_video\_play | | average\_video\_play\_per\_user | average\_video\_play\_per\_user | | likes | likes | | comments | comments | | shares | shares | | profile\_visits | profile\_visits | | follows | follows | | clicks\_on\_music\_disc | clicks\_on\_music\_disc | | clicks\_on\_hashtag\_challenge | clicks\_on\_hashtag\_challenge | | engagements | engagements | | engagement\_rate | engagement\_rate | | skip\_ad | skip\_ad | | interact\_card\_show\_cnt | interact\_card\_show\_cnt | | interact\_card\_a\_click\_cnt | interact\_card\_a\_click\_cnt | | interact\_card\_b\_click\_cnt | interact\_card\_b\_click\_cnt | | vote\_card\_show\_cnt | vote\_card\_show\_cnt | | vote\_card\_a\_click\_cnt | vote\_card\_a\_click\_cnt | | vote\_card\_b\_click\_cnt | vote\_card\_b\_click\_cnt | | vote\_card\_convert\_click\_cnt | vote\_card\_convert\_click\_cnt | | redpacket\_show\_cnt | redpacket\_show\_cnt | | redpacket\_click\_cnt | redpacket\_click\_cnt | | image\_card\_show\_cnt | image\_card\_show\_cnt | | image\_card\_click\_cnt | image\_card\_click\_cnt | {% hint style="info" %} **NOTE**: Daasity has currently disabled the endpoint for reservation reports. Please contact to enable the endpoint. {% endhint %} ### **Ad Spend Reservation Ad** * Endpoint: [Reports](https://ads.tiktok.com/marketing_api/docs?id=1707957200780290) * Update Method: UPSERT * Table Name: \[`tiktok.adspend_reservation_ad`] | JSON Element | Database Column | | --------------------------------------------------------------------------- | ------------------------------------------------------------------ | | campaign\_id | campaign\_id | | adgroup\_id | adgroup\_id | | ad\_id | ad\_id | | stat\_time\_day | \_date | | MD5(advertiser\_id + adgroup\_id + campaign\_id + ad\_id + stat\_time\_day) | \_\_sync\_key | | metrics\[] | All columns specified in Ad Spend Reservation Metrics schema above | {% hint style="info" %} **NOTE**: Two extractions are being made for this report, due to dimension limits within an extraction. The primary table will contain the full set of columns while their stage tables (tables ending in *\_stg*) will have a subset of metrics. Stage tables are stitched together to complete the primary table, updating rows with matching sync keys. {% endhint %} {% hint style="info" %} **NOTE**: Daasity has currently disabled the endpoint for reservation reports. Please contact to enable the endpoint. {% endhint %} ### **Ad Spend Reservation Ad Group** * Endpoint: [Reports](https://ads.tiktok.com/marketing_api/docs?id=1707957200780290) * Update Method: UPSERT * Table Name: \[`tiktok.adspend_reservation_adgroup`] | JSON Element | Database Column | | ------------------------------------------------------------------ | ------------------------------------------------------------------ | | campaign\_id | campaign\_id | | adgroup\_id | adgroup\_id | | stat\_time\_day | \_date | | MD5(advertiser\_id + adgroup\_id + campaign\_id + stat\_time\_day) | \_\_sync\_key | | metrics\[] | All columns specified in Ad Spend Reservation Metrics schema above | {% hint style="info" %} **NOTE**: Two extractions are being made for this report, due to dimension limits within an extraction. The primary table will contain the full set of columns while their stage tables (tables ending in *\_stg*) will have a subset of metrics. Stage tables are stitched together to complete the primary table, updating rows with matching sync keys. {% endhint %} {% hint style="info" %} **NOTE**: Daasity has currently disabled the endpoint for reservation reports. Please contact to enable the endpoint. {% endhint %} ### **Ad Spend Reservation Campaign** * Endpoint: [Reports](https://ads.tiktok.com/marketing_api/docs?id=1707957200780290) * Update Method: UPSERT * Table Name: \[`tiktok.adspend_reservation_campaign`] | JSON Element | Database Column | | ---------------------------------------------------- | ------------------------------------------------------------------ | | campaign\_id | campaign\_id | | stat\_time\_day | \_date | | MD5(advertiser\_id + campaign\_id + stat\_time\_day) | \_\_sync\_key | | metrics\[] | All columns specified in Ad Spend Reservation Metrics schema above | {% hint style="info" %} **NOTE**: Two extractions are being made for this report, due to dimension limits within an extraction. The primary table will contain the full set of columns while their stage tables (tables ending in *\_stg*) will have a subset of metrics. Stage tables are stitched together to complete the primary table, updating rows with matching sync keys. {% endhint %} {% hint style="info" %} **NOTE**: Daasity has currently disabled the endpoint for reservation reports. Please contact to enable the endpoint. {% endhint %} ### **Advertisers** * Endpoint: [Advertisers](https://ads.tiktok.com/marketing_api/docs?id=1708503202263042) * Update Method: UPSERT * Table Name: \[`tiktok.advertisers`] | JSON Element | Database Column | | --------------------------- | --------------------------- | | integration\_id | integration\_id | | advertiser\_id | advertiser\_id | | name | name | | address | address | | company | company | | contacter | contacter | | country | country | | currency | currency | | description | description | | email | email | | brand | brand | | industry | industry | | language | language | | license\_no | license\_no | | license\_url | license\_url | | license\_province | license\_province | | license\_city | license\_city | | cellphone\_number | cellphone\_number | | rejection\_reason | rejection\_reason | | role | role | | status | status | | telephone\_number | telephone\_number | | timezone | timezone | | display\_timezone | display\_timezone | | balance | balance | | create\_time | create\_time | | owner\_bc\_id | owner\_bc\_id | | promotion\_center\_city | promotion\_center\_city | | promotion\_center\_province | promotion\_center\_province | | promotion\_area | promotion\_area | | MD5(advertiser\_id) | \_\_sync\_key | ### **Campaigns** * Endpoint: [Campaigns](https://ads.tiktok.com/marketing_api/docs?id=1739315828649986) * Update Method: UPSERT * Table Name: \[`tiktok.campaigns`] | JSON Element | Database Column | | ----------------------------------- | ----------------------------------- | | app\_id | app\_id | | campaign\_id | campaign\_id | | campaign\_name | campaign\_name | | campaign\_type | campaign\_type | | advertiser\_id | advertiser\_id | | budget | budget | | budget\_mode | budget\_mode | | secondary\_status | secondary\_status | | operation\_status | operation\_status | | objective | objective | | objective\_type | objective\_type | | bid\_type | bid\_type | | deep\_bid\_type | deep\_bid\_type | | roas\_bid | roas\_bid | | license\_province | is\_new\_structure | | create\_time | create\_time | | modify\_time | modify\_time | | campaign\_app\_profile\_page\_state | campaign\_app\_profile\_page\_state | | MD5(campaign\_id + advertiser\_id) | \_\_sync\_key | --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://help.daasity.com/core-concepts/data-integrations/setup-guides/digital-integrations/tiktok.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.