v2 List Audiences

GET

saved

audiences

Copy
curl --request GET \
  --url https://api.globalwebindex.com/v2/saved/audiences \
  --header 'Authorization: <api-key>'

Copy
{
  "meta": null,
  "data": [
    {
      "id": "8f568af7-a225-40fd-992f-839d8f0ed499",
      "name": "Male with credit card and short-term load",
      "expression": {
        "and": [
          {
            "question": "q2",
            "datapoints": [
              "q2_1"
            ]
          },
          {
            "question": "gwi-ext.q1014a",
            "datapoints": [
              "q1014a",
              "q1014b"
            ],
            "suffixes": [
              "1"
            ]
          }
        ]
      },
      "flags": [
        "authored",
        "curated",
        "isP2"
      ],
      "folder_id": "b140035b-3adc-43bf-a39d-8e8005c8af2a",
      "position": 128.1,
      "permissions": {
        "audience_overall": "accessible"
      },
      "datasets": [
        "ds-core",
        "ds-96c906f1"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Query Parameters

folder_id

string

List audiences from given folder only

flags

string[]

List audiences with a given flag(s) only

Response

200

application/json

Collection of all available audiences.

data

object[]

List of audiences

data.id

string

required

Unique ID of saved audience

data.v1_id

integer

required

v1 ID of an audience if applicable or null

data.name

string

required

Human readable name

data.expression

object

required

Flexible expression of audience scope.

data.expression.and

object[]

List of sub-expressions to apply intersection of their scopes.

Flexible expression of audience scope.

data.expression.and.and

object[]

List of sub-expressions to apply intersection of their scopes.

Flexible expression of audience scope.

data.expression.and.and.and

object[]

List of sub-expressions to apply intersection of their scopes.

Flexible expression of audience scope.

data.expression.and.and.or

object[]

List of sub-expressions to apply union of their scopes.

Flexible expression of audience scope.

data.expression.and.and.not

boolean

To use negation of the expression.

data.expression.and.and.question

string

Question code to define datapoint scope.

Example:

"q2"

data.expression.and.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

data.expression.and.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses. Array can be empty.

Example:

["1", "2", "3"]

data.expression.and.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

data.expression.and.or

object[]

List of sub-expressions to apply union of their scopes.

Flexible expression of audience scope.

data.expression.and.or.and

object[]

List of sub-expressions to apply intersection of their scopes.

Flexible expression of audience scope.

data.expression.and.or.or

object[]

List of sub-expressions to apply union of their scopes.

Flexible expression of audience scope.

data.expression.and.or.not

boolean

To use negation of the expression.

data.expression.and.or.question

string

Question code to define datapoint scope.

Example:

"q2"

data.expression.and.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

data.expression.and.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses. Array can be empty.

Example:

["1", "2", "3"]

data.expression.and.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

data.expression.and.not

boolean

To use negation of the expression.

data.expression.and.question

string

Question code to define datapoint scope.

Example:

"q2"

data.expression.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

data.expression.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses. Array can be empty.

Example:

["1", "2", "3"]

data.expression.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

data.expression.or

object[]

List of sub-expressions to apply union of their scopes.

Flexible expression of audience scope.

data.expression.or.and

object[]

List of sub-expressions to apply intersection of their scopes.

Flexible expression of audience scope.

data.expression.or.and.and

object[]

List of sub-expressions to apply intersection of their scopes.

Flexible expression of audience scope.

data.expression.or.and.or

object[]

List of sub-expressions to apply union of their scopes.

Flexible expression of audience scope.

data.expression.or.and.not

boolean

To use negation of the expression.

data.expression.or.and.question

string

Question code to define datapoint scope.

Example:

"q2"

data.expression.or.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

data.expression.or.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses. Array can be empty.

Example:

["1", "2", "3"]

data.expression.or.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

data.expression.or.or

object[]

List of sub-expressions to apply union of their scopes.

Flexible expression of audience scope.

data.expression.or.or.and

object[]

List of sub-expressions to apply intersection of their scopes.

Flexible expression of audience scope.

data.expression.or.or.or

object[]

List of sub-expressions to apply union of their scopes.

Flexible expression of audience scope.

data.expression.or.or.not

boolean

To use negation of the expression.

data.expression.or.or.question

string

Question code to define datapoint scope.

Example:

"q2"

data.expression.or.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

data.expression.or.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses. Array can be empty.

Example:

["1", "2", "3"]

data.expression.or.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

data.expression.or.not

boolean

To use negation of the expression.

data.expression.or.question

string

Question code to define datapoint scope.

Example:

"q2"

data.expression.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

data.expression.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses. Array can be empty.

Example:

["1", "2", "3"]

data.expression.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

data.expression.not

boolean

To use negation of the expression.

data.expression.question

string

Question code to define datapoint scope.

Example:

"q2"

data.expression.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

data.expression.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses. Array can be empty.

Example:

["1", "2", "3"]

data.expression.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

Example:

{
  "and": [
    {
      "question": "q2",
      "datapoints": ["q2_1", "q2_2"],
      "min_count": 1,
      "not": false
    },
    {
      "question": "q6",
      "datapoints": ["q6_2"],
      "min_count": 1,
      "suffixes": ["1", "2", "3"],
      "not": false
    }
  ]
}

data.created_at

string

required

when item was created

data.updated_at

string

required

when item was updated

data.folder_id

string

required

null/nil uuid or folder uuid

data.position

number

required

items are sorted by numeric position

data.permissions

object

required

data.permissions.permissions

object

required

Example:

{
  "meta": { "limit": 5, "offset": 15, "count": 100 },
  "data": ["..."]
}

data.datasets

string[]

required

dataset codes

data.flags

enum<string>[]

additional flags about audience

Flags:

authored: User owns the entity
curated: GWI shared the entity to others
isP2: item created by Platform2

Available options:

authored,

curated,

isP2

v2 Filter Audiences v2 Replace Audience

Copy
curl --request GET \
  --url https://api.globalwebindex.com/v2/saved/audiences \
  --header 'Authorization: <api-key>'

Copy
{
  "meta": null,
  "data": [
    {
      "id": "8f568af7-a225-40fd-992f-839d8f0ed499",
      "name": "Male with credit card and short-term load",
      "expression": {
        "and": [
          {
            "question": "q2",
            "datapoints": [
              "q2_1"
            ]
          },
          {
            "question": "gwi-ext.q1014a",
            "datapoints": [
              "q1014a",
              "q1014b"
            ],
            "suffixes": [
              "1"
            ]
          }
        ]
      },
      "flags": [
        "authored",
        "curated",
        "isP2"
      ],
      "folder_id": "b140035b-3adc-43bf-a39d-8e8005c8af2a",
      "position": 128.1,
      "permissions": {
        "audience_overall": "accessible"
      },
      "datasets": [
        "ds-core",
        "ds-96c906f1"
      ]
    }
  ]
}

Getting started

Use Cases

Transition from V1 to V2 API

Platform API

v2 List Audiences

Authorizations

Query Parameters

Response