Skip to main content
PATCH
/
v2
/
saved
/
audiences
/
{id}
v2 Update Audience
curl --request PATCH \
  --url https://api.globalwebindex.com/v2/saved/audiences/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "folder_id": "b140035b-3adc-43bf-a39d-8e8005c8af2a",
  "position": 1.5
}'
{
  "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

Path Parameters

​
id
integer
required

Audience ID

Body

application/json

audience to patch

​
name
string

Human readable name

​
expression
object

Flexible expression of audience scope.

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

null/nil uuid or folder uuid

​
position
integer

items are sorted by numeric position

​
flags
enum<string>[]

additional flags about audience

​
datasets
string[]

dataset codes

Response

Collection of all available audiences.

​
id
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
object
required

Flexible expression of audience scope.

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
​
datasets
string[]
required

dataset codes

​
flags
enum<string>[]

additional flags about audience