Follow

How to use Cap management system?

Cap is an indicator that characterizes the conversions’ limit.

It has several parameters:

1. Timeframe is a time cap’s parameter. It indicates a period of time, the cap option is enabled. It may be:

  • daily - it correlates with the conversion creation date. It’s calculated for 24 hours according to your settings’ time zone and its reset occurs at midnight. It’s also possible to set up the time zone due to the offer’s requirements.  
  • month - it’s calculated for a calendar month, e.g. if cap is set up on 15.11 the calculation is from 15.11 till 30.11 and it’ll be reset again on 01.12.
  • all - total cap, it’s calculated for the entire time, when the offer receives the traffic.

2. Type is a parameter that denotes the value the cap is limited by. It may be:

  • conversions - cap is limited by the number of conversions.
  • budget - cap is limited by the sum of conversions’ payouts (by conversions’ budget). It means if there’s a currency of EUR in the payout offer settings, the cap calculation is carried out in EUR.

3. Value is the actual limit’s measure.

4. Goal is a parameter, that is used for determination when cap’s limit is reached. It may be:

  • all - totally for all goals;
  • each - for each offer’s goal;
  • select  - for a specific chosen goal value.

Caps.png

5. Affiliate is an affiliate, the cap is chosen for. It may be:

  • all - totally for all affiliates who have access to the offer;
  • each - for each affiliate enabled to the offer:

a) if an offer’s privacy level is “public” - for each affiliate that has “Active” status;
b) if an affiliate isn’t disabled from the offer or the advertiser.

  • select - for a specific chosen affiliate by pib id.

each__select__all.png

Cap’s additional settings

Overcap allows manage traffic flow when cap is reached.

overcap.jpg

If the cap is reached - the incoming traffic will be redirected to the local Trafficback URL (at the offer’s level). If there’s no local Trafficback URL, but there’s  Preview URL and/or Global Trafficback URL, and besides the box 'Use by other reasons' is ticked -  the incoming traffic will be redirected to the Global Trafficback URL.

6116607.jpg

If the box 'Use by other reasons' isn’t ticked - the incoming traffic will be redirected to the Preview URL of the offer.

Overcap works based on the principle of traffic redirection to the Trafficback URL only if the chosen goal is 'all' (Goal=All). The case, when the goal equals to Goal=Each/Select and Overcap is ticked, is described below.

TB.jpg

Note: When Overcap is ticked with the chosen Goal=Each/Select, clicks won’t be redirected to the Trafficback URL when the cap is reached. The offer will still accept the incoming traffic, but the conversions on the clicks, accepted over the limit, will be automatically declined with the comment [Cap is reached]. The reason is Goal value can’t be determined at the incoming click level, the goal could be determined only at the advertiser’s postback level and is recorded for a conversion in Affise.

Hide caps in partner interface

There's a box for hiding caps in the affiliate’s panelIf there’s a personal cap (Affiliate=Select), it’s shown as a progress bar in the affiliate’s panel, if there’s no personal cap, but there’s a total cap for the offer (Affiliate=All), the total cap value is shown in the affiliate’s panel (without progress bar).

Note that such cap as monthly/all isn’t shown in the affiliate’s panel.

hide_caps_in_partner_interface.jpg

Timezone

Timezone is a time zone the cap is selected for.

caps_tz.png

Conversion status for caps count

_______________________.jpg

The option allows to set up conversions' statuses for caps. It works for all cap periods and types (converions or budget). 
For example if there's cap set up Type=Conversions, Value=50, Conversion Status=Approved, the cap algorythm will check it constantly with the stats service every 3 minutes and deetct if there's such an amount.
It's necessary to state that if there're already 50 approved conversions and 20 of these conversions will be declined, the cap algorythm will detect it in 3 minutes and keep up reaching until the set up value.
The default value includes all conversions' statuses.
It's necessary to mention that the option presents also in Settings - Security:
______________.jpg

To enable Conversion status for caps count via API is possible using these methods POST /3.0/admin/offer/ and POST /3.0/admin/offer/{ID} respectively:
_______caps_API.jpg


Caps Top Section

In the section "Caps Top" on Dashboard there'll be depicted offers where the cap is set up for Goal=All and Affiliate=All only.

dashboard_caps.png

Cap via API

Cap category is added via API with the help of API call POST /3.0/admin/offer if you create an offer and the call POST /3.0/admin/offer/{ID} if you edit the offer.

Cap is set up according to the API doc, but there’s a peculiarity of the structure caps[0][affiliates][] and caps[0][goals][].

So, to set up cap for the type of Affiliate=Select for two affiliates with IDs 1 и 3, we need to use the following structure:

Caps[0][affiliates][0] = 1

Caps[0][affiliates][1] = 3

The same algorithm works when goals are set up.

The structures [affiliates][] or [goals][] are indicated, only when the cap of Affiliate=Select or Goal=Select is set up.

Raw input: caps[0][period]=day&caps[0][type]=conversions&caps[0][affiliate_type]=exact&caps[0][affiliates][]=36&caps[0][value]=26&caps[0][goal_type]=exact&caps[0][goals][]=1&caps[1][period]=month&caps[1][type]=conversions&caps[1][affiliate_type]=exact&caps[1][affiliates][1]=37&caps[1][value]=30&caps[1][goal_type]=exact&caps[1][goals][1]=1

caps.jpg

To enable 'Hide caps in partner interface' via API is possible using the following method while creating/editing an offer POST /3.0/admin/offer/POST /3.0/admin/offer/{ID}

FAQ:

'What statuses are taken for cap’s calculation?'

Cap includes all the conversions’ statuses, i.e. when cap is set up for 50 conversions, there could be 30 approved and 20 declined conversions, for example with the comment [Payments not found], these conversions will also be calculated into cap.

'I have an overflow on cap. Why?'

Please, mind the click’s time: conversions, recorded for clicks received before the time cap was reached, will be accepted but as declined with the comment [Cap is reached]. The server postback from the advert will be accepted properly, with the status '1', but the conversion itself will be rejected, as the postback is accepted later, than the cap was  reached.
To figure out if the conversion is accepted within the necessary timeframe, please, mind the below date stands for the click date and the above date stands for the conversion date.

date.png

‘I have an overflow on cap. The traffic doesn’t go to Overcap immediately. Why?’

It’s normal for the Overcap system to be enabled within 3 minutes. It’s acceptable to receive clicks at the time of 3 minutes when cap limit is reached and Overcap is about to be enabled.

‘If I have several caps, how to define what Cap is reached earlier?’

The cap of the highest priority is the total cap,  i.e. the cap that has Affiliate=All and Goal=All set up as all. So, when the cap set up as Goal=All and Affiliate=All is reached, it automatically stops the other caps’ work. Further priorities are allocated according to the table, where 1 - the highest priority, and 9 - the lowest.

Goal

 Affiliate 

 

 All 

 Select 

 Each 

All

1

2

3

 Select 

4

5

6

Each

7

8

9

!NB Caps' types Conversions and Budget have the same priority.

 

‘Why doesn’t my affiliate see the cap set up for him?’

Please, check if the box 'Hide caps' is ticked on the platform level in the section Settings - Affiliate dashboard design - General or on the offer level:

Screenshot_5.png

hide_caps_in_partner_interface.jpgShould you have any further questions, feel free to contact support@affise.com.

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.