Audience rules

GET

/api/v1/ads/audiences/options

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

• Digize

The CRM segments a new audience can be built from with how many people each matches now, the audiences a lookalike can start from, and the platforms connected.

Needs the ads:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

segments

required

Array<object>

object

id

required

string

label

required

string

size

required

number

seeds

required

Array<object>

object

id

required

string

label

required

string

size

required

number

platforms

required

Array<string>

Allowed values: google meta tiktok linkedin microsoft pinterest

lookalikeBase

required

number

platforms

required

The platforms connected now, which audiences can sync to.

Array<string>

Allowed values: google meta tiktok linkedin microsoft pinterest

lookalikePlatforms

required

Array<string>

Allowed values: google meta tiktok linkedin microsoft pinterest

Example

{
  "seeds": [
    {
      "platforms": [
        "google"
      ]
    }
  ],
  "platforms": [
    "google"
  ],
  "lookalikePlatforms": [
    "google"
  ]
}

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