---
title: "Get-NectarTenantMetrics"
slug: "get-nectartenantmetrics"
updated: 2024-08-20T19:49:21Z
published: 2024-08-20T19:49:21Z
canonical: "support.nectarcorp.com/get-nectartenantmetrics"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.nectarcorp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get-NectarTenantMetrics

Shows all the tenant sizing metrics on the platform

## Description

Shows all the tenant sizing metrics on the platform. Only available for global admins.

## Syntax

```
Get-NectarTenantMetrics
  -TenantName  <String>
```

## Examples

### Example 1

```
Get-NectarTenantMetrics
```

Returns all metrics for all tenants

### Example 2

```
Get-NectarTenantMetrics -TenantName Contosu
```

Returns all metrics for the Contoso tenant

### Example 3

```
Get-NectarTenantMetrics | Where {$_.name -like '*USERS' -And $_.value -gt 0} | FT
```

Returns all user counts for all tenants where the value is greater than 0

## Parameters

**-TenantName <String>** Return metric values for a single tenant

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |