Documentation sections

Campaign link, domain and parameters

What the traffic link consists of, how to choose the campaign's source and domain, and how link parameters and default values work.

The tracker builds the traffic link itself from the domain, the campaign alias and the parameters. The domain, source and parameters are set on the campaign page, on the Source and parameters («Источник и параметры») tab (on a narrow screen it is labeled Parameters («Параметры»)); the campaign creation window doesn't have these fields. If the campaign is available to you for viewing only, the tab has no Save parameters («Сохранить параметры») button — see Campaign access and “Share”.

The Traffic link («Ссылка для трафика») block is on the campaign page above the tabs. It holds the ready link and a Copy («Копировать») button. After you click it, the label changes to “✓ Copied” («✓ Скопировано») for one and a half seconds.

Below the link there are four fields:

FieldWhat it shows
AliasThe campaign alias
Model («Модель»)The cost model
Source («Источник»)The name of the selected source or “—”
Domain («Домен»)The selected domain or “main” («основной»)

The link in the block updates after you click Save parameters and after you save the Edit campaign («Изменить кампанию») window. Unsaved edits on the Source and parameters tab don't get into it.

Warning.

The link works while the campaign has the “active” («активна») status. When the campaign is paused or archived, the tracker responds to the link with 404.

Link format

text
https://track.example.com/abc1234?utm_camp={{campaign.name}}&pixel=1234567890
  • https://track.example.com — the domain. If a domain is selected in the campaign, the link is built on it; otherwise, on the main traffic domain.
  • abc1234 — the campaign alias. The alias rules are on the Creating and configuring a campaign page.
  • After the ? sign — the parameters from the table, in the same order, as parameter=value pairs separated by &.

The link includes the rows where both Parameter («Параметр») and Value («Значение») are filled in, except hidden parameters. Values are inserted as is, without encoding: ad platform macros like {{campaign.name}} stay in the link in their original form.

Domain

  1. Open the Source and parameters tab.
  2. Select a domain in the Domain list.
  3. Click Save parameters.

The default option is “— main traffic domain —” («— основной домен трафика —»). This is the Tracking domain («Домен трекинга») specified during installation — see First-run wizard.

The list contains only the domains that are visible to you — see Domain groups and media buyer access. If the list is empty, “no domains available — contact your team lead” («нет доступных доменов — обратитесь к тимлиду») is shown next to it. What to do about this label and about the error “the selected domain is unavailable” («выбранный домен недоступен») is covered on the Domains page.

The selected domain determines which domain the panel shows the link on. The campaign also opens by its alias on the other domains from the Domains («Домены») section and on the tracking domain.

To make the campaign open at the root of a domain, without the alias in the path, assign it to that domain as its index page.

Source

The source list is to the right of the Source and link parameters («Источник и параметры ссылки») heading. The default option is “— no source —” («— без источника —»). The source determines the tokens that distribute click parameters into slots and the S2S postback to the source.

  1. Select a source in the list.
  2. Check the parameter table. If it was empty, the tracker has filled it with the source's tokens.
  3. Click Save parameters.

If the table already has rows, selecting a source doesn't change them. To add the missing parameters, click ↓ from source («↓ из источника»), then Save parameters. The button is visible when a source is selected and works like this:

  • the parameters are arranged in the order of the source's tokens;
  • the values you entered are kept, empty ones are filled with the token's Placeholder value;
  • missing parameters are added with the Placeholder value;
  • Name («Название») is taken from the token;
  • parameters that the source doesn't have stay at the end of the list.

How a token becomes a table row is covered on the Source tokens and link parameters page.

After you edit a source's tokens, the parameters of campaigns that already exist don't change by themselves. How to update them in all of the source's campaigns at once is covered on the Applying a source to campaigns page.

Parameter table

ColumnWhat to enterExample
NameThe row label. It doesn't get into the linkPixel
ParameterThe parameter name in the linkpixel
ValueAn ad platform macro or a ready value{{campaign.name}} or 1234567890
  • + Parameter («+ Параметр») adds an empty row.
  • ✕ deletes a row.
  • Save parameters writes the source, domain and table to the campaign. The button is inactive while there are no changes.

While there are unsaved edits, “● unsaved changes” («● есть изменения») is shown next to the button; after saving, “✓ Saved” («✓ Сохранено»). Rows with an empty Parameter field are not saved. If the table is empty, it is replaced by the text “No parameters — select a source or add them manually.” («Параметров нет — выберите источник или добавьте вручную.»)

Default values

A ready value in the Value column works as a default value. If the parameter didn't arrive in the request or arrived empty, the tracker takes the value from the campaign. If the parameter arrived, the value from the request is used.

Example: the campaign has the pixel parameter with the value 1234567890.

Requestpixel value in the click
https://track.example.com/abc12341234567890
https://track.example.com/abc1234?pixel=1234567890
https://track.example.com/abc1234?pixel=555555

A value that contains a curly brace, for example {{campaign.name}} or {sub_id_2}, is not substituted as a default value.

If the same parameter arrives in the request several times, the tracker takes the first non-empty value that isn't an unreplaced macro. For example, with ttclid=__CLICKID__&ttclid=abc123, abc123 is written to the click. A value counts as an unreplaced macro if it consists entirely of a macro like {x}, {{x}}, ${x}, [X], %x%, __X__ or ##X##. If there is no such value, the first of the received values is written to the click — for example, the macro text itself.

Cloaking with a required click-id doesn't count a parameter as received if it holds macro text instead of a value. This also applies to the default value from the campaign — see Ad platform and click-id.

The substituted value goes through the source's tokens the same way as a value sent in the link, and is available as a macro by the parameter name — see Macros in links and pages.

Parameters that don't get into the link

Some table rows are stored in the campaign but are not output in the traffic link.

What is hiddenConditionWhat the tracker does
Secret parametersParameter or Name equals token, access_token or capi_token, case-insensitive, or the value starts with EAASubstitutes the ready value from the campaign itself, as a default value
Ad platform click-idThe fbclid, gclid, ttclid or msclkid parameter with a value in single curly braces, for example {fbclid}Nothing: the platform appends the click-id to the link itself

Users who can't edit the campaign see *** instead of the values of secret parameters.

The tracker also uses the pixel and token rows with ready values as a fallback source of the Pixel ID and Access Token for the Facebook Conversions API — the selection order is on the Where the Pixel ID and Access Token come from page.

Opening a campaign with the campaign parameter

Instead of putting the campaign in the path, you can pass its alias in the campaign parameter:

text
https://track.example.com/?campaign=abc1234&utm_camp={{campaign.name}}

If the link has both an alias in the path and the campaign parameter, the tracker opens the campaign from the path. The campaign parameter is used when there is no path or there is no active campaign for the alias in the path.

Changing the alias

You change the alias in the Alias field of the Edit campaign window, which the Edit («Изменить») button on the campaign page opens. The tracker looks up a campaign only by its current alias.

Warning.

After you change the alias, the old link responds with 404. Replace the link in every ad account where it is used.

If streams with the Send to campaign action lead to this campaign, enter the new alias in their Target campaign alias («Alias целевой кампании») field.

Checking the result

  1. Click Copy in the Traffic link block.
  2. Open the link in a new browser tab.
  3. Go back to the campaign and click Statistics («Статистика»).
  4. Open the Click log («Лог кликов») tab.
  5. Click the row of your click.

If your click isn't in the log yet, click Refresh («Обновить»). In the click window, the Parameters (sub_id) («Параметры (sub_id)») and Tokens («Токены») blocks show the values the click was recorded with, including default values. The values of secret parameters are replaced with *** there.

If the link responds with 404, the causes are covered on the First campaign page. The stream selection check shows which stream a visitor with given parameters will get.

Updated Need help? ↗