curl --request POST \
--url https://developer.synq.io/api/monitors/segments/v1/labels \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"segments": [
{
"id": "<string>",
"label": "<string>"
}
]
}
'import requests
url = "https://developer.synq.io/api/monitors/segments/v1/labels"
payload = { "segments": [
{
"id": "<string>",
"label": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({segments: [{id: '<string>', label: '<string>'}]})
};
fetch('https://developer.synq.io/api/monitors/segments/v1/labels', 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://developer.synq.io/api/monitors/segments/v1/labels",
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([
'segments' => [
[
'id' => '<string>',
'label' => '<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://developer.synq.io/api/monitors/segments/v1/labels"
payload := strings.NewReader("{\n \"segments\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://developer.synq.io/api/monitors/segments/v1/labels")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"segments\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/monitors/segments/v1/labels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"segments\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"segments": [
{
"id": "<string>",
"monitorId": "<string>",
"segmentationExpression": "<string>",
"value": "<string>",
"label": "<string>",
"name": "<string>",
"createdAt": "2023-01-15T01:30:15.01Z",
"lastIngestedAt": "2023-01-15T01:30:15.01Z"
}
],
"errors": [
{
"id": "<string>",
"reason": "<string>"
}
]
}BatchUpdateMonitorSegmentLabels
Sets or clears the label of one or more segments.
Segments are addressed by the id ListMonitorSegments returns. A segment id encodes a sanitised form of the segment value, so it cannot be constructed from that value: read the ids first, then write against them.
curl --request POST \
--url https://developer.synq.io/api/monitors/segments/v1/labels \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"segments": [
{
"id": "<string>",
"label": "<string>"
}
]
}
'import requests
url = "https://developer.synq.io/api/monitors/segments/v1/labels"
payload = { "segments": [
{
"id": "<string>",
"label": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({segments: [{id: '<string>', label: '<string>'}]})
};
fetch('https://developer.synq.io/api/monitors/segments/v1/labels', 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://developer.synq.io/api/monitors/segments/v1/labels",
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([
'segments' => [
[
'id' => '<string>',
'label' => '<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://developer.synq.io/api/monitors/segments/v1/labels"
payload := strings.NewReader("{\n \"segments\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://developer.synq.io/api/monitors/segments/v1/labels")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"segments\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://developer.synq.io/api/monitors/segments/v1/labels")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"segments\": [\n {\n \"id\": \"<string>\",\n \"label\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"segments": [
{
"id": "<string>",
"monitorId": "<string>",
"segmentationExpression": "<string>",
"value": "<string>",
"label": "<string>",
"name": "<string>",
"createdAt": "2023-01-15T01:30:15.01Z",
"lastIngestedAt": "2023-01-15T01:30:15.01Z"
}
],
"errors": [
{
"id": "<string>",
"reason": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The segments to name. Each entry replaces that segment's label outright; a segment not listed is left alone.
1Show child attributes
Show child attributes
Response
Success
The segments that were updated, in their state after the update.
Show child attributes
Show child attributes
One entry per requested segment that was not updated, most commonly because no segment with that id has been ingested. Empty when every requested segment was updated.
Show child attributes
Show child attributes