TOOL API

split_test_create

Creates a split test group. Split tests are supported at ad group level and campaign level. For ad group-level split tests, the total budget is evenly distributed to each group; for campaign-level split tests, each campaign keeps its existing budget. Campaign-level split tests are allowlist-only, and comparing two ad groups from different campaigns in a split test is also allowlist-only. Before using this endpoint, review the split test prerequisites and setup guidance in the related Super Split Test documentation.

ecommerceOAuth1 credits

Call information

Tool slug
tiktok-ads.split_test_create
Provider
TikTok for Business
Average response
0 ms
Calls in 7 days
0

Input parameters

advertiser_idrequired

Advertiser ID.

budget

Total split test budget. Required when `split_test_level=ADGROUP`. Do not specify this field when `split_test_level=CAMPAIGN`, or an error will occur. For ad group-level split tests, this amount is evenly distributed and overwrites the existing budgets of the two ad groups. If you change the total budget after the test starts, TikTok recommends updating the two ad groups to the same budget value. For campaign-level split tests, budget follows each campaign's existing budget.

cells

Required when `split_test_level` is `CAMPAIGN`. List of cells in the split test. The array length must be 2.

end_timerequired

Split test end time in `YYYY-MM-DD HH:MM:SS` (UTC+0). Example: `2022-01-01 00:00:00`. When `split_test_level=CAMPAIGN`, time can only be set to the hour, so any minute and second values default to `00`. For campaign-level split tests, this does not overwrite the end times of the campaigns or ad groups in the test.

key_metric

Key metric to monitor. Supported values depend on optimization goal. If omitted, defaults are: for ad group-level split tests, `COST_PER_REACH` when both ad groups use the `REACH` optimization goal, otherwise `COST_PER_SHOW`; for campaign-level split tests, `UNSET`. Deprecated values are `CLICK`, `REACH`, `SHOW`, `CONVERT`, and `COST`.

object_ids

Object IDs bound to the split test. When `split_test_level=ADGROUP`, provide either this field or `cells`. When `split_test_level=CAMPAIGN`, do not use this field; provide `cells` instead.

split_test_level

Split test level. `ADGROUP` creates an ad group-level split test; `CAMPAIGN` creates a campaign-level split test. Default is `ADGROUP`. Campaign-level split tests are allowlist-only. Comparing two ad groups from different campaigns in a split test is also allowlist-only; those campaigns may have different advertising objectives.

start_timerequired

Split test start time in `YYYY-MM-DD HH:MM:SS` (UTC+0). Example: `2022-01-01 00:00:00`. When `split_test_level=CAMPAIGN`, time can only be set to the hour, so any minute and second values default to `00`. For campaign-level split tests, this does not overwrite the start times of the campaigns or ad groups in the test.

test_variable

Variable being tested. `BIDDING_OPTIMIZATION` compares bidding and optimization settings, `TARGTING` compares ad group targeting settings, `CREATIVE` compares creatives, and `CUSTOM` compares multiple variables. `CUSTOM` is available only for campaign-level split tests. Defaults: `BIDDING_OPTIMIZATION` for ad group-level split tests and `CUSTOM` for campaign-level split tests. Once specified, `test_variable` cannot be updated.