Skip to navigation
Virtuous RaiseSegment

Get a specific segment by ID.

Authentication

Authorizationstring

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

Path parameters

idlongRequired
The ID of the segment.

Response

OK
idlongOptional
Gets or sets the identifier.
campaignIdlongOptional
Gets or sets the campaign identifier.
campaignNamestring or nullOptional
Gets or sets the campaign name.
namestring or nullOptional
Gets or sets the name.
descriptionstring or nullOptional
Gets or sets the description.
codestring or nullOptional
Gets or sets the code.
externalIdentifierstring or nullOptional
Gets or sets the external identifier.
totalDonorsintegerOptionalRead-only
Gets or sets the total donors.
totalGiftsintegerOptionalRead-only
Gets or sets the total gifts.
totalGiftAmountstring or nullOptionalRead-only
Gets or sets the total gift amount.
averageGiftAmountstring or nullOptionalRead-only
Gets or sets the average gift amount.
medianGiftAmountstring or nullOptionalRead-only
Gets or sets the median gift amount.
highestGiftAmountstring or nullOptionalRead-only
Gets or sets the highest gift amount.
totalVisitorsintegerOptionalRead-only
Gets or sets the total visitors.
conversionRatestring or nullOptionalRead-only
Gets or sets the conversion rate.
createdDateTimestring or nullOptionalRead-only
Gets or sets the created date time.
modifiedDateTimestring or nullOptionalRead-only
Gets or sets the modified date time.

Errors

404
Not Found Error