v2 Stats Query

curl --request POST \
  --url https://api.globalwebindex.com/v2/query/stats \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "q20",
  "datapoints": [
    "q20_3",
    "q20_1",
    "q20_5",
    "q20_6",
    "q20_7",
    "q20_4",
    "q20_2"
  ],
  "suffixes": [
    "1",
    "2",
    "3"
  ],
  "splitter": "waves",
  "segments": [
    "q1_2019",
    "q2_2019",
    "q3_2019",
    "q4_2019"
  ],
  "segmented_base": true,
  "audiences": [
    {
      "id": "133",
      "name": "my_audience",
      "expression": {
        "and": [
          {
            "question": "q2",
            "datapoints": [
              "q2_1",
              "q2_2"
            ],
            "min_count": 1,
            "not": false
          },
          {
            "question": "q20",
            "datapoints": [
              "q20_2"
            ],
            "min_count": 1,
            "suffixes": [
              "1",
              "2",
              "3"
            ],
            "not": false
          }
        ]
      }
    }
  ],
  "locations": [
    "s2_1",
    "s2_44"
  ],
  "waves": [
    "q1_2019",
    "q2_2019",
    "q3_2019",
    "q4_2019"
  ],
  "base_audience": {
    "id": "123",
    "name": "base_audience",
    "expression": {
      "and": [
        {
          "question": "q2",
          "datapoints": [
            "q2_1",
            "q2_2"
          ],
          "min_count": 1,
          "not": false
        },
        {
          "question": "q20",
          "datapoints": [
            "q20_2"
          ],
          "min_count": 1,
          "suffixes": [
            "1",
            "2",
            "3"
          ],
          "not": false
        }
      ]
    }
  }
}
'

{
  "meta": {
    "type": "DATAPOINTS-SEGMENTS",
    "question": "q20",
    "splitter": "waves"
  },
  "data": [
    {
      "datapoint": "q20_3",
      "waves": [
        "q1_2019",
        "q2_2019",
        "q3_2019",
        "q4_2019"
      ],
      "metrics": {
        "positive_size": 123,
        "positive_sample": 123,
        "audience_index": 123,
        "audience_percentage": 123,
        "audience_sample": 123,
        "audience_size": 123,
        "datapoint_percentage": 123,
        "datapoint_sample": 123,
        "datapoint_size": 123
      },
      "segment": "q1_2019",
      "audience": "133",
      "suffixes": [
        1,
        2,
        3
      ]
    }
  ]
}

POST

query

stats

v2 Stats Query

curl --request POST \
  --url https://api.globalwebindex.com/v2/query/stats \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "q20",
  "datapoints": [
    "q20_3",
    "q20_1",
    "q20_5",
    "q20_6",
    "q20_7",
    "q20_4",
    "q20_2"
  ],
  "suffixes": [
    "1",
    "2",
    "3"
  ],
  "splitter": "waves",
  "segments": [
    "q1_2019",
    "q2_2019",
    "q3_2019",
    "q4_2019"
  ],
  "segmented_base": true,
  "audiences": [
    {
      "id": "133",
      "name": "my_audience",
      "expression": {
        "and": [
          {
            "question": "q2",
            "datapoints": [
              "q2_1",
              "q2_2"
            ],
            "min_count": 1,
            "not": false
          },
          {
            "question": "q20",
            "datapoints": [
              "q20_2"
            ],
            "min_count": 1,
            "suffixes": [
              "1",
              "2",
              "3"
            ],
            "not": false
          }
        ]
      }
    }
  ],
  "locations": [
    "s2_1",
    "s2_44"
  ],
  "waves": [
    "q1_2019",
    "q2_2019",
    "q3_2019",
    "q4_2019"
  ],
  "base_audience": {
    "id": "123",
    "name": "base_audience",
    "expression": {
      "and": [
        {
          "question": "q2",
          "datapoints": [
            "q2_1",
            "q2_2"
          ],
          "min_count": 1,
          "not": false
        },
        {
          "question": "q20",
          "datapoints": [
            "q20_2"
          ],
          "min_count": 1,
          "suffixes": [
            "1",
            "2",
            "3"
          ],
          "not": false
        }
      ]
    }
  }
}
'

{
  "meta": {
    "type": "DATAPOINTS-SEGMENTS",
    "question": "q20",
    "splitter": "waves"
  },
  "data": [
    {
      "datapoint": "q20_3",
      "waves": [
        "q1_2019",
        "q2_2019",
        "q3_2019",
        "q4_2019"
      ],
      "metrics": {
        "positive_size": 123,
        "positive_sample": 123,
        "audience_index": 123,
        "audience_percentage": 123,
        "audience_sample": 123,
        "audience_size": 123,
        "datapoint_percentage": 123,
        "datapoint_sample": 123,
        "datapoint_size": 123
      },
      "segment": "q1_2019",
      "audience": "133",
      "suffixes": [
        1,
        2,
        3
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Body

application/json

Chart builder query.

Question, audiences and filters as parameters for chart builder metrics.

question

string

required

Question code to define datapoint scope.

Example:

"q20"

datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

[
  "q20_3",
  "q20_1",
  "q20_5",
  "q20_6",
  "q20_7",
  "q20_4",
  "q20_2"
]

suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

splitter

string

Either 'waves' or question code used to split results to segments.

Example:

"waves"

segments

string[]

List of wave codes, location codes or datapoint codes used to limit which segments scopes are created.

Example:

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

segmented_base

boolean

Switch to use each segment as base scope when doing segmentation.

audiences

Audience · object[]

List of audiences to scope question responses.

Show child attributes

audiences.id

string

Example:

"133"

audiences.name

string

Example:

"my_audience"

audiences.expression

AudienceExpression · object

Flexible expression of audience scope.

Show child attributes

audiences.expression.and

array

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

audiences.expression.or

array

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

audiences.expression.not

boolean

To use negation of the expression.

audiences.expression.question

string

Question code to define datapoint scope.

Example:

"q2"

audiences.expression.datapoints

string[]

Datapoint codes to limit scopes of interest.

Example:

["q2_1", "q2_2"]

audiences.expression.suffixes

string[]

Suffixes to extend datapoint codes for more detailed responses.

Example:

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

audiences.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": "q20",
      "datapoints": ["q20_2"],
      "min_count": 1,
      "suffixes": ["1", "2", "3"],
      "not": false
    }
  ]
}

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

BaseAudience · object

Wrapper structure containing AudienceExpression.

Show child attributes

base_audience.id

string

Example:

"123"

base_audience.name

string

Example:

"base_audience"

base_audience.expression

AudienceExpression · object

Flexible expression of audience scope.

Show child attributes

base_audience.expression.and

array

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

base_audience.expression.or

array

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

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": "q20",
      "datapoints": ["q20_2"],
      "min_count": 1,
      "suffixes": ["1", "2", "3"],
      "not": false
    }
  ]
}

Response

Correct results for given query.

Result of chart builder query

Getting started

Use Cases

Transition from V1 to V2 API

Platform API

v2 Stats Query

Authorizations

Body

Response