List campaigns

GET

/api/v1/ads/campaigns

const url = 'https://digize.com/api/v1/ads/campaigns';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://digize.com/api/v1/ads/campaigns \
  --header 'x-api-key: <x-api-key>'

Every campaign, the newest first, with its placement on each platform and what each did over the last 30 days.

Needs the ads:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

data

required

Array<object>

object

impressions

required

number

clicks

required

number

results

required

What the objective counts, as the platform reports it: purchases, leads, clicks or people reached.

number

spend

required

number

revenue

required

What the store’s orders attributed to it came to.

number

required

string

name

required

string

objective

required

string

Allowed values: sales leads traffic awareness

status

required

The most hopeful of its platforms’ statuses.

string

Allowed values: in_review active paused rejected ended

dailyBudget

required

number

startsAt

required

string format: date-time

endsAt

required

Any of:

string
null

string format: date-time

createdAt

required

string format: date-time

createdBy

required

string

finalUrl

required

string

audience

required

object

locations

required

Array<string>

<= 50 items

ageMin

required

integer

>= 13 <= 65

ageMax

required

65 means 65 and over.

integer

>= 13 <= 65

interests

required

Array<string>

<= 50 items

keywords

required

Array<string>

<= 200 items

audiences

required

Array<string>

<= 20 items

platforms

required

Array<object>

object

impressions

required

number

clicks

required

number

results

required

What the objective counts, as the platform reports it: purchases, leads, clicks or people reached.

number

spend

required

number

revenue

required

What the store’s orders attributed to it came to.

number

platform

required

string

Allowed values: google meta tiktok linkedin microsoft pinterest

status

required

string

Allowed values: in_review active paused rejected ended

externalId

required

The campaign’s id on the platform, once it’s there.

string | null

formats

required

Array<string>

Allowed values: google_search google_pmax facebook_feed instagram_feed instagram_story instagram_reels tiktok_feed linkedin_feed microsoft_search pinterest_pin

dailyBudget

required

number

rejection

required

string | null

publish

required

string

Allowed values: awaiting_approval pending published failed

orders

required

Store orders attributed to it, last 30 days.

number

awaitingApproval

required

Who it waits on before going out, by user id (* for any owner or admin); empty when it needn’t wait.

Array<string>

Example

{
  "data": [
    {
      "objective": "sales",
      "status": "in_review",
      "platforms": [
        {
          "platform": "google",
          "status": "in_review",
          "formats": [
            "google_search"
          ],
          "publish": "awaiting_approval"
        }
      ]
    }
  ]
}

400

What was sent isn’t valid (invalid).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

application/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}