200 Normal response, containing JSON response with network settings.

Object

sampling

• Type: integer
• Range: 0 to 3
• Description: The level of sampling to use (between 0 and 3). 3 provides the quickest response and 0 the highest accuracy.

dateRange

• Type: integer
• Range: ≥ 0
• Description: The default number of days for which forecasts will be calculated and results shown, starting from the current day.

dateAggregation

• Type: string
• Enum: The default date aggregation in the groupBy of the inventory results forecasts.
  • date
  • week
  • month

groupBy

• Type: array of strings
• Description: Break the forecast results down by the given GroupBy keys. Some caution should be used when choosing the GroupBy keys, as some keys may have thousands of possible values and can produce very large responses. For more details and the list of available keys, see this section.
• Note: When grouping by fields that are arrays, the default behavior is to group by the whole set. Alternatively, it is possible to expand the elements of the array and group by each of them by suffixing the field name with [], or by using the singular of the field (if it is one of the known array fields).
• Additionally: It's also possible to expand the key-value pairs of $user.custom by suffixing the field name with {}.

filterGroupBy

• Type: string | null
• Description: Filter the forecast grouped results breakdown by the given rule (Zerkel query) at the ad level. This rule operates on the following set of numeric fields for all forecast types: impressions, clicks, and uniqueUsers. Additionally, the Available forecast supports the bookedImpressions, bookedClicks, and bookedUniqueUsers fields, and the Deliverable and Existing forecasts the adId, flightId, campaignId, advertiserId, reservedAdId, reservedFlightId and reservedCampaignId fields. An extra key, groupedFiltered, is added to the forecast result containing all the results that were filtered out by the rule. If used in combination with the ResultsBy parameter, the advertiser, campaign and flight levels won't include the uniqueUsers count.

inventoryPriorities

• Type: array of integers
• Description: The priority IDs to be considered as the first paid priority of each channel. It should be set one per channel.

salesProbabilityWeight

• Type: integer | null
• Range: 0 to 100
• Description: The minimum sales probability weight threshold used to filter reserved campaigns. Reserved campaigns with a salesProbabilityWeight below this value will be excluded from forecasts. Set to 0 to include all reserved campaigns regardless of their sales probability.

Example Request

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

Example Response

{
  "sampling": 0,
  "dateRange": 90,
  "dateAggregation": "date",
  "groupBy": [
    "$adTypes",
    "$zone.id"
  ],
  "filterGroupBy": "bookedImpressions < 100 and bookedUniqueUsers < 100 or impressions >= 1000",
  "inventoryPriorities": [
    1111,
    12345
  ],
  "salesProbabilityWeight": 50
}