Get Count of Users in Include and Exclude Segment

Get count of users in an include and exclude segment

POST /api/segments/count

Get Count of Users in Include and Exclude Segment

cURL

curl --request POST \
  --url https://api.embedreach.com/api/segments/count \
  --header 'Content-Type: application/json' \
  --data '
{
  "includeSegments": [
    "<string>"
  ],
  "excludeSegments": [
    "<string>"
  ],
  "automationId": "<string>",
  "search": "<string>",
  "limit": 100,
  "filter": "all",
  "cursor": "<string>"
}
'

import requests

url = "https://api.embedreach.com/api/segments/count"

payload = {
    "includeSegments": ["<string>"],
    "excludeSegments": ["<string>"],
    "automationId": "<string>",
    "search": "<string>",
    "limit": 100,
    "filter": "all",
    "cursor": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    includeSegments: ['<string>'],
    excludeSegments: ['<string>'],
    automationId: '<string>',
    search: '<string>',
    limit: 100,
    filter: 'all',
    cursor: '<string>'
  })
};

fetch('https://api.embedreach.com/api/segments/count', 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.embedreach.com/api/segments/count",
  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([
    'includeSegments' => [
        '<string>'
    ],
    'excludeSegments' => [
        '<string>'
    ],
    'automationId' => '<string>',
    'search' => '<string>',
    'limit' => 100,
    'filter' => 'all',
    'cursor' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.embedreach.com/api/segments/count"

	payload := strings.NewReader("{\n  \"includeSegments\": [\n    \"<string>\"\n  ],\n  \"excludeSegments\": [\n    \"<string>\"\n  ],\n  \"automationId\": \"<string>\",\n  \"search\": \"<string>\",\n  \"limit\": 100,\n  \"filter\": \"all\",\n  \"cursor\": \"<string>\"\n}")

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

	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://api.embedreach.com/api/segments/count")
  .header("Content-Type", "application/json")
  .body("{\n  \"includeSegments\": [\n    \"<string>\"\n  ],\n  \"excludeSegments\": [\n    \"<string>\"\n  ],\n  \"automationId\": \"<string>\",\n  \"search\": \"<string>\",\n  \"limit\": 100,\n  \"filter\": \"all\",\n  \"cursor\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.embedreach.com/api/segments/count")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"includeSegments\": [\n    \"<string>\"\n  ],\n  \"excludeSegments\": [\n    \"<string>\"\n  ],\n  \"automationId\": \"<string>\",\n  \"search\": \"<string>\",\n  \"limit\": 100,\n  \"filter\": \"all\",\n  \"cursor\": \"<string>\"\n}"

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

200

{
  "success": true,
  "message": "<string>",
  "data": {
    "count": 123,
    "recipients": [
      {
        "firstName": "<string>",
        "lastName": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "id": "<string>",
        "externalId": "<string>",
        "emailOptedOut": true,
        "smsOptedOut": true
      }
    ],
    "pagination": {
      "hasNextPage": true,
      "cursor": "<string>"
    }
  }
}

{
  "message": "<string>",
  "success": false,
  "errors": [
    "<string>"
  ]
}

Headers

reach-tenant-id · string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Body

application/json

includeSegments · string[]

The segments to include

excludeSegments · string[]

The segments to exclude

automationId · string

The id of the automation

search · string

Search query to filter recipients by name, email, or phone

limit · number · default: 100

Maximum number of recipients to return (defaults to 100 for performance)

Required range: 1 <= x <= 1000

filter · enum<string> · default: all

Filter recipients by contact method: all, email, or phone

Available options: all, email, phone

cursor · string

Cursor for pagination (from previous response)

Response

200

application/json

Status 200 response

success · boolean · required

message · string

data · object

Show child attributes