Get a Campaign - Virtuous API Docs

{ "id": 123, "name": "<string>", "description": "<string>", "startDate": "<string>", "endDate": "<string>", "duration": "<string>", "canSync": true, "crmKey": "<string>", "crmKeyUrls": {}, "applySegmentToRecurringGifts": true, "givingGoal": 123, "givingGoalFormatted": "<string>", "hasGivingGoal": true, "raisedAmount": "<string>", "raisedPercentage": 123, "totalGiftGoal": 123, "hasTotalGiftGoal": true, "totalGifts": 123, "totalGiftsPercentage": 123, "totalDonors": 123, "averageGiftGoal": 123, "averageGiftGoalFormatted": "<string>", "averageGiftAmount": "<string>", "hasAverageGiftGoal": true, "totalVisitors": 123, "conversionRate": "<string>", "createdDateTime": "<string>", "modifiedDateTime": "<string>" }

Authorizations

Authorization

string

header

required

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

Path Parameters

integer<int64>

required

The ID of the campaign.

Response

Represents the detailed view of a campaign returned by create, update, and single-campaign retrieval endpoints.

integer<int64>

Gets or sets the identifier.

name

string | null

Gets or sets the name.

description

string | null

Gets or sets the description.

startDate

string | null

read-only

Gets or sets the start date.

endDate

string | null

read-only

Gets or sets the end date.

duration

string | null

read-only

Gets or sets the duration.

canSync

boolean

read-only

Gets or sets the can sync.

crmKey

string | null

Gets or sets the crmkey.

crmKeyUrls

object

CRM URLs for this campaign grouped by integration type.

Show child attributes

applySegmentToRecurringGifts

boolean

Gets or sets the apply segment to recurring gifts.

givingGoal

number<double>

The giving goal for the campaign in the organization base currency.

givingGoalFormatted

string | null

read-only

The giving goal formatted for display in the organization currency (for example "$10,000.00").

hasGivingGoal

boolean

Gets or sets the has giving goal.

raisedAmount

string | null

read-only

Gets or sets the raised amount.

raisedPercentage

number<double>

read-only

Percentage of the giving goal that has been raised (0–100).

totalGiftGoal

integer<int32>

Gets or sets the total gift goal.

hasTotalGiftGoal

boolean

Gets or sets the has total gift goal.

totalGifts

integer<int32>

read-only

Gets or sets the total gifts.

totalGiftsPercentage

number<double>

read-only

Percentage of the gift count goal that has been reached (0–100).

totalDonors

integer<int32>

read-only

Gets or sets the total donors.

averageGiftGoal

number<double>

The target average gift amount in the organization base currency.

averageGiftGoalFormatted

string | null

read-only

The target average gift amount formatted for display (for example "$100.00").

averageGiftAmount

string | null

read-only

The actual average gift amount formatted for display.

hasAverageGiftGoal

boolean

Gets or sets the has average gift goal.

totalVisitors

integer<int32>

read-only

Gets or sets the total visitors.

conversionRate

string | null

read-only

The conversion rate for the campaign formatted as a percentage string (for example "12.3%").

createdDateTime

string | null

read-only

Gets or sets the created date time.

modifiedDateTime

string | null

read-only

Gets or sets the modified date time.