API DocsKnowledge BaseSystem StatusContact SupportContact Sales
API Documentation

Request forecast

post
https://api.kevel.co/v1/forecaster

Request a forecast to be started.

Body Params

The JSON object that describes the forecast request.

string
enum
required
Allowed:
date-time

Start date of the available forecast from which availability will be checked, as yyyy-mm-dd'T'HH:mm:SS or yyyy-mm-dd (default time of 00:00:00), in the passed TimeZone or UTC if omitted.

date-time
required

End date of the available forecast, must be after current date, as yyyy-mm-dd'T'HH:mm:SS or yyyy-mm-dd (default time of 23:59:59), in the passed TimeZone or UTC if omitted.

string
Defaults to UTC

The time zone of the available forecast's start and end dates (available time zones). Additionally, day parting is evaluated in the available forecast's time zone.

Targeting
object

The specified targeting for the available forecast.

integer

The priority weight at which availability will be calculated, impressions for existing ads with a "lower" priority than this will be considered available. This does not take into consideration ordering and filtering done at the site or channel level.

integer

The ID of a Kevel Priority at which availability will be calculated, impressions for existing ads with a "lower" priority than this will be considered available.

NewAds
array of objects

The new ad or ads to consider in the availability request.

NewAds
Modifiers
object

Manual Forecast Modifiers to apply to this forecast request. Currently, only Traffic Modifiers are supported. Traffic modifiers operate at the Ad Request level and make it possible to manually modify the volume of Ad Request in a certain date range and, optionally, that follow a targeting rule.

Params
object
Responses

Callback

Updated 7 months ago

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

Updated 7 months ago