Query campaigns based on specified criteria. | Virtuous Developer Documentation

{
  "items": [
    {
      "id": 1024,
      "name": "Annual Fundraiser 2024",
      "description": "A campaign to raise funds for community development projects throughout 2024.",
      "startDate": "2024-01-01T00:00:00Z",
      "endDate": "2024-12-31T23:59:59Z",
      "duration": "365 days",
      "canSync": true,
      "crmKey": "AF2024-CRM",
      "crmKeyUrls": {},
      "applySegmentToRecurringGifts": true,
      "givingGoal": 50000,
      "givingGoalFormatted": "$50,000.00",
      "hasGivingGoal": true,
      "raisedAmount": "$35,750.00",
      "raisedPercentage": 71.5,
      "totalGiftGoal": 500,
      "hasTotalGiftGoal": true,
      "totalGifts": 375,
      "totalGiftsPercentage": 75,
      "totalDonors": 320,
      "averageGiftGoal": 100,
      "averageGiftGoalFormatted": "$100.00",
      "averageGiftAmount": "$95.33",
      "hasAverageGiftGoal": true,
      "totalVisitors": 1200,
      "conversionRate": "26.7%",
      "createdDateTime": "2023-11-15T09:30:00Z",
      "modifiedDateTime": "2024-04-10T16:45:00Z"
    }
  ],
  "total": 1
}

To discover available fields and operators for campaign queries: Call /api/query/options/Campaign to retrieve parameters, operators, and result fields.Build one or more groups of conditions using those parameters.POST the resulting RaiseDonors.Api.Models.Query.QueryRequestModel to this endpoint. For numeric fields using the Between operator, provide the lower bound in value and the upper bound in secondaryValue. When includeDetails=true, the response includes all related entities (Segments, Pages, PageStatistics) similar to the GET by ID endpoint. This may impact performance for large result sets.

Authentication

Authorizationstring

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

Request

The campaign query request, including RaiseDonors.Api.Models.Query.QueryRequestModel.QueryType, structured groups/conditions, selectedColumns, includeDetails, and paging options.

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