Skip to main content
GET
/
api
/
admin
/
segments
/
cURL
curl --request GET \
  --url http://localhost:3001/api/admin/segments/ \
  --header 'Authorization: <api-key>'
import requests

url = "http://localhost:3001/api/admin/segments/"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('http://localhost:3001/api/admin/segments/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/admin/segments/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "http://localhost:3001/api/admin/segments/"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:3001/api/admin/segments/")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3001/api/admin/segments/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "segments": [
    {
      "id": "<string>",
      "workspaceId": "<string>",
      "name": "<string>",
      "definition": {
        "entryNode": {
          "type": "Trait",
          "id": "<string>",
          "path": "<string>",
          "operator": {
            "type": "Within",
            "windowSeconds": 123
          }
        },
        "nodes": [
          {
            "type": "Trait",
            "id": "<string>",
            "path": "<string>",
            "operator": {
              "type": "Within",
              "windowSeconds": 123
            }
          }
        ]
      },
      "updatedAt": 123,
      "createdAt": 123,
      "definitionUpdatedAt": 123,
      "subscriptionGroupId": "<string>",
      "lastRecomputed": 123,
      "resourceType": "Declarative",
      "status": "NotStarted"
    }
  ]
}

Authorizations

Authorization
string
header
required

Query Parameters

workspaceId
string
required
ids
string[]
resourceType
Available options:
Declarative

Response

200 - application/json

Default Response

segments
object[]
required