v1 Update Chart

Update a user chart. This endpoint does not handle audiences the user has not access to.

PUT /v1/charts/{id}

v1 Update Chart

cURL

curl --request PUT \
  --url http://api.globalwebindex.com/v1/charts/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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>"
  ]
}
'

import requests

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

payload = {
    "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>"]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>']
  })
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
    ]
  ]),
  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/{id}"

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

	req, _ := http.NewRequest("PUT", 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.put("http://api.globalwebindex.com/v1/charts/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attributes\": [\n    {\n      \"datapoint_code\": \"<string>\",\n      \"namespace_code\": \"<string>\",\n      \"question_code\": \"<string>\",\n      \"suffix_code\": \"<string>\"\n    }\n  ],\n  \"audiences\": [\n    {\n      \"color_index\": 123,\n      \"expression\": {\n        \"and\": \"<array>\",\n        \"datapoints\": [\n          \"<string>\"\n        ],\n        \"min_count\": 123,\n        \"not\": true,\n        \"or\": \"<array>\",\n        \"question\": \"<string>\",\n        \"suffixes\": [\n          \"<unknown>\"\n        ]\n      },\n      \"id\": \"<string>\",\n      \"is_hidden\": true,\n      \"name\": \"<string>\"\n    }\n  ],\n  \"base_audience\": {\n    \"color_index\": 123,\n    \"expression\": {\n      \"and\": \"<array>\",\n      \"datapoints\": [\n        \"<string>\"\n      ],\n      \"min_count\": 123,\n      \"not\": true,\n      \"or\": \"<array>\",\n      \"question\": \"<string>\",\n      \"suffixes\": [\n        \"<unknown>\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"is_hidden\": true,\n    \"name\": \"<string>\"\n  },\n  \"color\": \"<string>\",\n  \"created_at\": 123,\n  \"dataset_codes\": [\n    \"<string>\"\n  ],\n  \"dataset_names\": [\n    \"<string>\"\n  ],\n  \"folder_id\": \"<string>\",\n  \"group_type\": 123,\n  \"id\": \"<string>\",\n  \"is_owner\": true,\n  \"is_public\": true,\n  \"is_shared\": true,\n  \"location_codes\": [\n    \"<string>\"\n  ],\n  \"metrics\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"owner_email\": \"<string>\",\n  \"owner_id\": 123,\n  \"segmented_base\": true,\n  \"segments\": [\n    \"<string>\"\n  ],\n  \"shared_at\": 123,\n  \"shared_type\": \"<string>\",\n  \"sort_parameter_type\": 123,\n  \"sort_parameter_value\": \"<string>\",\n  \"sort_type\": 123,\n  \"splitter\": \"<string>\",\n  \"updated_at\": 123,\n  \"view_type\": 123,\n  \"wave_codes\": [\n    \"<string>\"\n  ]\n}")
  .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::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attributes\": [\n    {\n      \"datapoint_code\": \"<string>\",\n      \"namespace_code\": \"<string>\",\n      \"question_code\": \"<string>\",\n      \"suffix_code\": \"<string>\"\n    }\n  ],\n  \"audiences\": [\n    {\n      \"color_index\": 123,\n      \"expression\": {\n        \"and\": \"<array>\",\n        \"datapoints\": [\n          \"<string>\"\n        ],\n        \"min_count\": 123,\n        \"not\": true,\n        \"or\": \"<array>\",\n        \"question\": \"<string>\",\n        \"suffixes\": [\n          \"<unknown>\"\n        ]\n      },\n      \"id\": \"<string>\",\n      \"is_hidden\": true,\n      \"name\": \"<string>\"\n    }\n  ],\n  \"base_audience\": {\n    \"color_index\": 123,\n    \"expression\": {\n      \"and\": \"<array>\",\n      \"datapoints\": [\n        \"<string>\"\n      ],\n      \"min_count\": 123,\n      \"not\": true,\n      \"or\": \"<array>\",\n      \"question\": \"<string>\",\n      \"suffixes\": [\n        \"<unknown>\"\n      ]\n    },\n    \"id\": \"<string>\",\n    \"is_hidden\": true,\n    \"name\": \"<string>\"\n  },\n  \"color\": \"<string>\",\n  \"created_at\": 123,\n  \"dataset_codes\": [\n    \"<string>\"\n  ],\n  \"dataset_names\": [\n    \"<string>\"\n  ],\n  \"folder_id\": \"<string>\",\n  \"group_type\": 123,\n  \"id\": \"<string>\",\n  \"is_owner\": true,\n  \"is_public\": true,\n  \"is_shared\": true,\n  \"location_codes\": [\n    \"<string>\"\n  ],\n  \"metrics\": [\n    \"<string>\"\n  ],\n  \"name\": \"<string>\",\n  \"owner_email\": \"<string>\",\n  \"owner_id\": 123,\n  \"segmented_base\": true,\n  \"segments\": [\n    \"<string>\"\n  ],\n  \"shared_at\": 123,\n  \"shared_type\": \"<string>\",\n  \"sort_parameter_type\": 123,\n  \"sort_parameter_value\": \"<string>\",\n  \"sort_type\": 123,\n  \"splitter\": \"<string>\",\n  \"updated_at\": 123,\n  \"view_type\": 123,\n  \"wave_codes\": [\n    \"<string>\"\n  ]\n}"

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

200

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

Body

application/json

Update chart request body, id on body is not used.

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[]

Response

200

application/json

Updated chart ID

The response is of type string.