curl --request GET \
--url https://prod-api.raisedonors.com/api/Segment/{id} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://prod-api.raisedonors.com/api/Segment/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://prod-api.raisedonors.com/api/Segment/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://prod-api.raisedonors.com/api/Segment/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod-api.raisedonors.com/api/Segment/{id}",
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;
}HttpResponse<String> response = Unirest.get("https://prod-api.raisedonors.com/api/Segment/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.raisedonors.com/api/Segment/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_bodyconst url = 'https://prod-api.raisedonors.com/api/Segment/{id}';
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 5120,
"campaignId": 88,
"campaignName": "Year-End Giving 2025",
"name": "Year-End Email",
"description": "Email appeal segment for the year-end campaign.",
"code": "YE25-EMAIL",
"externalIdentifier": "ye25-email",
"totalDonors": 268,
"totalGifts": 301,
"totalGiftAmount": "$56,290.00",
"averageGiftAmount": "$187.01",
"medianGiftAmount": "$100.00",
"highestGiftAmount": "$1,000.00",
"totalVisitors": 3820,
"conversionRate": "7.9%",
"createdDateTime": "2025-10-15T09:05:00Z",
"modifiedDateTime": "2025-11-15T08:00:00Z"
}{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
"instance": "/api/Segment/{id}"
}{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "Segment 5120 was not found.",
"instance": "/api/Segment/5120"
}Get a Segment
Returns a single segment by ID, including its performance.
curl --request GET \
--url https://prod-api.raisedonors.com/api/Segment/{id} \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://prod-api.raisedonors.com/api/Segment/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://prod-api.raisedonors.com/api/Segment/{id}"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://prod-api.raisedonors.com/api/Segment/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
var response = await client.GetAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod-api.raisedonors.com/api/Segment/{id}",
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;
}HttpResponse<String> response = Unirest.get("https://prod-api.raisedonors.com/api/Segment/{id}")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.raisedonors.com/api/Segment/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_bodyconst url = 'https://prod-api.raisedonors.com/api/Segment/{id}';
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"id": 5120,
"campaignId": 88,
"campaignName": "Year-End Giving 2025",
"name": "Year-End Email",
"description": "Email appeal segment for the year-end campaign.",
"code": "YE25-EMAIL",
"externalIdentifier": "ye25-email",
"totalDonors": 268,
"totalGifts": 301,
"totalGiftAmount": "$56,290.00",
"averageGiftAmount": "$187.01",
"medianGiftAmount": "$100.00",
"highestGiftAmount": "$1,000.00",
"totalVisitors": 3820,
"conversionRate": "7.9%",
"createdDateTime": "2025-10-15T09:05:00Z",
"modifiedDateTime": "2025-11-15T08:00:00Z"
}{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
"instance": "/api/Segment/{id}"
}{
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.4",
"title": "Not Found",
"status": 404,
"detail": "Segment 5120 was not found.",
"instance": "/api/Segment/5120"
}code and externalIdentifier, and its results: totalDonors, totalGifts, totalGiftAmount, average, median, and highest gift amounts, totalVisitors, and conversionRate.Authorizations
JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
Path Parameters
The ID of the segment.
Response
OK
Represents a segment model.
The unique identifier of the segment.
The unique identifier of the campaign.
The name of the campaign.
The name of the segment.
The description of the segment.
The code of the segment.
An identifier of your own to store on the segment, for reconciling it with an external system.
The number of donors who have given to the segment.
The number of gifts recorded for the segment.
The total amount of the gifts recorded for the segment.
The average gift amount for the segment.
The median gift amount for the segment.
The largest gift amount for the segment.
The number of visitors recorded for the segment.
The share of visitors to the segment who gave.
The UTC date and time the segment was created.
The UTC date and time the segment was last modified.
Was this page helpful?