> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetDonationCampaignMetrics # Package: donations # Namespace: DonationCampaignService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/donations/donation-campaigns/get-donation-campaign-metrics.md ## Permission Scopes: Manage Donation Campaigns: SCOPE.DONATIONS.MANAGE-CAMPAIGNS ## Introduction 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](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/orders/search-orders.md) and filter by `lineItems.catalogReference.catalogItemId` equal to the donation campaign ID. --- ## REST API ### Schema ``` Method: getDonationCampaignMetrics Description: 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](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/orders/search-orders.md) and filter by `lineItems.catalogReference.catalogItemId` equal to the donation campaign GUID. URL: https://www.wixapis.com/donation-campaigns/v2/donation-campaigns/{donationCampaignId}/metrics Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: donationCampaignId Method parameters: param name: donationCampaignId | type: none | required: true Return type: GetDonationCampaignMetricsResponse - name: currencyMetricsList | type: array | description: List of metrics per currency. Currently returns only the site's default currency. - name: currencyCode | type: string | description: Three-letter currency code in ISO-4217 alphabetic format. - name: donationCount | type: integer | description: Total number of successful donations. - name: totalAmount | type: MultiCurrencyPrice | description: Total amount collected from all donations. - name: amount | type: string | description: Amount. - name: convertedAmount | type: string | description: Converted amount. - name: formattedAmount | type: string | description: Amount formatted with currency symbol. - name: formattedConvertedAmount | type: string | description: Converted amount formatted with currency symbol. Possible Errors: HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: CAMPAIGN_GOAL_NOT_SET | Description: Campaign goal must be configured before retrieving metrics. HTTP Code: 500 | Status Code: INTERNAL | Application Code: METRICS_TEMPORARILY_UNAVAILABLE | Description: Metrics are temporarily unavailable. Try again later. HTTP Code: 500 | Status Code: INTERNAL | Application Code: SITE_CURRENCY_UNAVAILABLE | Description: Site currency settings are temporarily unavailable. Try again later. ``` ### Examples ### Get Donation Campaign Metrics Gets metrics for a donation campaign by its ID ```curl curl -X GET \ 'https://www.wixapis.com/donation-campaigns/v2/donation-campaigns/87f8066e-f0e9-41da-b4ca-4bceb2ecdf31/metrics' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.donations.DonationCampaignService.getDonationCampaignMetrics(donationCampaignId) Description: 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](https://dev.wix.com/docs/rest/business-solutions/e-commerce/orders/orders/search-orders.md) and filter by `lineItems.catalogReference.catalogItemId` equal to the donation campaign GUID. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: donationCampaignId Method parameters: param name: donationCampaignId | type: string | description: GUID of the donation campaign to retrieve metrics for. | required: true Return type: PROMISE - name: currencyMetricsList | type: array | description: List of metrics per currency. Currently returns only the site's default currency. - name: currencyCode | type: string | description: Three-letter currency code in ISO-4217 alphabetic format. - name: donationCount | type: integer | description: Total number of successful donations. - name: totalAmount | type: MultiCurrencyPrice | description: Total amount collected from all donations. - name: amount | type: string | description: Amount. - name: convertedAmount | type: string | description: Converted amount. - name: formattedAmount | type: string | description: Amount formatted with currency symbol. - name: formattedConvertedAmount | type: string | description: Converted amount formatted with currency symbol. Possible Errors: HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: CAMPAIGN_GOAL_NOT_SET | Description: Campaign goal must be configured before retrieving metrics. HTTP Code: 500 | Status Code: INTERNAL | Application Code: METRICS_TEMPORARILY_UNAVAILABLE | Description: Metrics are temporarily unavailable. Try again later. HTTP Code: 500 | Status Code: INTERNAL | Application Code: SITE_CURRENCY_UNAVAILABLE | Description: Site currency settings are temporarily unavailable. Try again later. ``` ### Examples ### getDonationCampaignMetrics ```javascript import { donationCampaigns } from '@wix/donations'; async function getDonationCampaignMetrics(donationCampaignId) { const response = await donationCampaigns.getDonationCampaignMetrics(donationCampaignId); }; ``` ### getDonationCampaignMetrics (with elevated permissions) ```javascript import { donationCampaigns } from '@wix/donations'; import { auth } from '@wix/essentials'; async function myGetDonationCampaignMetricsMethod(donationCampaignId) { const elevatedGetDonationCampaignMetrics = auth.elevate(donationCampaigns.getDonationCampaignMetrics); const response = await elevatedGetDonationCampaignMetrics(donationCampaignId); } ``` ### getDonationCampaignMetrics (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { donationCampaigns } from '@wix/donations'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { donationCampaigns }, // Include the auth strategy and host as relevant }); async function getDonationCampaignMetrics(donationCampaignId) { const response = await myWixClient.donationCampaigns.getDonationCampaignMetrics(donationCampaignId); }; ``` ---