v2 Crosstab Bulk Query

POST

query

crosstab

curl --request POST \
  --url https://api.globalwebindex.com/v2/query/crosstab \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "columns": [
    {
      "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
          }
        ]
      }
    }
  ],
  "rows": [
    {
      "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
          }
        ]
      }
    }
  ],
  "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
        }
      ]
    }
  }
}'

{
  "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
        }
      ]
    }
  },
  "row_index": 123,
  "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
        }
      ]
    }
  },
  "column_index": 123,
  "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

Authorization

string

header

required

Body

application/json

Crosstab query.

Audiences and filters as parameters for Crosstab Builder metrics.

columns

object[]

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 no audience is queried then base audience is taken for both row and column audiences.

Wrapper structure containing AudienceExpression.

columns.id

string

Example:

"134"

columns.name

string

Example:

"my_audience"

columns.expression

object

Flexible expression of audience scope.

columns.expression.and

object[]

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

Flexible expression of audience scope.

columns.expression.and.and

object[]

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

Flexible expression of audience scope.

columns.expression.and.and.and

object[]

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

Flexible expression of audience scope.

columns.expression.and.and.or

object[]

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

Flexible expression of audience scope.

columns.expression.and.and.not

boolean

To use negation of the expression.

columns.expression.and.and.question

string

Question code to define datapoint scope.

Example:

"q2"

columns.expression.and.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

columns.expression.and.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

columns.expression.and.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

columns.expression.and.or

object[]

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

Flexible expression of audience scope.

columns.expression.and.or.and

object[]

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

Flexible expression of audience scope.

columns.expression.and.or.or

object[]

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

Flexible expression of audience scope.

columns.expression.and.or.not

boolean

To use negation of the expression.

columns.expression.and.or.question

string

Question code to define datapoint scope.

Example:

"q2"

columns.expression.and.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

columns.expression.and.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

columns.expression.and.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

columns.expression.and.not

boolean

To use negation of the expression.

columns.expression.and.question

string

Question code to define datapoint scope.

Example:

"q2"

columns.expression.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

columns.expression.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

columns.expression.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

columns.expression.or

object[]

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

Flexible expression of audience scope.

columns.expression.or.and

object[]

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

Flexible expression of audience scope.

columns.expression.or.and.and

object[]

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

Flexible expression of audience scope.

columns.expression.or.and.or

object[]

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

Flexible expression of audience scope.

columns.expression.or.and.not

boolean

To use negation of the expression.

columns.expression.or.and.question

string

Question code to define datapoint scope.

Example:

"q2"

columns.expression.or.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

columns.expression.or.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

columns.expression.or.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

columns.expression.or.or

object[]

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

Flexible expression of audience scope.

columns.expression.or.or.and

object[]

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

Flexible expression of audience scope.

columns.expression.or.or.or

object[]

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

Flexible expression of audience scope.

columns.expression.or.or.not

boolean

To use negation of the expression.

columns.expression.or.or.question

string

Question code to define datapoint scope.

Example:

"q2"

columns.expression.or.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

columns.expression.or.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

columns.expression.or.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

columns.expression.or.not

boolean

To use negation of the expression.

columns.expression.or.question

string

Question code to define datapoint scope.

Example:

"q2"

columns.expression.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

columns.expression.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

columns.expression.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

columns.expression.not

boolean

To use negation of the expression.

columns.expression.question

string

Question code to define datapoint scope.

Example:

"q2"

columns.expression.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

columns.expression.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

columns.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,
      "not": false
    }
  ]
}

rows

object[]

Wrapper structure containing AudienceExpression.

rows.id

string

Example:

"133"

rows.name

string

Example:

"my_audience"

rows.expression

object

Flexible expression of audience scope.

rows.expression.and

object[]

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

Flexible expression of audience scope.

rows.expression.and.and

object[]

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

Flexible expression of audience scope.

rows.expression.and.and.and

object[]

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

Flexible expression of audience scope.

rows.expression.and.and.or

object[]

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

Flexible expression of audience scope.

rows.expression.and.and.not

boolean

To use negation of the expression.

rows.expression.and.and.question

string

Question code to define datapoint scope.

Example:

"q2"

rows.expression.and.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

rows.expression.and.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

rows.expression.and.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

rows.expression.and.or

object[]

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

Flexible expression of audience scope.

rows.expression.and.or.and

object[]

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

Flexible expression of audience scope.

rows.expression.and.or.or

object[]

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

Flexible expression of audience scope.

rows.expression.and.or.not

boolean

To use negation of the expression.

rows.expression.and.or.question

string

Question code to define datapoint scope.

Example:

"q2"

rows.expression.and.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

rows.expression.and.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

rows.expression.and.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

rows.expression.and.not

boolean

To use negation of the expression.

rows.expression.and.question

string

Question code to define datapoint scope.

Example:

"q2"

rows.expression.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

rows.expression.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

rows.expression.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

rows.expression.or

object[]

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

Flexible expression of audience scope.

rows.expression.or.and

object[]

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

Flexible expression of audience scope.

rows.expression.or.and.and

object[]

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

Flexible expression of audience scope.

rows.expression.or.and.or

object[]

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

Flexible expression of audience scope.

rows.expression.or.and.not

boolean

To use negation of the expression.

rows.expression.or.and.question

string

Question code to define datapoint scope.

Example:

"q2"

rows.expression.or.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

rows.expression.or.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

rows.expression.or.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

rows.expression.or.or

object[]

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

Flexible expression of audience scope.

rows.expression.or.or.and

object[]

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

Flexible expression of audience scope.

rows.expression.or.or.or

object[]

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

Flexible expression of audience scope.

rows.expression.or.or.not

boolean

To use negation of the expression.

rows.expression.or.or.question

string

Question code to define datapoint scope.

Example:

"q2"

rows.expression.or.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

rows.expression.or.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

rows.expression.or.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

rows.expression.or.not

boolean

To use negation of the expression.

rows.expression.or.question

string

Question code to define datapoint scope.

Example:

"q2"

rows.expression.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

rows.expression.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

rows.expression.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

rows.expression.not

boolean

To use negation of the expression.

rows.expression.question

string

Question code to define datapoint scope.

Example:

"q2"

rows.expression.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

rows.expression.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

rows.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,
      "not": false
    }
  ]
}

locations

string[]

List of location codes to filter.

Example:

["s2_1", "s2_44"]

waves

string[]

List of wave codes to filter. If not set or empty, will default to last 4 accessible waves. This differs from other endpoints where the default is all accessible waves because of performance reasons.

Example:

["q1_2019", "q2_2019", "q3_2019", "q4_2019"]

base_audience

object

Wrapper structure containing AudienceExpression.

base_audience.id

string

Example:

"135"

base_audience.name

string

Example:

"my_audience"

base_audience.expression

object

Flexible expression of audience scope.

base_audience.expression.and

object[]

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

Flexible expression of audience scope.

base_audience.expression.and.and

object[]

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

Flexible expression of audience scope.

base_audience.expression.and.and.and

object[]

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

Flexible expression of audience scope.

base_audience.expression.and.and.or

object[]

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

Flexible expression of audience scope.

base_audience.expression.and.and.not

boolean

To use negation of the expression.

base_audience.expression.and.and.question

string

Question code to define datapoint scope.

Example:

"q2"

base_audience.expression.and.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

base_audience.expression.and.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

base_audience.expression.and.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

base_audience.expression.and.or

object[]

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

Flexible expression of audience scope.

base_audience.expression.and.or.and

object[]

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

Flexible expression of audience scope.

base_audience.expression.and.or.or

object[]

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

Flexible expression of audience scope.

base_audience.expression.and.or.not

boolean

To use negation of the expression.

base_audience.expression.and.or.question

string

Question code to define datapoint scope.

Example:

"q2"

base_audience.expression.and.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

base_audience.expression.and.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

base_audience.expression.and.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

base_audience.expression.and.not

boolean

To use negation of the expression.

base_audience.expression.and.question

string

Question code to define datapoint scope.

Example:

"q2"

base_audience.expression.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

base_audience.expression.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

base_audience.expression.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

base_audience.expression.or

object[]

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

Flexible expression of audience scope.

base_audience.expression.or.and

object[]

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

Flexible expression of audience scope.

base_audience.expression.or.and.and

object[]

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

Flexible expression of audience scope.

base_audience.expression.or.and.or

object[]

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

Flexible expression of audience scope.

base_audience.expression.or.and.not

boolean

To use negation of the expression.

base_audience.expression.or.and.question

string

Question code to define datapoint scope.

Example:

"q2"

base_audience.expression.or.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

base_audience.expression.or.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

base_audience.expression.or.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

base_audience.expression.or.or

object[]

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

Flexible expression of audience scope.

base_audience.expression.or.or.and

object[]

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

Flexible expression of audience scope.

base_audience.expression.or.or.or

object[]

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

Flexible expression of audience scope.

base_audience.expression.or.or.not

boolean

To use negation of the expression.

base_audience.expression.or.or.question

string

Question code to define datapoint scope.

Example:

"q2"

base_audience.expression.or.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

base_audience.expression.or.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

base_audience.expression.or.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

base_audience.expression.or.not

boolean

To use negation of the expression.

base_audience.expression.or.question

string

Question code to define datapoint scope.

Example:

"q2"

base_audience.expression.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

base_audience.expression.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

base_audience.expression.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

base_audience.expression.not

boolean

To use negation of the expression.

base_audience.expression.question

string

Question code to define datapoint scope.

Example:

"q2"

base_audience.expression.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

base_audience.expression.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

base_audience.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,
      "not": false
    }
  ]
}

Response

200

application/json-seq

Unordered stream of query responses as json objects.

Result for an intersection of row and column audiences identified by its index starting from 0.

audiences

object

required

base

object

required

Metrics of base audience used for intersection

intersect

object

required

Metrics of intersection of queried audiences.

row

object

Wrapper structure containing AudienceExpression.

row.id

string

Example:

"133"

row.name

string

Example:

"my_audience"

row.expression

object

Flexible expression of audience scope.

row.expression.and

object[]

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

Flexible expression of audience scope.

row.expression.and.and

object[]

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

Flexible expression of audience scope.

row.expression.and.and.and

object[]

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

Flexible expression of audience scope.

row.expression.and.and.or

object[]

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

Flexible expression of audience scope.

row.expression.and.and.not

boolean

To use negation of the expression.

row.expression.and.and.question

string

Question code to define datapoint scope.

Example:

"q2"

row.expression.and.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

row.expression.and.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

row.expression.and.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

row.expression.and.or

object[]

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

Flexible expression of audience scope.

row.expression.and.or.and

object[]

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

Flexible expression of audience scope.

row.expression.and.or.or

object[]

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

Flexible expression of audience scope.

row.expression.and.or.not

boolean

To use negation of the expression.

row.expression.and.or.question

string

Question code to define datapoint scope.

Example:

"q2"

row.expression.and.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

row.expression.and.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

row.expression.and.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

row.expression.and.not

boolean

To use negation of the expression.

row.expression.and.question

string

Question code to define datapoint scope.

Example:

"q2"

row.expression.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

row.expression.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

row.expression.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

row.expression.or

object[]

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

Flexible expression of audience scope.

row.expression.or.and

object[]

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

Flexible expression of audience scope.

row.expression.or.and.and

object[]

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

Flexible expression of audience scope.

row.expression.or.and.or

object[]

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

Flexible expression of audience scope.

row.expression.or.and.not

boolean

To use negation of the expression.

row.expression.or.and.question

string

Question code to define datapoint scope.

Example:

"q2"

row.expression.or.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

row.expression.or.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

row.expression.or.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

row.expression.or.or

object[]

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

Flexible expression of audience scope.

row.expression.or.or.and

object[]

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

Flexible expression of audience scope.

row.expression.or.or.or

object[]

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

Flexible expression of audience scope.

row.expression.or.or.not

boolean

To use negation of the expression.

row.expression.or.or.question

string

Question code to define datapoint scope.

Example:

"q2"

row.expression.or.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

row.expression.or.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

row.expression.or.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

row.expression.or.not

boolean

To use negation of the expression.

row.expression.or.question

string

Question code to define datapoint scope.

Example:

"q2"

row.expression.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

row.expression.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

row.expression.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

row.expression.not

boolean

To use negation of the expression.

row.expression.question

string

Question code to define datapoint scope.

Example:

"q2"

row.expression.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

row.expression.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

row.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,
      "not": false
    }
  ]
}

row_index

number

Index to specific row audience defined by the request. If the value is equal to 0, then the audience used was "All base respondents".

column

object

Wrapper structure containing AudienceExpression.

column.id

string

Example:

"134"

column.name

string

Example:

"my_audience"

column.expression

object

Flexible expression of audience scope.

column.expression.and

object[]

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

Flexible expression of audience scope.

column.expression.and.and

object[]

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

Flexible expression of audience scope.

column.expression.and.and.and

object[]

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

Flexible expression of audience scope.

column.expression.and.and.or

object[]

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

Flexible expression of audience scope.

column.expression.and.and.not

boolean

To use negation of the expression.

column.expression.and.and.question

string

Question code to define datapoint scope.

Example:

"q2"

column.expression.and.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

column.expression.and.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

column.expression.and.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

column.expression.and.or

object[]

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

Flexible expression of audience scope.

column.expression.and.or.and

object[]

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

Flexible expression of audience scope.

column.expression.and.or.or

object[]

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

Flexible expression of audience scope.

column.expression.and.or.not

boolean

To use negation of the expression.

column.expression.and.or.question

string

Question code to define datapoint scope.

Example:

"q2"

column.expression.and.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

column.expression.and.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

column.expression.and.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

column.expression.and.not

boolean

To use negation of the expression.

column.expression.and.question

string

Question code to define datapoint scope.

Example:

"q2"

column.expression.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

column.expression.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

column.expression.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

column.expression.or

object[]

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

Flexible expression of audience scope.

column.expression.or.and

object[]

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

Flexible expression of audience scope.

column.expression.or.and.and

object[]

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

Flexible expression of audience scope.

column.expression.or.and.or

object[]

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

Flexible expression of audience scope.

column.expression.or.and.not

boolean

To use negation of the expression.

column.expression.or.and.question

string

Question code to define datapoint scope.

Example:

"q2"

column.expression.or.and.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

column.expression.or.and.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

column.expression.or.and.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

column.expression.or.or

object[]

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

Flexible expression of audience scope.

column.expression.or.or.and

object[]

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

Flexible expression of audience scope.

column.expression.or.or.or

object[]

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

Flexible expression of audience scope.

column.expression.or.or.not

boolean

To use negation of the expression.

column.expression.or.or.question

string

Question code to define datapoint scope.

Example:

"q2"

column.expression.or.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

column.expression.or.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

column.expression.or.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

column.expression.or.not

boolean

To use negation of the expression.

column.expression.or.question

string

Question code to define datapoint scope.

Example:

"q2"

column.expression.or.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

column.expression.or.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

column.expression.or.min_count

integer

Minimal count of positive datapoints in one response.

Example:

1

column.expression.not

boolean

To use negation of the expression.

column.expression.question

string

Question code to define datapoint scope.

Example:

"q2"

column.expression.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

column.expression.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

column.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,
      "not": false
    }
  ]
}

column_index

number

Index to specific column audience defined by the request. If the value is equal to 0, then the audience used was "All base respondents".

v2 Audience Wave Counts Query v2 Crosstab Cell Query

curl --request POST \
  --url https://api.globalwebindex.com/v2/query/crosstab \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "columns": [
    {
      "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
          }
        ]
      }
    }
  ],
  "rows": [
    {
      "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
          }
        ]
      }
    }
  ],
  "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
        }
      ]
    }
  }
}'

{
  "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
        }
      ]
    }
  },
  "row_index": 123,
  "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
        }
      ]
    }
  },
  "column_index": 123,
  "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
  }
}

Getting started

Use Cases

Transition from V1 to V2 API

Platform API

v2 Crosstab Bulk Query

Authorizations

Body

Response