Query segments based on the specified query request model.

{
  "items": [
    {
      "id": 101,
      "campaignId": 202,
      "campaignName": "Spring Fundraiser 2024",
      "name": "Loyal Donors Segment",
      "description": "Segment of donors who have contributed more than $500 in the last year.",
      "code": "LOYAL2024",
      "externalIdentifier": "SEG-LOYAL-2024",
      "totalDonors": 350,
      "totalGifts": 480,
      "totalGiftAmount": "125000.00",
      "averageGiftAmount": "260.42",
      "medianGiftAmount": "200.00",
      "highestGiftAmount": "5000.00",
      "totalVisitors": 1200,
      "conversionRate": "29.17%",
      "createdDateTime": "2023-11-01T09:15:00Z",
      "modifiedDateTime": "2024-04-20T16:45:00Z"
    }
  ],
  "total": 1
}

Authentication

Authorizationstring

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

Request

The query request model.

QueryRequestModelobjectRequired

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

ParsedQueryResponseModelobjectRequired

Represents a parsedquery response model.

Response

itemslist of objectsOptional

totalintegerOptional

Errors

400

Bad Request Error