v1 Charts Search

Search user’s chart based on given JWT token and chart name.

POST /v1/charts/search

v1 Charts Search

cURL

curl --request POST \
  --url http://api.globalwebindex.com/v1/charts/search \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "results_limit": 123,
  "search_term": "<string>"
}
'

import requests

url = "http://api.globalwebindex.com/v1/charts/search"

payload = {
    "results_limit": 123,
    "search_term": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({results_limit: 123, search_term: '<string>'})
};

fetch('http://api.globalwebindex.com/v1/charts/search', 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/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'results_limit' => 123,
    'search_term' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "http://api.globalwebindex.com/v1/charts/search"

	payload := strings.NewReader("{\n  \"results_limit\": 123,\n  \"search_term\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://api.globalwebindex.com/v1/charts/search")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"results_limit\": 123,\n  \"search_term\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://api.globalwebindex.com/v1/charts/search")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"results_limit\": 123,\n  \"search_term\": \"<string>\"\n}"

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

200

[
  {
    "created_at": 123,
    "dataset_codes": [
      "<string>"
    ],
    "dataset_names": [
      "<string>"
    ],
    "folder_id": "<string>",
    "id": "<string>",
    "is_owner": true,
    "is_public": true,
    "is_shared": true,
    "name": "<string>",
    "owner_email": "<string>",
    "owner_id": 123,
    "shared_at": 123,
    "shared_type": "<string>",
    "updated_at": 123
  }
]

{
  "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

Body

application/json

SearchChartRequest

results_limit · integer

search_term · string

Response

200

application/json

OK

created_at · integer

dataset_codes · string[]

dataset_names · string[]

folder_id · string

id · string

is_owner · boolean

is_public · boolean

is_shared · boolean

name · string

owner_email · string

owner_id · integer

shared_at · integer

shared_type · string

updated_at · integer