List ad accounts

GET

/api/v1/ads/accounts

const url = 'https://digize.com/api/v1/ads/accounts';
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/accounts \
  --header 'x-api-key: <x-api-key>'

Each ad platform and whether its ad account is connected, with this month’s spend and conversion tracking.

Needs the ads:read permission.

Authorizations

apiKey
bearer

Responses

200

Done

application/json

object

data

required

Array<object>

object

platform

required

string

Allowed values: google meta tiktok linkedin microsoft pinterest

status

required

string

Allowed values: connected error disconnected

accountId

required

string | null

accountName

required

string | null

currency

required

string | null

spendLimit

required

number | null

spentThisMonth

required

number

syncedAt

required

Any of:

string
null

string format: date-time

connectedAt

required

Any of:

string
null

string format: date-time

connectedBy

required

string | null

error

required

string | null

tracking

required

object

name

required

string

required

string | null

status

required

string

Allowed values: active no_events not_set_up

lastEventAt

required

Any of:

string
null

string format: date-time

events

required

number

available

required

Array<object>

object

required

string

name

required

string

signedIn

required

Signed in at the platform, whether or not an ad account is chosen.

boolean

connectable

required

Whether Digize can connect it yet.

boolean

Example

{
  "data": [
    {
      "platform": "google",
      "status": "connected",
      "tracking": {
        "status": "active"
      }
    }
  ]
}

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"
  }
}