> To build or manage a Wix site with an AI agent, follow https://www.wix.com/headless/skill.md
> It builds a new Wix site or puts your own site online, from a prompt, and keeps changing it afterwards. The pages are code in any web technology, and Wix runs the backend.
> It works through the Wix plugin (the Wix MCP and the Wix skills), the Wix CLI or no Wix login, and puts the site live on Wix hosting or on another host.
> Business features include a store, bookings, events and tickets, a restaurant, a blog, forms, members and many more.
> Read the Wix skills online at https://www.wix.com/skills
> 
> 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`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - 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: @wix/donations

# Namespace: donationCampaigns

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

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.donations.donationCampaigns.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 | validation: format GUID
 Return type: PROMISE<GetDonationCampaignMetricsResponse>
  - name: currencyMetricsList | type: array<CurrencyMetrics> | description: List of metrics per currency.  Currently returns only the site's default currency.  | validation: maxItems 1
     - name: currencyCode | type: string | description: Three-letter currency code in ISO-4217 alphabetic format.  | validation: maxLength 8
     - 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.  | validation: decimalValue {"gte":"0","lte":"1000000000000000"}
        - name: convertedAmount | type: string | description: Converted amount.  | read-only: true | validation: decimalValue {"gte":"0","lte":"1000000000000000"}
        - name: formattedAmount | type: string | description: Amount formatted with currency symbol.  | read-only: true 
        - name: formattedConvertedAmount | type: string | description: Converted amount formatted with currency symbol.  | read-only: true 

 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-managed)
Self-managed 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);
};
```

---