List all segments


List all segments, in return you'll get their ID, name and URL to list users in each segment.

GET

/segments/

curl -X GET -H "Authorization: Token <your_64_char_api_key>" "https://app.userengage.com/api/public/segments/"

Example response

{
  "previous": null,
  "results": [
    {
      "name": "Active",
      "description": "Users who have visited your website at least once in the last 30 days.",
      "users": "https://app.userengage.com/api/public/segments/1033/users/",
      "id": 1033
    },
    {
      "name": "New",
      "description": "Users who have visited your website for the first time in the last 24 hours.",
      "users": "https://app.userengage.com/api/public/segments/1034/users/",
      "id": 1034
    },
    {
      "name": "New with email",
      "description": "Users who first visited your website in the last 24 hours and have provided an email address.",
      "users": "https://app.userengage.com/api/public/segments/1037/users/",
      "id": 1037
    },
    {
      "name": "With email",
      "description": "Users whose email address you have.",
      "users": "https://app.userengage.com/api/public/segments/1036/users/",
      "id": 1036
    },
    {
      "name": "Slipping away",
      "description": "Users who have not visited your page within the last 30 days.",
      "users": "https://app.userengage.com/api/public/segments/1035/users/",
      "id": 1035
    }
  ],
  "next": null,
  "count": 5
}
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://app.userengage.com/api/public/segments/",
  "method": "GET",
  "headers": {
    "authorization": "Token <your_64_char_api_key>"
  }
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
var data = null;

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://app.userengage.com/api/public/segments/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");

xhr.send(data);
var request = require("request");

var options = { method: 'GET',
  url: 'https://app.userengage.com/api/public/segments/',
  headers: { authorization: 'Token <your_64_char_api_key>' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://app.userengage.com/api/public/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 => array(
    "authorization: Token <your_64_char_api_key>"
  ),
));

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

curl_close($curl);

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

url = "https://app.userengage.com/api/public/segments/"

headers = {'authorization': 'Token <your_64_char_api_key>'}

response = requests.request("GET", url, headers=headers)

print(response.text)
import http.client

conn = http.client.HTTPSConnection("app.userengage.com")

headers = { 'authorization': "Token <your_64_char_api_key>" }

conn.request("GET", "/api/public/segments/", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))