Introduction
Datasources and destinations
- Find all the data sources available at www.catchr.io/connectors
- Find all the destinations available at www.catchr.io/destinations
10s LIVE Views Views of at least 10 seconds. Available from Sept 27, 2024. |
| ||||||
Day of the month Day of the year |
| ||||||
Day of the week Week of the year |
| ||||||
Hour of the day Hour of the day |
| ||||||
Month of the year Month of the year |
| ||||||
Month and day Month and day |
| ||||||
Quarter of the year Quarter of the year |
| ||||||
Week of the year Week of the year |
| ||||||
Week of the year (start Sunday) Week of the year |
| ||||||
Year Year such as 2017. |
| ||||||
Year month Year and month. |
| ||||||
Date Year, month, and day. |
| ||||||
Year month day hour Year, month, day, and hour. |
| ||||||
Year Quarter Year and quarter. |
| ||||||
Year week Year and week. |
| ||||||
Ad click rate Click-through rate of paid views (ad clicks divided by ad views) for the selected product; excludes paid LIVE; available from 2024-09-27. |
| ||||||
Ad conversion rate Conversions divided by paid clicks for the selected product; excludes paid LIVE; available from 2024-09-27. |
| ||||||
2-second ad video view rate Two-second video views divided by total video views; replays excluded; available from 2024-09-27. |
| ||||||
6-second ad video view rate Six-second video views divided by total video views; replays excluded; available from 2024-09-27. |
| ||||||
100% ad video view rate Views reaching 100% of runtime divided by total video views (paid); replays excluded; available from 2024-09-27. |
| ||||||
25% ad video view rate Views reaching at least 25% of runtime divided by total video views (paid); replays excluded; available from 2024-09-27. |
| ||||||
50% ad video view rate Views reaching at least 50% of runtime divided by total video views (paid); replays excluded; available from 2024-09-27. |
| ||||||
75% ad video view rate Views reaching at least 75% of runtime divided by total video views (paid); replays excluded; available from 2024-09-27. |
| ||||||
Advertiser ID Get the Advertiser ID. |
| ||||||
Shop ID Get the Shop ID. |
| ||||||
Shop Name Get the Advertiser Name. |
| ||||||
Bid Type Optimization mode. CUSTOM: Target ROI. NO_BID: Maximum delivery. |
| ||||||
Campaign ID Campaign ID |
| ||||||
Campaign Name Campaign name |
| ||||||
Max Delivery Budget Maximum delivery budget |
| ||||||
Operation Status Campaign on/off status. ENABLE: on. DISABLE: off. |
| ||||||
Schedule End Time Schedule end time. Time zone: UTC+0. |
| ||||||
Schedule Start Time Schedule start time. Time zone: UTC+0. |
| ||||||
Schedule Type Schedule type. Continuously: To run the campaign continuously after the scheduled start time. |
| ||||||
Target ROI Budget Target ROI budget |
| ||||||
Cost The estimated total amount you've spent on your ads during its schedule, in the currency of the ad account. |
| ||||||
Cost per 10s LIVE View Ad cost per 10-second LIVE view. Available from Sept 27, 2024. |
| ||||||
Cost per LIVE View Ad cost per LIVE view. Available from Sept 27, 2024. |
| ||||||
Cost per Order The average cost incurred for each order placed, in the currency of the ad account. It's calculated by dividing the total ad cost by the number of orders generated within the ad schedule. |
| ||||||
Bit Rate (bps) Video bit rate in bits per second (bps). |
| ||||||
Definition Video definition/quality. |
| ||||||
Duration (s) Video duration in seconds. |
| ||||||
Format Video container format (e.g., mp4). |
| ||||||
Frames Per Second Frames per second (FPS) of the video. |
| ||||||
Height (px) Video height in pixels. |
| ||||||
Creative ID Creative identification string. |
| ||||||
Video Preview URL Temporary preview URL for the video. Valid for ~6 hours. Once expired, call /campaign/gmv_max/info/ to obtain a new URL. |
| ||||||
Signature (MD5) MD5 fingerprint of the video file. |
| ||||||
Size (bytes) Video file size in bytes. |
| ||||||
Video Cover URL Temporary URL for the video cover. Valid for ~24 hours. The expiration is provided in the 'x-expires' query parameter (Unix timestamp in seconds). Once expired, call /campaign/gmv_max/info/ to obtain a new URL. |
| ||||||
Video ID Video identification string. |
| ||||||
Width (px) Video width in pixels. |
| ||||||
Gross Revenue The total gross revenue of TikTok Shop orders attributed to your campaign, in the currency of the ad account. It's the amount the user pays, plus all TikTok Shop platform subsidies provided to the user. |
| ||||||
LIVE Follows Users who followed during LIVE. Available from Sept 27, 2024. |
| ||||||
LIVE Views Number of LIVE views. Available from Sept 27, 2024. |
| ||||||
LIVE Duration Livestream duration |
| ||||||
LIVE Launched Time Livestream launched time |
| ||||||
LIVE name LIVE name |
| ||||||
LIVE Status Livestream status. Enum values: ONGOING, END |
| ||||||
Net Cost The amount spent, excluding ad credit or coupons used, in the currency of the ad account. |
| ||||||
Orders (SKU) The number of individual SKU orders completed during the GMV Max Campaign. |
| ||||||
Optimization Mode Optimization mode. Example values: CUSTOM for target ROI, NO_BID for maximum delivery. |
| ||||||
Product SPU ID TikTok Shop product SPU identifier. |
| ||||||
Product Image URL Product image URL returned by the TikTok GMV Max product-level report. |
| ||||||
Product Name Product name returned by the TikTok GMV Max product-level report. |
| ||||||
Product Status Product status. Example values: available, unavailable. |
| ||||||
Product ad click rate Paid product clicks divided by total product views for the selected product; excludes LIVE; available from 2024-09-27. |
| ||||||
Product ad clicks Total paid product clicks during the campaign for the selected product, excluding LIVE; available from 2024-09-27. |
| ||||||
Product ad impressions Total paid product views during the campaign for the selected product, excluding LIVE; available from 2024-09-27. |
| ||||||
Target ROI Target return on ad spend |
| ||||||
ROI The total return on investment (ROI) from all TikTok Shop orders attributed to your campaign. |
|
.svg){kind=logo}