Skip to main content
GET
Read a campaign's ad schedule (dayparting)

Request contract

  • Method and path: GET /apis/v1/ads/campaigns/{campaignId}/ad-schedule
  • Availability: enabled
  • Request URL template: https://api.aisa.one/apis/v1/ads/campaigns/{campaignId}/ad-schedule
  • campaignId: path; required
  • connectionId: query; required
  • platform: query; optional
  • includePerformance: query; optional
  • windowDays: query; optional
  • fromDate: query; optional
  • toDate: query; optional
  • Runtime facts: fe60122939c67dc98a3a6ac6b97bd5c326b526105150c8959304dd2160d4dd09
Complete OpenAPI definition Effective request and pricing declaration (including authentication and referenced schemas):

Cost and request rules

A request reference price is not currently available; use a request quote where supported. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaignId
string
required

Numeric Google platform campaign id.

Query Parameters

connectionId
string
required

The ads connection (adc_...) the request runs on: one of yours, from GET /apis/v1/ads/connections. On a request with a JSON body it may be sent as a top-level body member instead.

Pattern: ^adc_[0-9A-Za-z]+$
platform
enum<string>

Disambiguates the campaign id when the connection spans platforms.

Available options:
google
includePerformance
boolean

Also return delivery by day of week and by hour. Costs one extra Google call.

windowDays
integer
default:30

Trailing window for the performance split. Ignored when fromDate and toDate are both given.

Required range: 1 <= x <= 90
fromDate
string<date>

Start of an explicit performance range (YYYY-MM-DD). Use together with toDate.

toDate
string<date>

End of an explicit performance range (YYYY-MM-DD). Must be on or after fromDate.

Response

The campaign's ad schedule

cachedAt
string<date-time> | null
campaignId
string
performance
object

Only present when includePerformance=true.

schedule
object[]
servesAroundTheClock
boolean

True when the campaign carries no ad schedule at all, so it can serve at any time.

stale
boolean

True when a quota-exhausted read served the last-good copy.