v2 Questions Filter

curl --request POST \
  --url https://api.globalwebindex.com/v2/questions/filter \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "include": {
    "categories": true,
    "datapoints": true,
    "datasets": true
  },
  "questions": [
    {
      "code": "<string>",
      "namespace_code": "<string>"
    }
  ]
}
'

{
  "questions": [
    {
      "accessible": true,
      "attribute_count": 123,
      "categories": [
        {
          "attribute_count": 123,
          "child_categories": "<array>",
          "child_questions": "<array>",
          "datasets": [
            {
              "base_namespace_code": "<string>",
              "child_categories": "<array>",
              "code": "<string>",
              "depth": 123,
              "description": "<string>",
              "is_syndicated": true,
              "name": "<string>",
              "order": 123
            }
          ],
          "descendant_attributes": [
            {
              "datapoint_code": "<string>",
              "datapoint_name": "<string>",
              "namespace_code": "<string>",
              "question_code": "<string>",
              "question_name": "<string>",
              "suffix_code": "<string>",
              "suffix_name": "<string>"
            }
          ],
          "description": "<string>",
          "id": "<string>",
          "lineage": "<array>",
          "name": "<string>",
          "order": 123,
          "taxonomy_paths": [
            {
              "categories_lineage": "<array>",
              "dataset": {
                "base_namespace_code": "<string>",
                "child_categories": "<array>",
                "code": "<string>",
                "depth": 123,
                "description": "<string>",
                "is_syndicated": true,
                "name": "<string>",
                "order": 123
              }
            }
          ]
        }
      ],
      "code": "<string>",
      "datapoints": [
        {
          "accessible": true,
          "code": "<string>",
          "midpoint": {
            "value": 123
          },
          "name": "<string>",
          "order": {
            "value": 123
          }
        }
      ],
      "datasets": [
        {
          "base_namespace_code": "<string>",
          "child_categories": "<array>",
          "code": "<string>",
          "depth": 123,
          "description": "<string>",
          "is_syndicated": true,
          "name": "<string>",
          "order": 123
        }
      ],
      "description": "<string>",
      "flags": [
        "<string>"
      ],
      "knowledge_base": "<string>",
      "message": "<string>",
      "name": "<string>",
      "namespace_code": "<string>",
      "notice": "<string>",
      "order": 123,
      "suffixes": [
        {
          "code": "<string>",
          "midpoint": {
            "value": 123
          },
          "name": "<string>",
          "order": {
            "value": 123
          }
        }
      ],
      "taxonomy_paths": [
        {
          "categories_lineage": "<array>",
          "dataset": {
            "base_namespace_code": "<string>",
            "child_categories": "<array>",
            "code": "<string>",
            "depth": 123,
            "description": "<string>",
            "is_syndicated": true,
            "name": "<string>",
            "order": 123
          }
        }
      ],
      "unit": "<string>",
      "warning": "<string>"
    }
  ]
}

POST

questions

filter

v2 Questions Filter

curl --request POST \
  --url https://api.globalwebindex.com/v2/questions/filter \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "include": {
    "categories": true,
    "datapoints": true,
    "datasets": true
  },
  "questions": [
    {
      "code": "<string>",
      "namespace_code": "<string>"
    }
  ]
}
'

{
  "questions": [
    {
      "accessible": true,
      "attribute_count": 123,
      "categories": [
        {
          "attribute_count": 123,
          "child_categories": "<array>",
          "child_questions": "<array>",
          "datasets": [
            {
              "base_namespace_code": "<string>",
              "child_categories": "<array>",
              "code": "<string>",
              "depth": 123,
              "description": "<string>",
              "is_syndicated": true,
              "name": "<string>",
              "order": 123
            }
          ],
          "descendant_attributes": [
            {
              "datapoint_code": "<string>",
              "datapoint_name": "<string>",
              "namespace_code": "<string>",
              "question_code": "<string>",
              "question_name": "<string>",
              "suffix_code": "<string>",
              "suffix_name": "<string>"
            }
          ],
          "description": "<string>",
          "id": "<string>",
          "lineage": "<array>",
          "name": "<string>",
          "order": 123,
          "taxonomy_paths": [
            {
              "categories_lineage": "<array>",
              "dataset": {
                "base_namespace_code": "<string>",
                "child_categories": "<array>",
                "code": "<string>",
                "depth": 123,
                "description": "<string>",
                "is_syndicated": true,
                "name": "<string>",
                "order": 123
              }
            }
          ]
        }
      ],
      "code": "<string>",
      "datapoints": [
        {
          "accessible": true,
          "code": "<string>",
          "midpoint": {
            "value": 123
          },
          "name": "<string>",
          "order": {
            "value": 123
          }
        }
      ],
      "datasets": [
        {
          "base_namespace_code": "<string>",
          "child_categories": "<array>",
          "code": "<string>",
          "depth": 123,
          "description": "<string>",
          "is_syndicated": true,
          "name": "<string>",
          "order": 123
        }
      ],
      "description": "<string>",
      "flags": [
        "<string>"
      ],
      "knowledge_base": "<string>",
      "message": "<string>",
      "name": "<string>",
      "namespace_code": "<string>",
      "notice": "<string>",
      "order": 123,
      "suffixes": [
        {
          "code": "<string>",
          "midpoint": {
            "value": 123
          },
          "name": "<string>",
          "order": {
            "value": 123
          }
        }
      ],
      "taxonomy_paths": [
        {
          "categories_lineage": "<array>",
          "dataset": {
            "base_namespace_code": "<string>",
            "child_categories": "<array>",
            "code": "<string>",
            "depth": 123,
            "description": "<string>",
            "is_syndicated": true,
            "name": "<string>",
            "order": 123
          }
        }
      ],
      "unit": "<string>",
      "warning": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Body

application/json

Questions details request

include

object

Show child attributes

include.categories

boolean

Include question's parent categories up to root.

include.datapoints

boolean

Include question's direct datapoints (children).

include.datasets

boolean

Include datasets which this question belongs to.

questions

object[]

List of namespace codes + question codes to filter by.

Show child attributes

questions.code

string

Question code (q4).

questions.namespace_code

string

Question's namespace code (core, gwi-ext).

Response

details about questions

questions

object[]

Questions matching the filtering criteria.

Show child attributes

questions.accessible

boolean

Is question accessible or not, false = show upsell cube.

questions.attribute_count

integer

Number of attributes in question.

questions.categories

object[]

Categories where this question is present. Item is present only in some endpoints.

Show child attributes

questions.categories.attribute_count

integer

Number of attributes in category.

questions.categories.child_categories

array

Child Categories, used for include=children.

questions.categories.child_questions

array

Children Questions, used for include=children.

questions.categories.datasets

object[]

Included items below. Datasets of category. Used with include datasets.

Show child attributes

questions.categories.datasets.base_namespace_code

string

Base namespace of dataset (core, gwi-ext, etc...).

questions.categories.datasets.child_categories

array

List of child categories of the dataset.

questions.categories.datasets.code

string

Dataset code (ds-core).

questions.categories.datasets.depth

integer

Number of ancestors the base namespace of the dataset has in its lineage.

questions.categories.datasets.description

string

Full description of dataset.

questions.categories.datasets.is_syndicated

boolean

Flag for whether dataset's base namespace is syndicated.

questions.categories.datasets.name

string

Human readable dataset name.

questions.categories.datasets.order

number

Order of the dataset in its parent folder (25.5).

questions.categories.descendant_attributes

object[]

DescendantAttributes are all attributes (question+datapoint+suffix) of this question all the way to the leaf of the tree.

Show child attributes

questions.categories.descendant_attributes.datapoint_code

string

Datapoint code - 1.

questions.categories.descendant_attributes.datapoint_name

string

Datapoint Name - "Yellow".

questions.categories.descendant_attributes.namespace_code

string

Namespace code - core, gwi-ext.

questions.categories.descendant_attributes.question_code

string

Question code - q4.

questions.categories.descendant_attributes.question_name

string

Question name - "What color do you like the most?".

questions.categories.descendant_attributes.suffix_code

string

Suffix code - 1.

questions.categories.descendant_attributes.suffix_name

string

Suffix Name - "Heavily agree".

questions.categories.description

string

Category full description.

questions.categories.id

string

Labels ID of category (a.k.a. external_id).

questions.categories.lineage

array

Lineage is route to category through taxonomy tree, starting from the root to the category itself.

questions.categories.name

string

Human readable name of a category.

questions.categories.order

number

Order of category (5.5).

questions.categories.taxonomy_paths

object[]

List of taxonomy paths where this question is present with included dataset if any.

Show child attributes

questions.categories.taxonomy_paths.categories_lineage

array

List of categories from root of the taxonomy to the leaf where the question is.

questions.categories.taxonomy_paths.dataset

object

Show child attributes

questions.categories.taxonomy_paths.dataset.base_namespace_code

string

Base namespace of dataset (core, gwi-ext, etc...).

questions.categories.taxonomy_paths.dataset.child_categories

array

List of child categories of the dataset.

questions.categories.taxonomy_paths.dataset.code

string

Dataset code (ds-core).

questions.categories.taxonomy_paths.dataset.depth

integer

Number of ancestors the base namespace of the dataset has in its lineage.

questions.categories.taxonomy_paths.dataset.description

string

Full description of dataset.

questions.categories.taxonomy_paths.dataset.is_syndicated

boolean

Flag for whether dataset's base namespace is syndicated.

questions.categories.taxonomy_paths.dataset.name

string

Human readable dataset name.

questions.categories.taxonomy_paths.dataset.order

number

Order of the dataset in its parent folder (25.5).

questions.code

string

Question code without namespace prefix (q4).

questions.datapoints

object[]

Question's datapoints. Item is present only in some endpoints.

Show child attributes

questions.datapoints.accessible

boolean

Is datapoint accessible or not, false = upsell cube for free plan users.

questions.datapoints.code

string

Datapoint code (2).

questions.datapoints.midpoint

object

Show child attributes

questions.datapoints.midpoint.value

number

The double value.

questions.datapoints.name

string

Human readable name of datapoint (5 hours).

questions.datapoints.order

object

Show child attributes

questions.datapoints.order.value

number

The double value.

questions.datasets

object[]

Question's datasets. Item is present only in some endpoints.

Show child attributes

questions.datasets.base_namespace_code

string

Base namespace of dataset (core, gwi-ext, etc...).

questions.datasets.child_categories

array

List of child categories of the dataset.

questions.datasets.code

string

Dataset code (ds-core).

questions.datasets.depth

integer

Number of ancestors the base namespace of the dataset has in its lineage.

questions.datasets.description

string

Full description of dataset.

questions.datasets.is_syndicated

boolean

Flag for whether dataset's base namespace is syndicated.

questions.datasets.name

string

Human readable dataset name.

questions.datasets.order

number

Order of the dataset in its parent folder (25.5).

questions.description

string

Full question description.

questions.flags

string[]

Flags of the question (like averages enabled, and so on).

questions.knowledge_base

string

Link to knowledge base (https://help.globalwebindex.com/en).

questions.message

string

Message to display to client about this question, where was asked, etc. (Q2 2020 Only. This question is asked to all respondents.).

questions.name

string

Question name (Time Spent Online on Mobile).

questions.namespace_code

string

Namespace code (core, gwi-ext).

questions.notice

string

Question notice (To work out average daily time spent, please).

questions.order

number

Order of question within the category folder if applicable (2.75).

questions.suffixes

object[]

Question's suffixes. Item is present only in some endpoints.

Show child attributes

questions.suffixes.code

string

Suffix code (1).

questions.suffixes.midpoint

object

Show child attributes

questions.suffixes.midpoint.value

number

The double value.

questions.suffixes.name

string

Human readable name of suffix.

questions.suffixes.order

object

Show child attributes

questions.suffixes.order.value

number

The double value.

questions.taxonomy_paths

object[]

List of taxonomy paths where this question is present with included dataset if any.

Show child attributes

questions.taxonomy_paths.categories_lineage

array

List of categories from root of the taxonomy to the leaf where the question is.

questions.taxonomy_paths.dataset

object

Show child attributes

questions.taxonomy_paths.dataset.base_namespace_code

string

Base namespace of dataset (core, gwi-ext, etc...).

questions.taxonomy_paths.dataset.child_categories

array

List of child categories of the dataset.

questions.taxonomy_paths.dataset.code

string

Dataset code (ds-core).

questions.taxonomy_paths.dataset.depth

integer

Number of ancestors the base namespace of the dataset has in its lineage.

questions.taxonomy_paths.dataset.description

string

Full description of dataset.

questions.taxonomy_paths.dataset.is_syndicated

boolean

Flag for whether dataset's base namespace is syndicated.

questions.taxonomy_paths.dataset.name

string

Human readable dataset name.

questions.taxonomy_paths.dataset.order

number

Order of the dataset in its parent folder (25.5).

questions.unit

string

Question average unit from metadata (hours).

questions.warning

string

Question warning (Time Spent Online on Mobile).

v2 Question Detail v3 Questions Filter

⌘I

Getting started

Use Cases

Transition from V1 to V2 API

Platform API

v2 Questions Filter

Authorizations

Body

Response