v2 Category Detail

Show detail info of given category.

GET /v2/categories/{category_id}

v2 Category Detail

cURL

curl --request GET \
  --url https://api.globalwebindex.com/v2/categories/{category_id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.globalwebindex.com/v2/categories/{category_id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.globalwebindex.com/v2/categories/{category_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.globalwebindex.com/v2/categories/{category_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.globalwebindex.com/v2/categories/{category_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.globalwebindex.com/v2/categories/{category_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.globalwebindex.com/v2/categories/{category_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "category": {
    "attribute_count": 123,
    "child_categories": "<array>",
    "child_questions": [
      {
        "accessible": true,
        "attribute_count": 123,
        "categories": "<array>",
        "code": "<string>",
        "datapoints": [
          {
            "accessible": true,
            "code": "<string>",
            "midpoint": {
              "value": 123
            },
            "name": "<string>",
            "order": {
              "value": 123
            }
          }
        ],
        "datasets": [
          {
            "base_audience_label": "<string>",
            "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_audience_label": "<string>",
              "base_namespace_code": "<string>",
              "child_categories": "<array>",
              "code": "<string>",
              "depth": 123,
              "description": "<string>",
              "is_syndicated": true,
              "name": "<string>",
              "order": 123
            }
          }
        ],
        "unit": "<string>",
        "warning": "<string>"
      }
    ],
    "datasets": [
      {
        "base_audience_label": "<string>",
        "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_audience_label": "<string>",
          "base_namespace_code": "<string>",
          "child_categories": "<array>",
          "code": "<string>",
          "depth": 123,
          "description": "<string>",
          "is_syndicated": true,
          "name": "<string>",
          "order": 123
        }
      }
    ]
  }
}

{
  "code": 123,
  "err": "<string>",
  "type": "<string>"
}

{
  "code": 123,
  "err": "<string>",
  "type": "<string>"
}

{
  "code": 123,
  "err": "<string>",
  "type": "<string>"
}

{
  "code": 123,
  "err": "<string>",
  "type": "<string>"
}

Authorizations

Authorization · string · header · required

Path Parameters

category_id · integer · required

ID of category requested

Query Parameters

include · string[]

Relationships to include in response, ATM supported is: children,lineage,attribute_count,datasets,descendant_attributes

Response

200

application/json

details about category

category · object

Show child attributes