> 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

# GetPostMetrics

# Package: blog

# Namespace: PostService

# Method link: https://dev.wix.com/docs/api-reference/business-solutions/blog/posts-stats/get-post-metrics.md

## Permission Scopes:
Read Blog : SCOPE.DC-BLOG.READ-BLOGS

## Introduction

Retrieves a post's metrics.

A post's metrics include the comments, likes, and views the post receives.

---

## REST API

### Schema

```
 Method: getPostMetrics
 Description: Retrieves a post's metrics.  A post's metrics include the comments, likes, and views the post receives.
 URL: https://www.wixapis.com/v3/posts/{postId}/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:  postId
 Method parameters: 
   param name: postId | type:   none | required: true
 Return type: GetPostMetricsResponse
  - name: metrics | type: Metrics | description: Retrieved post metrics. 
     - name: comments | type: integer | description: Total number of post comments. 
     - name: likes | type: integer | description: Total number of post likes. 
     - name: views | type: integer | description: Total number of post views. 


```

### Examples

### GetPostMetrics
```curl
~~~cURL
curl \
  'https://www.wixapis.com/blog/v3/posts/894a58a2-dc75-422d-9ca6-00a489750dfd/metrics' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: <AUTH>'
~~~
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.blog.PostService.getPostMetrics(postId)
 Description: Retrieves a post's metrics.  A post's metrics include the comments, likes, and views the post receives.
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  postId
 Method parameters: 
   param name: postId | type: string | description: Post GUID to retrieve metrics for. | required: true
 Return type: PROMISE<GetPostMetricsResponse>
  - name: metrics | type: Metrics | description: Retrieved post metrics. 
     - name: comments | type: integer | description: Total number of post comments. 
     - name: likes | type: integer | description: Total number of post likes. 
     - name: views | type: integer | description: Total number of post views. 


```

### Examples

### Get the metrics of a post
```javascript
import { posts } from '@wix/blog';

/* Sample postId value:
 * 'ccbb6257-ed0e-4521-97df-8b5b207adb00'
 */

export async function getPostMetricsFunction(postId) {
  try {
    const result = await posts.getPostMetrics(postId);
    const likes = result.metrics.likes;
    console.log('Retrieved Result:', result);
    return result;
  } catch (error) {
     console.log(error);
  }
}

/* Promise resolves to:
 * {
 *    "metrics":  {
 *      "comments": 8,
 *      "likes": 20,
 *      "views": 2
 *    }
 *  }
 */
```

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

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


async function getPostMetrics(postId) {
  const response = await myWixClient.posts.getPostMetrics(postId);
};
```

---