Documentation sections

Stream schedule and click caps

How to limit a stream's operation by days of the week, time of day and the number of entries per hour, per day and in total.

The schedule and caps are set in the Stream settings («Настройки потока») window on the Schedule («Расписание») tab. To open the window, go to the campaign's Streams («Потоки») tab and click + Stream («+ Поток») or the gear button in the stream card. Changes take effect after you click Save stream («Сохранить поток»).

General rules

  • A stream gets traffic only if it is enabled, within its schedule, the click passes its filters and its caps are not exhausted.
  • A stream outside its schedule or with an exhausted cap is skipped, and the tracker chooses another matching stream in the usual order.
  • The schedule and caps work in streams of any type, including the final one.
  • The check happens on entry via the campaign link. The click-through from a landing page to an offer of a visitor who has already entered the stream is not limited by the schedule or caps.
  • The schedule and the caps have their own time zones. They are set separately and can differ.
Warning.

If all matching streams are outside their schedule or have exhausted their caps, the visitor gets a 404 response. To avoid losing such traffic, keep a final stream without a schedule and caps in the campaign.

Schedule

The Schedule field takes two values:

  • Around the clock («Круглосуточно») — the stream always works. This is the default.
  • Custom hours («Своё время») — the stream works on the selected days and hours. The fields from the table appear.
FieldWhat it setsDefault
Time zone (UTC) («Часовой пояс (UTC)»)The zone used to count days and time. Start typing a city or zone and pick an option from the list, for example Europe/Moscow. An empty field means UTCUTC
Days of week («Дни недели»)The Mon («Пн»), Tue («Вт»), Wed («Ср»), Thu («Чт»), Fri («Пт»), Sat («Сб») and Sun («Вс») buttons. Selected days are highlightedNothing selected — any day
From (hours) («С (часы)»)Start of the window, hours and minutes09:00
To (hours) («До (часы)»)End of the window, hours and minutes23:00

How the window is counted:

  • If no day is selected or all seven are selected, the stream works on any day.
  • Both boundaries are included in the window: with 09:00–23:00 the stream works from 09:00 until the end of the 23:00 minute.
  • If the start is later than the end, the window spans midnight: with 22:00–06:00 the stream works from 22:00 to 06:00 the next morning.
  • The day of the week is checked by the current date in the selected time zone. With the 22:00–06:00 window and only Fri selected, the stream works on Friday from 00:00 to 06:00 and from 22:00 to the end of the day. After midnight on the night into Saturday, it does not work unless Sat is selected.
  • For the stream to work around the clock on the selected days, set the window to 00:00–23:59.
  • With equal From (hours) and To (hours) values, for example 00:00–00:00, the stream works for one minute a day.

To remove the schedule, choose Around the clock and save the stream.

Click caps

The Click caps («Лимиты кликов») block is at the top of the tab. The three caps work independently: the stream is skipped as soon as any of them is reached.

FieldWhat it limitsDefaultAllowed values
Per hour («В час»)The number of entries in the current hour0An integer from 0 to 1,000,000,000,000
Per day («В день»)The number of entries in the current day0An integer from 0 to 1,000,000,000,000
Total («Всего»)The number of entries for all time0An integer from 0 to 1,000,000,000,000
Caps time zone («Часовой пояс лимитов»)The zone used to count the hour and the dayUTCThe zone name is typed manually and is case-sensitive, for example Europe/Moscow. An empty field means UTC

0 means no limit. The hour and the day are calendar ones: the Per hour count starts anew at the beginning of every hour, the Per day count at midnight in the caps time zone.

What counts as an entry

  • An entry is a click on the campaign link that the tracker sent to this stream. Repeat visits of the same visitor are counted too.
  • A visitor's return after the JS challenge is not counted as a second entry.
  • Entries are counted while at least one cap is set. Clicks that came before the caps were enabled are not counted, so the number may differ from the clicks in the stream statistics.
  • An entry is counted when the stream is chosen and stays in the count even if serving the page afterwards ended with an error.
  • Caps also apply to a returning visitor with binding: if the bound stream's cap is exhausted, another stream is chosen.

The “Counted” counter

In a saved stream, under each cap there is a “Counted: N” («Учтено: N») line — how many entries are counted for the current hour, the current day and in total. The values are read when the window opens. To refresh them, close the window and open the stream settings again.

  • Changing the caps and other stream settings does not reset the Total count.
  • A stream that has reached its Total cap gets traffic again if you raise this cap above the “Counted” value or set it to 0.
  • After you change the zone in the Caps time zone field, the day count starts anew.
  • A stream copy and a stream created from a template have their own counters, starting from zero.
  • A team member with restricted report fields does not see the “Counted” values: the block shows the line “Counters temporarily unavailable” («Счётчики временно недоступны»).
Tip.

In the stream selection check via the Check stream («Проверить поток») button, a stream with an exhausted cap is marked with the reason “Click cap reached” («Достигнут лимит кликов»), and a stream outside its schedule with “Outside the schedule” («Вне расписания»).

If the counters are unavailable

While the tracker cannot read the counters, streams with caps are skipped and traffic goes to matching streams without caps. If there are no such streams, the visitor gets a 503 response. After recovery, streams with caps take part in distribution again. In the stream selection check, such a stream is marked with the reason “Cap counter unavailable” («Счётчик лимитов недоступен»).

Stream checkboxes

At the bottom of the Schedule tab there are two checkboxes.

  • Stream active («Поток активен») — on for a new stream, off for a stream from a template or a JSON file. A disabled stream takes no part in distribution; in the card its name has the “paused” («пауза») label. The switch on the left of the stream card does the same.
  • Hide click counter («Скрывать счётчик кликов») — off by default. When it is on, the stream card shows “—” instead of numbers under the “clicks” («клики») caption, and the counter does not open the stream statistics. Clicks are recorded and visible in reports. The checkbox is meant for the “white” stream.

Error messages

If the window did not close after you clicked Save stream, the stream was not saved. The save error text is shown at the top of the campaign page. JSON import errors are shown in the Stream templates («Шаблоны потоков») window — see Stream templates, export and import.

MessageCauseWhat to do
“Check the click caps and their time zone” («Проверьте лимиты кликов и их часовой пояс»)A cap is not an integer, is less than 0 or greater than 1,000,000,000,000, or the zone in the Caps time zone field is not recognized. The window switches to the Schedule tabFix the value and save the stream
“Click caps: integers from 0 to 1,000,000,000,000” («Лимиты кликов: целые числа от 0 до 1 000 000 000 000»)A server response: a cap is out of the allowed range. Occurs when importing a stream from JSON and when working via the APIEnter an integer within these limits
“Unknown cap time zone” («Неизвестный часовой пояс лимита»)A server response: the caps zone is not recognized. Occurs when importing a stream from JSON and when working via the APIEnter a zone name like Europe/Moscow
“Unknown time zone — choose from the list, otherwise the schedule will be in UTC.” («Неизвестная таймзона — выберите из списка, иначе расписание будет в UTC.»)A hint under the Time zone (UTC) field: the entered zone is not recognizedChoose a zone from the dropdown list. With an unrecognized zone, the stream will not be saved
“Unknown time zone ‘…’ — choose a zone from the list (e.g. Europe/Moscow)” («Неизвестный часовой пояс «…» — выберите зону из списка (напр. Europe/Moscow)»)A stream with the Custom hours schedule is being saved with an unrecognized zone. The window switches to the Schedule tabChoose a zone from the list and save the stream
“Counters temporarily unavailable”A line in the Click caps block: the panel did not get the “Counted” values. This happens when the counters are unavailable or the team member has restricted report fieldsOpen the stream settings later. With restricted report fields, the values are not shown
Updated Need help? ↗