Documentation sections

Creating and configuring a campaign

The fields of the “Create campaign” and “Edit campaign” windows: what each one means, which values are allowed and what the defaults are.

A campaign is created in the Campaigns («Кампании») section and configured in two windows: Create campaign («Создать кампанию») and Edit campaign («Изменить кампанию»). All roles except the financier can create campaigns. A campaign can be edited by the user who created it, their team lead, owners and admins — see Campaign access and “Share”.

Creating a campaign

  1. Open Campaigns.
  2. Click + Campaign («+ Кампания»). On a phone, this is the + button in the bottom right corner of the screen.
  3. Enter a Name («Название»).
  4. Check the URL alias («Alias в URL»). It is already filled in with a random value.
  5. Choose a Cost model («Модель стоимости»).
  6. Enter the price in the field to the right of the alias. The field label depends on the model, for example Click price, $ («Цена клика, $»).
  7. Leave the other fields as they are or change them using the tables below.
  8. Click Create campaign.

The new campaign's page opens with the Streams («Потоки»), Source and parameters («Источник и параметры»), S2S postbacks («S2S-постбеки») and Cloaking («Клоака») tabs. The campaign is created in the “active” («активна») status and belongs to the user who created it.

The domain, traffic source and link parameters are not set in the creation window. They are configured on the Source and parameters tab — see Campaign link, domain and parameters. Next, add streams: without them, the campaign does not distribute traffic.

Editing a campaign

  1. Open the campaign page.
  2. Click Edit («Изменить»). The button is not there if the campaign is available to you for viewing only.
  3. Change the fields.
  4. Click Save («Сохранить»).

The window closes and the campaign header is updated. The Edit campaign window differs from the creation window:

When creatingWhen editing
URL alias with the ↻ buttonAlias, no button
Cost model, options with an explanation: CPC — per click («CPC — за клик»)Model («Модель»), short options: CPC
Uniq. period, h («Срок уник., ч»)Period, h («Срок, ч»)
Lost paid traffic, % («Недошедший платный трафик, %»)Lost traffic, % («Недошедший трафик, %»)
Cloaking checkboxNone. Cloaking is turned on on the Cloaking tab or with the toggle in the Cloaking column of the campaign list
NoneStatus («Статус»)
NoneUniqueness parameter («Параметр уникальности»), visible when uniqueness is set to By parameter («По параметру»)

Name and alias

FieldWhat to enterRules
NameThe campaign name in the list and reports, for example FB · Sweeps USRequired when creating
URL aliasThe first part of the traffic link path: https://track.example.com/aliasLatin letters, digits, _ and -, from 1 to 64 characters. Must not repeat the alias of another campaign, including archived ones

When the creation window opens, a random 7-character value is put into the alias. The ↻ button generates it again. If you clear the field when creating a campaign, the tracker generates an alias by itself. In the Edit campaign window, an empty alias is not saved.

Aliases that start with _ and the values health, click, clk, cloak and api in any case are not allowed.

Warning.

After the alias is changed, the campaign opens only by the new alias, and the tracker responds to the old link with 404. Replace the link in the traffic source.

Cost model and price

The label of the price field changes with the model. CPC with a price of 0 is selected by default.

ModelPrice fieldHow cost is calculated
CPC — per clickClick price, $The price for each click
CPuC — per unique click («CPuC — за уникальный клик»)Click price, $The price for a unique click; a repeat visit costs 0
CPM — per 1000 («CPM — за 1000»)Price per 1000, $ («Цена за 1000, $»)The price divided by 1000, for each click
CPA — per conversion («CPA — за конверсию»)Conversion price, $ («Цена конверсии, $»)The price for each conversion with the lead, sale or rejected status
CPS — per sale («CPS — за продажу»)Sale price, $ («Цена продажи, $»)The price for each sale
RevShare — payout share («RevShare — доля выплаты»)Payout share, % («Доля выплаты, %»)A percentage of the payout for each sale

The price is a number from 0, in US dollars. For RevShare, it is a percentage from 0 to 100. The decimal part can be written with a period or a comma: 0.05 or 0,05. An empty field is saved as 0. If the field does not contain a number, the message “Enter a number, for example 0.05” («Введите число, например 0.05») appears under it, and the campaign is not saved.

The model and price are written into the click at the moment of the visit. Changing the campaign settings does not recalculate past costs. Details and ways to override cost are on the Campaign cost models page.

Lost paid traffic

The Lost paid traffic, % field is a cost correction for cases where the ad network charged for clicks that did not reach the tracker. The field does not drop visitors and does not affect stream selection.

  • Value: an integer from 0 to 99, 0 by default.
  • Formula: click cost = price / (1 − percentage / 100). A click price of 0.10 and 20% give 0.125 per click.
  • It works for the CPC, CPuC and CPM models.
  • If the click cost came from the source in a link parameter, the correction is not applied to it.

Uniqueness

A unique click is a visitor's first click in this campaign. The same visitor's following clicks before the uniqueness period ends are not counted as unique. The period is counted from the first click. The flag counts toward the Uniq. clicks («Уник. клики») metric (in the report builder — Uniq. («Уник.»)) and determines cost in the CPuC model.

OptionHow the visitor is identified
None («Нет»)No check; every click is counted as unique
By IP («По IP»)By IP address
IP + UABy IP address and User-Agent. Selected by default in the creation window
By parameterBy the value of a link parameter

Uniq. period, h is the period in hours, 24 by default. With the None option, the field is inactive. An empty value or 0 is saved as 24.

The By parameter option needs a parameter name. The creation window has no field for it, so the name is set after the campaign is created:

  1. Create a campaign with By parameter uniqueness.
  2. On the campaign page, click Edit.
  3. Enter the name in the Uniqueness parameter field, for example sub_id_1.
  4. Click Save.

You can use a parameter name from the campaign link or a slot from the source tokens. While the name is not set or the parameter in the click is empty, the check is not performed and the click is counted as unique.

Visitor binding

The Visitor binding («Привязка посетителя») checkbox in the creation window is selected. A returning visitor goes to the same stream as on the first visit. The fields below are visible while the checkbox is selected.

FieldOptionsDefault
Remember («Запоминать»)Stream («Поток»), Stream and landing page («Поток и лендинг»), Whole bundle («Вся связка»)Stream
Period, hours («Срок, часы»)An integer from 0 to 87600 — the campaign's uniqueness period applies

The period is counted from the first visit. The Edit campaign window has two similar fields: Period, h refers to uniqueness, and Period, hours refers to binding. What each option remembers and how binding works together with pauses, schedules and intercepting streams is covered on the Visitor binding page.

Group, cloaking and status

Group («Группа») is a text label for the filter in the campaign list and for the Campaign group («Группа кампании») grouping in reports. Enter a name. In the creation window, the field suggests existing groups; the edit window has no suggestions. Spaces at the edges are trimmed. The field can be left empty. More details are on the Campaign groups page.

Cloaking is a checkbox in the creation window, off by default. The checks are configured on the Cloaking tab of the campaign page — see Cloaking setup.

Status is available only in the Edit campaign window:

StatusWhat happens to traffic
activeVisits via the link are handled by the campaign's streams
paused («пауза»)The link returns 404
archived («архив»)The link returns 404, and the campaign appears in the Trash («Корзина») section — see Campaign archive and trash

Above the tabs you will see:

  • the status label, group, model and price;
  • the Statistics («Статистика»), Pause («Пауза») or Start («Запустить»), Share («Поделиться») and Edit buttons;
  • the “30-day summary” («сводка за 30 дней»): Clicks («Клики»), Conversions («Конверсии»), CR, Revenue («Доход»), Profit («Прибыль»), ROI. It refreshes every 10 seconds while the browser tab is on screen;
  • the Traffic link («Ссылка для трафика») block with the Copy («Копировать») button and the Alias, Model, Source («Источник»), Domain («Домен») line;
  • the expandable Campaign target diagnostics and monitoring («Диагностика и мониторинг целей кампании») block — see target checks.

The Pause button is visible for an active campaign, and Start for a paused or archived campaign. Both change only the status and do not affect the other settings. Statistics opens the campaign statistics. Owners, admins and team leads see the Share button. If the campaign is available to you for viewing only, the “view only” («только просмотр») label is shown instead of the Pause, Share and Edit buttons.

On a phone, the Source and parameters tab is labeled Parameters («Параметры»).

Error messages

If the tracker did not accept the values, the window stays open, and the message appears in a red banner on the page under the window. To read it, close the window. The price message is shown in the window itself, under the price field, and disappears when you change the value. When reopened, the Create campaign window keeps the entered values, except the alias: it is generated again. In the Edit campaign window, unsaved changes are discarded after the window is closed.

MessageCauseWhat to do
name is requiredThe Name is empty when creatingEnter a name
“Alias is required” («Alias обязателен»)The alias is empty in the Edit campaign windowEnter an alias
“alias: Latin letters, digits, _ and - only, up to 64 characters (no /)” («alias: только латиница, цифры, _ и -, до 64 символов (без /)»)The alias has an invalid character or a space, or it is longer than 64 charactersFix the alias
“alias ‘api’ is reserved — choose another one” («alias «api» зарезервирован — выберите другой»)The alias starts with _ or matches a forbidden value. The quotes contain the alias you enteredChoose a different alias
“a campaign with this alias already exists” («кампания с таким alias уже есть»)The alias is taken by another campaign, including an archived oneEnter a different alias
“Enter a number, for example 0.05”The price field does not contain a number: it has letters, a currency sign, %, a minus, a space inside the number or two separatorsEnter a number from 0, separating the decimal part with a period or a comma
“price must be from 0 to 1,000,000,000” («цена должна быть от 0 до 1 000 000 000»)The price is greater than 1,000,000,000Fix the price
“RevShare must be from 0 to 100%” («RevShare должен быть от 0 до 100%»)The payout share is greater than 100Enter a share from 0 to 100
“Campaign group unavailable” («Группа кампании недоступна»)You are allowed only certain campaign groups, and the Group field contains a different one. An empty field is accepted only if you are allowed campaigns without a groupEnter an allowed group — see User permissions
“Access to the section is restricted by the administrator” («Доступ к разделу ограничен администратором»)You have View («Просмотр») access to the Campaigns sectionContact the owner or the admin

The lost traffic and binding period fields are checked by the browser: with a fractional value, a value out of range or an empty binding period, the form is not submitted, and the browser shows a hint next to the field.

Updated Need help? ↗