Sign in
Traffic Modifiers

Create traffic modifier

Create a Forecast Traffic Modifier

post/forecaster/modifiers/traffic

Request body

Idstring required

Unique identifier of the Traffic Modifier.

StartDatestring date-time required

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

EndDatestring date-time required

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

TimeZonestring

The time zone of the modifier's start and end dates (available time zones). 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".

Rulestring

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'adRequestMultiplier' required
Multipliernumber required

How many times to multiply traffic in the range.

Example request

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

Response

The JSON object of the traffic modifier that was created successfully.

0 required— unresolved $ref
OR
1 required— unresolved $ref
OR
2 required— unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.