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.

POST /v2/query/intersection

v2 Crosstab Cell Query

cURL

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

200

{
  "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

Authorization · string · header · required

Body

application/json

Crosstab builder query.

Audiences and filters as parameters for Crosstab Builder metrics.

audiences · object · required

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.

Show child attributes

locations · string[]

List of location codes to filter.

Example:

["s2_1", "s2_44"]

waves · string[]

List of wave codes to filter.

Example:

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

base_audience · Audience · object

Wrapper structure containing AudienceExpression.

Show child attributes

Response

200

application/json

Correct results for given query.

Result of crosstab builder query.

meta · AudiencesIntersectionQueryResultsMetadata · object · required

Metadata for crosstab builder query result

Show child attributes

data · QueryResultsData · object · required

Collection of results of crosstab builder query.

Show child attributes