Getting started
- Introduction
- Prerequisites
- Rules of our API
- Quickstarts
Transition from V1 to V2 API
Platform API
- Reference
- Audiences
- Authorization
- Categories
- Crosstabs
- Insights
- Locations
- Namespaces
- Query
- Questions
- Splitters
- Taxonomy
- Waves
v2 Replace Audience
Update an existing audience owned by the current user to match with sent JSON audience (replace).
curl --request PUT \
--url https://api.globalwebindex.com/v2/saved/audiences/{id} \
--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"
]
}'Authorizations
Path Parameters
Audience ID
Body
Human readable name
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply intersection of their scopes.
Flexible expression of audience scope.
List of sub-expressions to apply union of their scopes.
Flexible expression of audience scope.
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
To use negation of the expression.
Question code to define datapoint scope.
"q2"
Datapoint codes to limit scopes of interest.
["q2_1", "q2_2"]
Suffixes to extend datapoint codes for more detailed responses. Array can be empty.
["1", "2", "3"]
Minimal count of positive datapoints in one response.
1
{
"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
}
]
}
null/nil uuid or folder uuid
Position to give to be able to sort.
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
authored, curated, isP2 dataset codes
Response
OK
curl --request PUT \
--url https://api.globalwebindex.com/v2/saved/audiences/{id} \
--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"
]
}'