v2 Create Audience

curl --request POST \
  --url https://api.globalwebindex.com/v2/saved/audiences \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Male with credit card and short-term loan",
  "expression": {
    "and": [
      {
        "question": "q2",
        "datapoints": [
          "q2_1"
        ]
      },
      {
        "question": "gwi-ext.q1014a",
        "datapoints": [
          "q1014a",
          "q1014b"
        ],
        "suffixes": [
          "1"
        ]
      }
    ]
  },
  "folder_id": "b140035b-3adc-43bf-a39d-8e8005c8af2a",
  "position": 128,
  "datasets": [
    "ds-core",
    "ds-96c906f1"
  ]
}
'

{
  "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": "containsUnknownData"
    },
    "datasets": [
      "ds-core",
      "ds-96c906f1"
    ]
  }
}

POST

saved

audiences

v2 Create Audience

curl --request POST \
  --url https://api.globalwebindex.com/v2/saved/audiences \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Male with credit card and short-term loan",
  "expression": {
    "and": [
      {
        "question": "q2",
        "datapoints": [
          "q2_1"
        ]
      },
      {
        "question": "gwi-ext.q1014a",
        "datapoints": [
          "q1014a",
          "q1014b"
        ],
        "suffixes": [
          "1"
        ]
      }
    ]
  },
  "folder_id": "b140035b-3adc-43bf-a39d-8e8005c8af2a",
  "position": 128,
  "datasets": [
    "ds-core",
    "ds-96c906f1"
  ]
}
'

{
  "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": "containsUnknownData"
    },
    "datasets": [
      "ds-core",
      "ds-96c906f1"
    ]
  }
}

Authorizations

Authorization

string

header

required

Body

application/json

audience to store

name

string

required

Human readable name

expression

Expression · object

required

Flexible expression of audience scope.

Show child attributes

expression.and

array

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

expression.or

array

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

expression.not

boolean

To use negation of the expression.

expression.question

string

Question code to define datapoint scope.

Example:

"q2"

expression.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

expression.suffixes

string[]

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

Example:

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

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

folder_id

string

required

null/nil uuid or folder uuid

position

number

required

Position to give to be able to sort.

flags

enum<string>[]

additional flags about audience

Flags:

authored: User owns the entity
curated: GWI shared the entity to others
isP2: Audience was created by Platform 2 application

Available options:

authored,

curated,

isP2

datasets

string[]

dataset codes

Response

Saved audience

string

required

Unique ID of saved audience

v1_id

integer

required

v1 ID of an audience if applicable or null

name

string

required

Human readable name

expression

Expression · object

required

Flexible expression of audience scope.

Show child attributes

expression.and

array

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

expression.or

array

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

expression.not

boolean

To use negation of the expression.

expression.question

string

Question code to define datapoint scope.

Example:

"q2"

expression.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

expression.suffixes

string[]

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

Example:

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

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

created_at

string

required

when item was created

updated_at

string

required

when item was updated

folder_id

string

required

null/nil uuid or folder uuid

position

number

required

items are sorted by numeric position

permissions

object

required

Show child attributes

permissions.permissions

object

required

Show child attributes

permissions.permissions.audience_overall

string

required

Strings accessible or containsUnknownData describe overall permission of a user to an audience.

permissions.permissions.code

integer

required

This field is kept for consistency with query-es route permissions response. It is not used in saved-data at all.

permissions.permissions.error

string

Error describes what kind of error occured if there was one. This field explains better errorType field.

permissions.permissions.errorType

string

Type of the error

Example:

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

datasets

string[]

required

dataset codes

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 Audience Detail v2 Delete Audience

⌘I

Getting started

Use Cases

Transition from V1 to V2 API

Platform API

v2 Create Audience

Authorizations

Body

Response