campaigns

Get a campaign

Returns the campaign with everything needed to act on it.

  • delivery: one entry per platform the campaign runs on, with its state, the reasons[] behind that state (cause first), and since.
  • deliverySummary: the worst of those states, with its platform and reasons. This is the answer to "is it serving, and if not, why?".
  • adScheduleStructured: the weekly schedule as stored (windows[] plus timezone), present once a schedule has been set.
  • adSchedule: the schedule as you last wrote it, either a preset name or the structured object.
  • _platformBudgets: where the campaign runs and how the budget is shared, as you set it.

States: SERVING, LEARNING, LIMITED_BUDGET, NOT_SERVING, NOT_LIVE_YET, NOT_EXPORTED, PAUSED, ENDED. A campaign that has never been synced is NOT_EXPORTED.

Errors

  • 404 NOT_FOUND: no campaign with this id in the active Space.
get/api/v1/campaigns/{id}

Request

  • Base URL: https://api.growomat.com
  • URL: https://api.growomat.com/api/v1/campaigns/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The campaign id.

Headers

X-Space-Idstring

The Space to work in, for example spc_8f3aK2. Omit it to use your personal Space. List your Spaces returns the ids. A Space that does not exist returns 404 SPACE_NOT_FOUND; one you are not a member of returns 403 NOT_A_MEMBER.

Response

OK. The result is in data. List responses also carry meta with nextCursor and total.

dataunknown required

Changes

No recorded changes to this operation across all 2 revisions of this API.