Skip to main content
PUT
/
virtual_tag_configs
/
{token}
/
async
Update virtual tag config asynchronously
curl --request PUT \
  --url https://api.vantage.sh/v2/virtual_tag_configs/{token}/async \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "overridable": true,
  "backfill_until": "2023-12-25",
  "collapsed_tag_keys": [
    {
      "key": "<string>",
      "providers": [
        "<string>"
      ],
      "filter": "<string>"
    }
  ],
  "values": [
    {
      "filter": "<string>",
      "name": "<string>",
      "business_metric_token": "<string>",
      "display_name": "<string>",
      "label_transforms": [
        {
          "type": "<string>",
          "delimiter": "<string>",
          "index": 123,
          "template": "<string>"
        }
      ],
      "percentages": [
        {
          "value": "<string>",
          "pct": 123
        }
      ],
      "date_ranges": [
        {
          "start_date": "<string>",
          "end_date": "<string>"
        }
      ]
    }
  ]
}
'
import requests

url = "https://api.vantage.sh/v2/virtual_tag_configs/{token}/async"

payload = {
    "key": "<string>",
    "overridable": True,
    "backfill_until": "2023-12-25",
    "collapsed_tag_keys": [
        {
            "key": "<string>",
            "providers": ["<string>"],
            "filter": "<string>"
        }
    ],
    "values": [
        {
            "filter": "<string>",
            "name": "<string>",
            "business_metric_token": "<string>",
            "display_name": "<string>",
            "label_transforms": [
                {
                    "type": "<string>",
                    "delimiter": "<string>",
                    "index": 123,
                    "template": "<string>"
                }
            ],
            "percentages": [
                {
                    "value": "<string>",
                    "pct": 123
                }
            ],
            "date_ranges": [
                {
                    "start_date": "<string>",
                    "end_date": "<string>"
                }
            ]
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    key: '<string>',
    overridable: true,
    backfill_until: '2023-12-25',
    collapsed_tag_keys: [{key: '<string>', providers: ['<string>'], filter: '<string>'}],
    values: [
      {
        filter: '<string>',
        name: '<string>',
        business_metric_token: '<string>',
        display_name: '<string>',
        label_transforms: [{type: '<string>', delimiter: '<string>', index: 123, template: '<string>'}],
        percentages: [{value: '<string>', pct: 123}],
        date_ranges: [{start_date: '<string>', end_date: '<string>'}]
      }
    ]
  })
};

fetch('https://api.vantage.sh/v2/virtual_tag_configs/{token}/async', 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.vantage.sh/v2/virtual_tag_configs/{token}/async",
  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([
    'key' => '<string>',
    'overridable' => true,
    'backfill_until' => '2023-12-25',
    'collapsed_tag_keys' => [
        [
                'key' => '<string>',
                'providers' => [
                                '<string>'
                ],
                'filter' => '<string>'
        ]
    ],
    'values' => [
        [
                'filter' => '<string>',
                'name' => '<string>',
                'business_metric_token' => '<string>',
                'display_name' => '<string>',
                'label_transforms' => [
                                [
                                                                'type' => '<string>',
                                                                'delimiter' => '<string>',
                                                                'index' => 123,
                                                                'template' => '<string>'
                                ]
                ],
                'percentages' => [
                                [
                                                                'value' => '<string>',
                                                                'pct' => 123
                                ]
                ],
                'date_ranges' => [
                                [
                                                                'start_date' => '<string>',
                                                                'end_date' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.vantage.sh/v2/virtual_tag_configs/{token}/async"

	payload := strings.NewReader("{\n  \"key\": \"<string>\",\n  \"overridable\": true,\n  \"backfill_until\": \"2023-12-25\",\n  \"collapsed_tag_keys\": [\n    {\n      \"key\": \"<string>\",\n      \"providers\": [\n        \"<string>\"\n      ],\n      \"filter\": \"<string>\"\n    }\n  ],\n  \"values\": [\n    {\n      \"filter\": \"<string>\",\n      \"name\": \"<string>\",\n      \"business_metric_token\": \"<string>\",\n      \"display_name\": \"<string>\",\n      \"label_transforms\": [\n        {\n          \"type\": \"<string>\",\n          \"delimiter\": \"<string>\",\n          \"index\": 123,\n          \"template\": \"<string>\"\n        }\n      ],\n      \"percentages\": [\n        {\n          \"value\": \"<string>\",\n          \"pct\": 123\n        }\n      ],\n      \"date_ranges\": [\n        {\n          \"start_date\": \"<string>\",\n          \"end_date\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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("https://api.vantage.sh/v2/virtual_tag_configs/{token}/async")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"<string>\",\n  \"overridable\": true,\n  \"backfill_until\": \"2023-12-25\",\n  \"collapsed_tag_keys\": [\n    {\n      \"key\": \"<string>\",\n      \"providers\": [\n        \"<string>\"\n      ],\n      \"filter\": \"<string>\"\n    }\n  ],\n  \"values\": [\n    {\n      \"filter\": \"<string>\",\n      \"name\": \"<string>\",\n      \"business_metric_token\": \"<string>\",\n      \"display_name\": \"<string>\",\n      \"label_transforms\": [\n        {\n          \"type\": \"<string>\",\n          \"delimiter\": \"<string>\",\n          \"index\": 123,\n          \"template\": \"<string>\"\n        }\n      ],\n      \"percentages\": [\n        {\n          \"value\": \"<string>\",\n          \"pct\": 123\n        }\n      ],\n      \"date_ranges\": [\n        {\n          \"start_date\": \"<string>\",\n          \"end_date\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.vantage.sh/v2/virtual_tag_configs/{token}/async")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key\": \"<string>\",\n  \"overridable\": true,\n  \"backfill_until\": \"2023-12-25\",\n  \"collapsed_tag_keys\": [\n    {\n      \"key\": \"<string>\",\n      \"providers\": [\n        \"<string>\"\n      ],\n      \"filter\": \"<string>\"\n    }\n  ],\n  \"values\": [\n    {\n      \"filter\": \"<string>\",\n      \"name\": \"<string>\",\n      \"business_metric_token\": \"<string>\",\n      \"display_name\": \"<string>\",\n      \"label_transforms\": [\n        {\n          \"type\": \"<string>\",\n          \"delimiter\": \"<string>\",\n          \"index\": 123,\n          \"template\": \"<string>\"\n        }\n      ],\n      \"percentages\": [\n        {\n          \"value\": \"<string>\",\n          \"pct\": 123\n        }\n      ],\n      \"date_ranges\": [\n        {\n          \"start_date\": \"<string>\",\n          \"end_date\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "request_id": "550e8400-e29b-41d4-a716-446655440000",
  "status_url": "/v2/virtual_tag_configs/async/550e8400-e29b-41d4-a716-446655440000"
}
{
  "errors": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "last": "<string>",
    "prev": "<string>"
  }
}
{
  "errors": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "last": "<string>",
    "prev": "<string>"
  }
}
{
  "errors": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "last": "<string>",
    "prev": "<string>"
  }
}
{
  "errors": [
    "<string>"
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "next": "<string>",
    "last": "<string>",
    "prev": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
token
string
required

Body

application/json

Asynchronously updates an existing VirtualTagConfig.

​
key
string

The key of the VirtualTagConfig.

​
overridable
boolean | null

Whether the VirtualTagConfig can override a provider-supplied tag on a matching Cost.

​
backfill_until
string<date> | null

The earliest month the VirtualTagConfig should be backfilled to.

​
collapsed_tag_keys
object[]

Tag keys to collapse values for.

​
values
object[]

Values for the VirtualTagConfig, with match precedence determined by order in the list.

Response

Request accepted for processing

AsyncVirtualTagConfigUpdate model

​
request_id
string
required

The request ID of the async virtual tag config update.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
status_url
string
required

The status path of the async virtual tag config update.

Example:

"/v2/virtual_tag_configs/async/550e8400-e29b-41d4-a716-446655440000"