campaigns

List campaigns

Campaigns in the active Space. Every campaign carries its delivery status:

  • delivery: one entry per platform the campaign runs on, with platform, state, the reasons[] behind that state (cause first), since and updatedAt.
  • deliverySummary: the worst of those states, with its platform and reasons. This is the answer to "is it serving, and if not, why?". null until the campaign has been synced.

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

get/api/v1/campaigns

Request

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

Query parameters

limitinteger

How many items to return per page. Default 50, maximum 200.

string
OR
number

Where to continue from: the meta.nextCursor value of the previous page. Omit it for the first page.

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 1 revision of this API.