Skip to main content

Get Rule Dayparting Schedule

GET 

/api/advertising/rules/:rule/dayparting

Returns the dayparting schedules learned by the rule's latest completed real run, keyed by campaign ID. Each schedule holds a bid multiplier per ISO weekday (1 = Monday ... 7 = Sunday) and hour (0-23, in the account time zone), smoothed and clamped to the rule's multiplier range (0.5-1.5 by default), plus the per-hour multipliers across the week.

Required scope: advertising:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Each campaign also carries applied_multipliers: the effective multiplier the ad platform actually confirmed, per ISO weekday and hour (applied bid ÷ base bid, averaged across the campaign's targets), so what ran can be compared with what was learned. Only applied bids count: a bid that failed, was skipped (hold, cap or drift), rejected, expired or undone leaves no entry. For a campaign in hourly_bids mode it is filled by hourly bid changes; for a campaign in bid_schedule mode it is the schedule the platform confirmed on the latest applied bid-schedule change. It is an empty object until something has applied.

mode is bid_schedule when the platform accepts a native bid schedule (the run proposes it as a change) or hourly_bids when SKU.io applies hourly bid changes instead. campaigns is an empty object when the rule is not a dayparting rule or has not completed a run.

Requires the advertising.view permission and the Advertising Manager feature.

Request​

Responses​

OK

Response Headers
    Content-Type