List ads

GET

/api/v1/ads/ads

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

• Digize

Every ad on every platform, the newest first, with its review state and results.

Needs the ads:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/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

id

required

string

campaignId

required

string

campaignName

required

string

adGroupId

required

string

adGroupName

required

string

platform

required

string

Allowed values: google meta tiktok linkedin microsoft pinterest

format

required

string

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

name

required

string

status

required

string

Allowed values: active in_review rejected paused

rejection

required

string | null

creative

required

object

headlines

required

Array<string>

<= 15 items

primaryText

required

string

<= 2200 characters

descriptions

required

Array<string>

<= 5 items

media

required

Any of:

object

object

kind

required

string

Allowed values: image video

name

required

string

<= 120 characters

tone

required

string

Allowed values: primary accent secondary success warning info destructive

seconds

required

number | null

sound

required

boolean

assetId

Any of:

string

string

<= 64 characters

null

null

thumbnail

Any of:

string

string

<= 2000 characters

null

null

null

null

callToAction

required

string

Allowed values: shop_now learn_more sign_up book_now subscribe get_offer

finalUrl

required

string

<= 2000 characters

displayUrl

required

string

<= 200 characters

createdAt

required

string format: date-time

orders

required

Store orders attributed to it, last 30 days.

number

Example

{
  "data": [
    {
      "platform": "google",
      "format": "google_search",
      "status": "active",
      "creative": {
        "media": {
          "kind": "image",
          "tone": "primary"
        },
        "callToAction": "shop_now"
      }
    }
  ]
}

400

What was sent isn’t valid (invalid).

Media typeapplication/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.

Media typeapplication/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.

Media typeapplication/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).

Media typeapplication/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.

Media typeapplication/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"
  }
}