v1 Chart Detail

Get user’s chart detail based on given JWT token and chart id.

GET /v1/charts/{id}

v1 Chart Detail

cURL

curl --request GET \
  --url http://api.globalwebindex.com/v1/charts/{id} \
  --header 'Authorization: <api-key>'

import requests

url = "http://api.globalwebindex.com/v1/charts/{id}"

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

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

print(response.text)

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

fetch('http://api.globalwebindex.com/v1/charts/{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 => "http://api.globalwebindex.com/v1/charts/{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 := "http://api.globalwebindex.com/v1/charts/{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("http://api.globalwebindex.com/v1/charts/{id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://api.globalwebindex.com/v1/charts/{id}")

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

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

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

200

{
  "attributes": [
    {
      "datapoint_code": "<string>",
      "namespace_code": "<string>",
      "question_code": "<string>",
      "suffix_code": "<string>"
    }
  ],
  "audiences": [
    {
      "color_index": 123,
      "expression": {
        "and": "<array>",
        "datapoints": [
          "<string>"
        ],
        "min_count": 123,
        "not": true,
        "or": "<array>",
        "question": "<string>",
        "suffixes": [
          "<unknown>"
        ]
      },
      "id": "<string>",
      "is_hidden": true,
      "name": "<string>"
    }
  ],
  "base_audience": {
    "color_index": 123,
    "expression": {
      "and": "<array>",
      "datapoints": [
        "<string>"
      ],
      "min_count": 123,
      "not": true,
      "or": "<array>",
      "question": "<string>",
      "suffixes": [
        "<unknown>"
      ]
    },
    "id": "<string>",
    "is_hidden": true,
    "name": "<string>"
  },
  "color": "<string>",
  "created_at": 123,
  "dataset_codes": [
    "<string>"
  ],
  "dataset_names": [
    "<string>"
  ],
  "folder_id": "<string>",
  "group_type": 123,
  "id": "<string>",
  "is_owner": true,
  "is_public": true,
  "is_shared": true,
  "location_codes": [
    "<string>"
  ],
  "metrics": [
    "<string>"
  ],
  "name": "<string>",
  "owner_email": "<string>",
  "owner_id": 123,
  "segmented_base": true,
  "segments": [
    "<string>"
  ],
  "shared_at": 123,
  "shared_type": "<string>",
  "sort_parameter_type": 123,
  "sort_parameter_value": "<string>",
  "sort_type": 123,
  "splitter": "<string>",
  "updated_at": 123,
  "view_type": 123,
  "wave_codes": [
    "<string>"
  ]
}

{
  "code": 123,
  "message": "<string>"
}

{
  "code": 123,
  "message": "<string>"
}

{
  "code": 123,
  "message": "<string>"
}

{
  "code": 123,
  "message": "<string>"
}

{
  "code": 123,
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

JWT token for authentication

Path Parameters

id · string · required

Chart id.

Response

200

application/json

OK

attributes · object[]

Show child attributes

audiences · object[]

Show child attributes

base_audience · object

Show child attributes

color · string

created_at · integer

dataset_codes · string[]

dataset_names · string[]

folder_id · string

group_type · integer

id · string

is_owner · boolean

is_public · boolean

is_shared · boolean

location_codes · string[]

metrics · string[]

name · string

owner_email · string

owner_id · integer

segmented_base · boolean

segments · string[]

shared_at · integer

shared_type · string

sort_parameter_type · integer

sort_parameter_value · string

sort_type · integer

splitter · string

updated_at · integer

view_type · integer

wave_codes · string[]