QuerySpendCapCampaignAssignments

Returns the campaigns assigned to a spend cap.

By default, when neither effective_at nor effective_from is set, the response includes every assignment that is active today or scheduled to start later. "Today" begins at 00:00 in the platform's time zone.

  • Set effective_at to see the assignments that were active at a specific point in time.
  • Set effective_from to see every assignment active on or after a specific point in time, including assignments scheduled for the future.
  • If you set both and effective_at is earlier than effective_from, the response combines both: the assignments active at effective_at, plus every assignment active on or after effective_from.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of the platform who requests management api. It is passed as a path parameter.

string
required

AdAccount id.

string
required

Spend Cap id.

Body Params
date-time

Point in time to look up. Returns the assignments that were active at this time. Ignored when effective_from is also set and is not later than effective_at.

string

Cursor for pagination. Required after the first request.

int64
Defaults to 10

Number of assignment records to be returned. Maximum value: 50

date-time

Returns every assignment active on or after this point in time, including assignments scheduled for the future. If neither effective_at nor effective_from is set, defaults to 00:00 today in the platform's time zone.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json