v3 Questions Search

POST

questions

{
  "questions": [
    {
      "categories": [
        {
          "child_categories": [
            {}
          ],
          "child_questions": [
            {}
          ],
          "description": "<string>",
          "id": "<string>",
          "lineage": [
            {}
          ],
          "name": "<string>",
          "order": 123,
          "parent_id": "<string>",
          "taxonomy_paths": [
            {
              "categories_lineage": [
                {}
              ]
            }
          ]
        }
      ],
      "datapoints": [
        {
          "datapoint": "<string>",
          "name": "<string>",
          "order": {
            "value": 123
          }
        }
      ],
      "description": "<string>",
      "knowledge_base": "<string>",
      "message": "<string>",
      "name": "<string>",
      "namespace_code": "<string>",
      "notice": "<string>",
      "order": 123,
      "question": "<string>",
      "suffixes": [
        {
          "name": "<string>",
          "order": {
            "value": 123
          },
          "suffix": "<string>"
        }
      ],
      "taxonomy_paths": [
        {
          "categories_lineage": [
            {}
          ]
        }
      ],
      "warning": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Body

application/json

Search request

filters

object

from_autosuggestion

boolean

results_limit

integer

search_term

string

Response

200

application/json

Question Search results

questions

object[]

Questions matching the filtering criteria.

questions.categories

object[]

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

questions.categories.child_categories

object[]

Child Categories, used for include=children.

questions.categories.child_categories.child_categories

object[]

Child Categories, used for include=children.

questions.categories.child_categories.child_questions

object[]

Children Questions, used for include=children.

questions.categories.child_categories.description

string

Category full description.

questions.categories.child_categories.id

string

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

questions.categories.child_categories.lineage

object[]

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

questions.categories.child_categories.name

string

Human readable name of a category.

questions.categories.child_categories.order

number

Order of category (5.5).

questions.categories.child_categories.parent_id

string

Category's parent ID.

questions.categories.child_categories.taxonomy_paths

object[]

List of taxonomy paths where this question is present.

questions.categories.child_questions

object[]

Children Questions, used for include=children.

questions.categories.child_questions.categories

object[]

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

questions.categories.child_questions.datapoints

object[]

Question's datapoints. Item is present only if requested in the request (include datapoints = true).

questions.categories.child_questions.description

string

Full question description.

questions.categories.child_questions.knowledge_base

string

Link to knowledge base (https://knowledge.globalwebindex.net/hc/en-us/articles/360004868080-Average-Time-Spent-Calculator).

questions.categories.child_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.categories.child_questions.name

string

Question name (Time Spent Online on Mobile).

questions.categories.child_questions.namespace_code

string

Namespace code (core, gwi-ext).

questions.categories.child_questions.notice

string

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

questions.categories.child_questions.order

number

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

questions.categories.child_questions.question

string

Question code with namespace prefix (gwi-ext.q4).

questions.categories.child_questions.suffixes

object[]

Question's suffixes. Item is present only when question has suffixes.

questions.categories.child_questions.taxonomy_paths

object[]

List of paths from the root category down to the leaf category. Can be multiple paths when question is present in multiple categories.

questions.categories.child_questions.warning

string

Question warning (Time Spent Online on Mobile).

questions.categories.description

string

Category full description.

questions.categories.id

string

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

questions.categories.lineage

object[]

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

questions.categories.lineage.child_categories

object[]

Child Categories, used for include=children.

questions.categories.lineage.child_questions

object[]

Children Questions, used for include=children.

questions.categories.lineage.description

string

Category full description.

questions.categories.lineage.id

string

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

questions.categories.lineage.lineage

object[]

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

questions.categories.lineage.name

string

Human readable name of a category.

questions.categories.lineage.order

number

Order of category (5.5).

questions.categories.lineage.parent_id

string

Category's parent ID.

questions.categories.lineage.taxonomy_paths

object[]

List of taxonomy paths where this question is present.

questions.categories.name

string

Human readable name of a category.

questions.categories.order

number

Order of category (5.5).

questions.categories.parent_id

string

Category's parent ID.

questions.categories.taxonomy_paths

object[]

List of taxonomy paths where this question is present.

questions.datapoints

object[]

Question's datapoints. Item is present only if requested in the request (include datapoints = true).

questions.description

string

Full question description.

questions.knowledge_base

string

Link to knowledge base (https://knowledge.globalwebindex.net/hc/en-us/articles/360004868080-Average-Time-Spent-Calculator).

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.question

string

Question code with namespace prefix (gwi-ext.q4).

questions.suffixes

object[]

Question's suffixes. Item is present only when question has suffixes.

questions.taxonomy_paths

object[]

List of paths from the root category down to the leaf category. Can be multiple paths when question is present in multiple categories.

questions.taxonomy_paths.categories_lineage

object[]

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

questions.taxonomy_paths.categories_lineage.child_categories

object[]

Child Categories, used for include=children.

questions.taxonomy_paths.categories_lineage.child_questions

object[]

Children Questions, used for include=children.

questions.taxonomy_paths.categories_lineage.child_questions.categories

object[]

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

questions.taxonomy_paths.categories_lineage.child_questions.datapoints

object[]

Question's datapoints. Item is present only if requested in the request (include datapoints = true).

questions.taxonomy_paths.categories_lineage.child_questions.description

string

Full question description.

questions.taxonomy_paths.categories_lineage.child_questions.knowledge_base

string

Link to knowledge base (https://knowledge.globalwebindex.net/hc/en-us/articles/360004868080-Average-Time-Spent-Calculator).

questions.taxonomy_paths.categories_lineage.child_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.taxonomy_paths.categories_lineage.child_questions.name

string

Question name (Time Spent Online on Mobile).

questions.taxonomy_paths.categories_lineage.child_questions.namespace_code

string

Namespace code (core, gwi-ext).

questions.taxonomy_paths.categories_lineage.child_questions.notice

string

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

questions.taxonomy_paths.categories_lineage.child_questions.order

number

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

questions.taxonomy_paths.categories_lineage.child_questions.question

string

Question code with namespace prefix (gwi-ext.q4).

questions.taxonomy_paths.categories_lineage.child_questions.suffixes

object[]

Question's suffixes. Item is present only when question has suffixes.

questions.taxonomy_paths.categories_lineage.child_questions.taxonomy_paths

object[]

List of paths from the root category down to the leaf category. Can be multiple paths when question is present in multiple categories.

questions.taxonomy_paths.categories_lineage.child_questions.warning

string

Question warning (Time Spent Online on Mobile).

questions.taxonomy_paths.categories_lineage.description

string

Category full description.

questions.taxonomy_paths.categories_lineage.id

string

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

questions.taxonomy_paths.categories_lineage.lineage

object[]

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

questions.taxonomy_paths.categories_lineage.name

string

Human readable name of a category.

questions.taxonomy_paths.categories_lineage.order

number

Order of category (5.5).

questions.taxonomy_paths.categories_lineage.parent_id

string

Category's parent ID.

questions.taxonomy_paths.categories_lineage.taxonomy_paths

object[]

List of taxonomy paths where this question is present.

questions.warning

string

Question warning (Time Spent Online on Mobile).

v3 Questions Filter v2 Splitters filter

{
  "questions": [
    {
      "categories": [
        {
          "child_categories": [
            {}
          ],
          "child_questions": [
            {}
          ],
          "description": "<string>",
          "id": "<string>",
          "lineage": [
            {}
          ],
          "name": "<string>",
          "order": 123,
          "parent_id": "<string>",
          "taxonomy_paths": [
            {
              "categories_lineage": [
                {}
              ]
            }
          ]
        }
      ],
      "datapoints": [
        {
          "datapoint": "<string>",
          "name": "<string>",
          "order": {
            "value": 123
          }
        }
      ],
      "description": "<string>",
      "knowledge_base": "<string>",
      "message": "<string>",
      "name": "<string>",
      "namespace_code": "<string>",
      "notice": "<string>",
      "order": 123,
      "question": "<string>",
      "suffixes": [
        {
          "name": "<string>",
          "order": {
            "value": 123
          },
          "suffix": "<string>"
        }
      ],
      "taxonomy_paths": [
        {
          "categories_lineage": [
            {}
          ]
        }
      ],
      "warning": "<string>"
    }
  ]
}

Getting started

Use Cases

Transition from V1 to V2 API

Platform API

v3 Questions Search

Authorizations

Body

Response