API DocsKnowledge BaseSystem StatusContact SupportContact Sales
API Documentation

Replace traffic modifier

put
https://api.kevel.co/v1/forecaster/modifiers/traffic/

Replace the existing Forecast Traffic Modifier with the one received from this request.

Path Params
string
required
Body Params

The JSON object with the 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.

string
required

Unique identifier of the Traffic Modifier.

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).

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).

string
Defaults to UTC

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".

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.

string
enum
required
Allowed:
number
required

How many times to multiply traffic in the range.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 6 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 6 days ago