getDonationCampaignMetrics( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves metrics for a donation campaign.

Returns the total number of successful donations and amount collected for the campaign. The campaignGoal must be configured before using this endpoint.

Currently supports metrics in the site's default currency only.

Method Declaration
Copy
Method Parameters
donationCampaignIdstringRequired

ID of the donation campaign to retrieve metrics for.

Returns
Return Type:Promise<GetDonationCampaignMetricsResponse>
Errors
428Failed Precondition

There is 1 error with this status code.

500Internal

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?