Skip to main content
POST
https://prod-api.raisedonors.com
/
api
/
Segment
/
query
Query Segments
curl --request POST \
  --url https://prod-api.raisedonors.com/api/Segment/query \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": "<string>",
  "skip": 123,
  "take": 123,
  "sortBy": "createdate",
  "descending": true,
  "includeDetails": true,
  "groups": [
    {
      "conditions": [
        {
          "parameter": "<string>",
          "value": "<string>",
          "secondaryValue": "<string>",
          "values": [
            "<string>"
          ]
        }
      ]
    }
  ],
  "selectedColumns": [
    "<string>"
  ]
}
'
{
  "items": [
    {
      "id": 123,
      "campaignId": 123,
      "campaignName": "<string>",
      "name": "<string>",
      "description": "<string>",
      "code": "<string>",
      "externalIdentifier": "<string>",
      "totalDonors": 123,
      "totalGifts": 123,
      "totalGiftAmount": "<string>",
      "averageGiftAmount": "<string>",
      "medianGiftAmount": "<string>",
      "highestGiftAmount": "<string>",
      "totalVisitors": 123,
      "conversionRate": "<string>",
      "createdDateTime": "<string>",
      "modifiedDateTime": "<string>"
    }
  ],
  "total": 123
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

The query request model.

Request body for advanced query endpoints such as donor and campaign queries.

filter
string | null
skip
integer<int32>
take
integer<int32>
sortBy
enum<string> | null

Field to sort by (case-insensitive). Valid options: createdate, createddatetime, email, firstname, gifts, giftsum, id, lastname, modifieddatetimeutc, name, phone

Available options:
createdate,
createddatetime,
email,
firstname,
gifts,
giftsum,
id,
lastname,
modifieddatetimeutc,
name,
phone
Example:

"createdate"

descending
boolean
includeDetails
boolean
queryType
enum<integer>

The logical type of query being executed.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
groups
object[] | null

The groups of conditions that make up the query.

selectedColumns
string[] | null

The list of result columns to return for each item.

Response

OK

items
object[]
total
integer<int32>
Last modified on June 5, 2026