> 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

# CountRibbons

# Package: catalogV3

# Namespace: RibbonService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/count-ribbons.md

## Permission Scopes:
Read ribbons in v3 catalog: SCOPE.STORES.RIBBON_READ

## Introduction

Counts the ribbons that match the provided filter.

If no filter is passed, Count Ribbons returns the total number of ribbons on the store.

Count Ribbons inherits its filtering from [Query Ribbons](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/query-ribbons.md) and supports the same filters.
Sorting and paging don't apply. To learn about filtering, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md).

---

## REST API

### Schema

```
 Method: countRibbons
 Description: Counts the ribbons that match the provided filter.  If no filter is passed, Count Ribbons returns the total number of ribbons on the store.  Count Ribbons inherits its filtering from [Query Ribbons](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/query-ribbons.md) and supports the same filters. Sorting and paging don't apply. To learn about filtering, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md).
 URL: https://www.wixapis.com/stores/v3/ribbons/count
 Method: POST
 Method parameters:
   param name: filter | type: filter | description: Filter object. Learn more about [API query language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md).  To understand the supported filters, see `QueryRibbons`.  
 Return type: CountRibbonsResponse
  - name: count | type: integer | description: Number of ribbons that match the filter. If no filter is passed, this is the total number of ribbons on the store.  


```

### Examples

### Count ribbons
```curl
curl -X POST \
 'https://www.wixapis.com/stores/v3/ribbons/count' \
 -H 'Content-type: application/json' \
 -H 'Authorization: <AUTH>' \
 -d '{
   "filter": {"name": {"$startsWith":"New"}}
 }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.stores.ribbonsV3.countRibbons(options)
 Description: Counts the ribbons that match the provided filter.  If no filter is passed, Count Ribbons returns the total number of ribbons on the store.  Count Ribbons inherits its filtering from [Query Ribbons](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/ribbons-v3/query-ribbons.md) and supports the same filters. Sorting and paging don't apply. To learn about filtering, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md).
 Method parameters:
   param name: options | type: CountRibbonsOptions  none  
        - name: filter | type: object | description: Filter object. Learn more about [API query language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language.md).  To understand the supported filters, see `QueryRibbons`.  
 Return type: PROMISE<CountRibbonsResponse>
  - name: count | type: integer | description: Number of ribbons that match the filter. If no filter is passed, this is the total number of ribbons on the store.  


```

### Examples

### Count ribbons by name prefix
Count the ribbons whose name starts with "New", without paging through Query Ribbons.

```javascript
import { ribbonsV3 } from "@wix/stores";

async function countRibbons() {
  const response = await ribbonsV3.countRibbons({
    filter: {
      name: {
        $startsWith: "New",
      },
    },
  });
  return response;
}

/* Promise resolves to:
 * {
 *   "count": 2
 * }
 */

```

### countRibbons (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 { ribbonsV3 } from '@wix/stores';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { ribbonsV3 },
  // Include the auth strategy and host as relevant
});


async function countRibbons(options) {
  const response = await myWixClient.ribbonsV3.countRibbons(options);
};
```

---