v2 Waves Filter

Retrieve accessible waves that satisfy filter criteria.

POST /v2/waves/filter

v2 Waves Filter

cURL

curl --request POST \
  --url https://api.globalwebindex.com/v2/waves/filter \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "namespaces": [
    {
      "code": "<string>"
    }
  ]
}
'

import requests

url = "https://api.globalwebindex.com/v2/waves/filter"

payload = { "namespaces": [{ "code": "<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({namespaces: [{code: '<string>'}]})
};

fetch('https://api.globalwebindex.com/v2/waves/filter', 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/waves/filter",
  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([
    'namespaces' => [
        [
                'code' => '<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 := "https://api.globalwebindex.com/v2/waves/filter"

	payload := strings.NewReader("{\n  \"namespaces\": [\n    {\n      \"code\": \"<string>\"\n    }\n  ]\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("https://api.globalwebindex.com/v2/waves/filter")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"namespaces\": [\n    {\n      \"code\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.globalwebindex.com/v2/waves/filter")

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

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

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

200

{
  "waves": [
    {
      "accessible": true,
      "code": "<string>",
      "date_end": {
        "nanos": 123,
        "seconds": 123
      },
      "date_start": {
        "nanos": 123,
        "seconds": 123
      },
      "id": 123,
      "kind": "<string>",
      "name": "<string>",
      "namespaces": [
        {
          "code": "<string>"
        }
      ]
    }
  ]
}

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

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

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

Authorizations

Authorization · string · header · required

Body

application/json

request for filter

namespaces · object[]

Namespace codes to filter waves by.

Show child attributes

Response

200

application/json

details about locations

waves · object[]

List of waves.

Show child attributes