Skip to content
digizeDocs

List audiences

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

Every audience, the newest first: the CRM segments and lookalikes kept in sync with the ad platforms, with how each platform matched it.

Needs the ads:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string
name
required
string
source
required
string
Allowed values: segment lookalike
rule
required

Who’s in it, in plain words.

string
size
required

CRM contacts it holds, or for a lookalike, about how many the platform says it reaches.

number
platforms
required
Array<object>
object
platform
required
string
Allowed values: google meta tiktok linkedin microsoft pinterest
matchRate
required

The share of its people the platform matched, from 0 to 1; null until it says, and for lookalikes.

number | null
state
required
string
Allowed values: pending syncing synced failed
error
required
string | null
status
required
string
Allowed values: synced syncing failed
error
required

Why the last sync failed somewhere.

string | null
syncedAt
required
Any of:
string format: date-time
createdAt
required
string format: date-time
campaigns
required

The campaigns that target it.

Array<string>

Example 

{
  "data": [
    {
      "source": "segment",
      "platforms": [
        {
          "platform": "google",
          "state": "pending"
        }
      ],
      "status": "synced"
    }
  ]
}

400

Section titled “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

Section titled “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

Section titled “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

Section titled “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

Section titled “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"
  }
}