Traffic Modifier

A traffic modifier that multiplies the targeted Ad Requests by a constant amount.

If this Traffic Modifier is active during a forecast, a MODTRF warning will be triggered.

Properties

Id

• Type: string
• Required: Yes
• Unique identifier of the Traffic Modifier.

StartDate

• Type: date-time
• Required: Yes
• Start date for the traffic modifier, as yyyy-mm-dd'T'HH:mm:SS or yyyy-mm-dd (default time of 00:00:00).

EndDate

• Type: date-time
• Required: Yes
• End date for the traffic modifier, as yyyy-mm-dd'T'HH:mm:SS or yyyy-mm-dd (default time of 23:59:59).

TimeZone

• Type: string
• Defaults to UTC
• The time zone of the modifier's start and end dates. Additionally, the rule is evaluated in the modifier's time zone, i.e. if the modifier is set to "EST" a rule like $datetime.hour > 10 assumes that the given hour is in "EST".

Rule

• Type: string
• The rule used to filter the Ad Requests (Zerkel query). The traffic modifier will only be applied to Ad Requests who conform to this rule.

Type

• Type: string
• Enum:
• Required: Yes
• adRequestMultiplier

Multiplier

• Type: number
• Required: Yes
• How many times to multiply traffic in the range.

Example Usage

Shell

curl --request GET \
     --url https://api.kevel.co/v1/forecaster/modifiers/traffic/trafficModifierId \
     --header 'accept: application/json'

Example Response

{
  "Id": "e123e48",
  "StartDate": "2024-09-03T00:00:00",
  "EndDate": "2024-09-04T23:59:59",
  "TimeZone": "UTC",
  "Rule": "$location.countryCode = \"GB\"",
  "Type": "adRequestMultiplier",
  "Multiplier": 2
}