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 Crosstab Cell Query
For any query (JSON object) with audiences and filters in request body it gives back a response with results for specific Crosstab metrics according to the query.
curl --request POST \
--url https://api.globalwebindex.com/v2/query/intersection \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"audiences": {
"row": {
"id": "133",
"name": "my_audience",
"expression": {
"and": [
{
"question": "q2",
"datapoints": [
"q2_1",
"q2_2"
],
"min_count": 1,
"not": false
},
{
"question": "q6",
"datapoints": [
"q6_2"
],
"min_count": 1,
"not": false
}
]
}
},
"column": {
"id": "134",
"name": "my_audience",
"expression": {
"and": [
{
"question": "q2",
"datapoints": [
"q2_1",
"q2_2"
],
"min_count": 1,
"not": false
},
{
"question": "q6",
"datapoints": [
"q6_2"
],
"min_count": 1,
"not": false
}
]
}
}
},
"locations": [
"s2_1",
"s2_44"
],
"waves": [
"q1_2019",
"q2_2019",
"q3_2019",
"q4_2019"
],
"base_audience": {
"id": "135",
"name": "my_audience",
"expression": {
"and": [
{
"question": "q2",
"datapoints": [
"q2_1",
"q2_2"
],
"min_count": 1,
"not": false
},
{
"question": "q6",
"datapoints": [
"q6_2"
],
"min_count": 1,
"not": false
}
]
}
}
}'{
"meta": {
"type": "INTERSECTION"
},
"data": {
"audiences": {
"row": {
"audience": "<string>",
"size": 123,
"sample": 123,
"percentage": 123,
"intersect_percentage": 123
},
"column": {
"audience": "<string>",
"size": 123,
"sample": 123,
"percentage": 123,
"intersect_percentage": 123
}
},
"base": {
"size": 123,
"sample": 123
},
"intersect": {
"size": 123,
"sample": 123,
"percentage": 123,
"index": 123
}
}
}Authorizations
Body
Audiences and filters as parameters for Crosstab Builder metrics.
Object of row and column audiences to make intersection from. If only one audience is queried then the base audience is taken as the second audience. If none audience is queried then base audience is taken for both row and column audiences.
Wrapper structure containing AudienceExpression.
"133"
"my_audience"
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.
["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.
["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.
["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,
"not": false
}
]
}
Wrapper structure containing AudienceExpression.
"134"
"my_audience"
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.
["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.
["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.
["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,
"not": false
}
]
}
List of location codes to filter.
["s2_1", "s2_44"]
List of wave codes to filter.
["q1_2019", "q2_2019", "q3_2019", "q4_2019"]
Wrapper structure containing AudienceExpression.
"135"
"my_audience"
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.
["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.
["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.
["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.
["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.
["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.
["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.
["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,
"not": false
}
]
}
Response
Result of crosstab builder query.
Metadata for crosstab builder query result
Query type identifier. (has this one fixed value every time for XB- INTERSECTION)
"INTERSECTION"
Collection of results of crosstab builder query.
Metrics of queried audience.
Identifier of the audience according to the query.
Final weighted universe of audience identified by "audience" attribute.
Final count of responses of audience identified by "audience" attribute.
Ratio between queried audience size and base audience size.
Ratio between size of intersection of audiences and size of queried audience.
Metrics of queried audience.
Identifier of the audience according to the query.
Final weighted universe of audience identified by "audience" attribute.
Final count of responses of audience identified by "audience" attribute.
Ratio between queried audience size and base audience size.
Ratio between size of intersection of audiences and size of queried audience.
Metrics of intersection of queried audiences.
Final weighted universe of intersection of queried audiences.
Final count of responses of intersection of queried audiences.
Ratio between size of intersection of queried audiences and size of base audience.
Likeliness ratio between audiences and intersection.
curl --request POST \
--url https://api.globalwebindex.com/v2/query/intersection \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"audiences": {
"row": {
"id": "133",
"name": "my_audience",
"expression": {
"and": [
{
"question": "q2",
"datapoints": [
"q2_1",
"q2_2"
],
"min_count": 1,
"not": false
},
{
"question": "q6",
"datapoints": [
"q6_2"
],
"min_count": 1,
"not": false
}
]
}
},
"column": {
"id": "134",
"name": "my_audience",
"expression": {
"and": [
{
"question": "q2",
"datapoints": [
"q2_1",
"q2_2"
],
"min_count": 1,
"not": false
},
{
"question": "q6",
"datapoints": [
"q6_2"
],
"min_count": 1,
"not": false
}
]
}
}
},
"locations": [
"s2_1",
"s2_44"
],
"waves": [
"q1_2019",
"q2_2019",
"q3_2019",
"q4_2019"
],
"base_audience": {
"id": "135",
"name": "my_audience",
"expression": {
"and": [
{
"question": "q2",
"datapoints": [
"q2_1",
"q2_2"
],
"min_count": 1,
"not": false
},
{
"question": "q6",
"datapoints": [
"q6_2"
],
"min_count": 1,
"not": false
}
]
}
}
}'{
"meta": {
"type": "INTERSECTION"
},
"data": {
"audiences": {
"row": {
"audience": "<string>",
"size": 123,
"sample": 123,
"percentage": 123,
"intersect_percentage": 123
},
"column": {
"audience": "<string>",
"size": 123,
"sample": 123,
"percentage": 123,
"intersect_percentage": 123
}
},
"base": {
"size": 123,
"sample": 123
},
"intersect": {
"size": 123,
"sample": 123,
"percentage": 123,
"index": 123
}
}
}