GET

Get Donation Campaign Metrics


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 method.

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

Note: This method provides aggregated metrics only. To retrieve individual donation details, use Search Orders and filter by lineItems.catalogReference.catalogItemId equal to the donation campaign ID.

Permissions
Manage Donation Campaigns
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/donation-campaigns/v2/donation-campaigns/{donationCampaignId}/metrics

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?