---
title: "Get-NectarQualitySummary"
slug: "get-nectarqualitysummary"
updated: 2024-08-21T15:07:28Z
published: 2024-08-21T15:07:28Z
canonical: "support.nectarcorp.com/get-nectarqualitysummary"
---

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

Returns summary quality information for Avaya/Cisco quality records

## Description

Returns summary quality information for Avaya/Cisco quality records. Used to build the QUALITY section of the CALL DETAILS Quality Details screen.

## Syntax

```
Get-NectarQualitySummary
  -TimePeriod  <String>
  -TimePeriodFrom  <DateTime>
  -TimePeriodTo  <DateTime>
  -SessionQualities  <String[]>
  -NectarScore  <String>
  -Codecs  <String[]>
  -CallerCodecs  <String[]>
  -CalleeCodecs  <String[]>
  -IPAddresses  <IPAddress[]>
  -CallerIPAddresses  <IPAddress[]>
  -CalleeIPAddresses  <IPAddress[]>
  -Locations  <String[]>
  -CallerLocations  <String[]>
  -CalleeLocations  <String[]>
  -Platforms  <String[]>
  -Servers  <String[]>
  -EndpointTypes  <String[]>
  -CallerEndpointTypes  <String[]>
  -CalleeEndpointTypes  <String[]>
  -Users  <String[]>
  -FromUsers  <String[]>
  -ToUsers  <String[]>
  -UserIDs  <String[]>
  -FromUserIDs  <String[]>
  -ToUserIDs  <String[]>
  -AgentVersions  <String[]>
  -CallerAgentVersions  <String[]>
  -CalleeAgentVersions  <String[]>
  -TenantName  <String>
  -Scope  <String>
  -PageSize  <Int32>
  -ResultSize  <Int32>
```

## Examples

### Example 1

```
Get-NectarQualitySummary -TimePeriod LAST_DAY
```

Returns the quality summary for the past day

## Parameters

**-TimePeriod <String>** The time period to show session data from. Select from 'LAST_HOUR','LAST_DAY','LAST_WEEK','LAST_MONTH','CUSTOM'. CUSTOM requires using TimePeriodFrom and TimePeriodTo parameters.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | LAST_HOUR |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-TimePeriodFrom <DateTime>** The earliest date/time to show session data from. Must be used in conjunction with -TimePeriod CUSTOM and TimePeriodTo parameters. Use format 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'. All time/dates in UTC.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-TimePeriodTo <DateTime>** The latest date/time to show session data from. Must be used in conjunction with -TimePeriod CUSTOM and TimePeriodFrom parameters. Use format 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'. All time/dates in UTC.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-SessionQualities <String[]>** Show sessions that match a given quality rating. Case sensitive. Choose one or more from: 'GOOD','POOR_0_25','PARTIALLY_GOOD_25_50','PARTIALLY_GOOD_50_75','PARTIALLY_GOOD_75_100','UNAVAILABLE','UNKNOWN'

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-NectarScore <String>**

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 5 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-Codecs <String[]>** Show sessions where the selected codec was used by either caller or callee. Can query for multiple codecs. Case sensitive. Use Get-NectarCodecs for a list of valid codecs.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 6 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-CallerCodecs <String[]>** Show sessions where the selected codec was used by the caller. Can query for multiple codecs. Case sensitive. Use Get-NectarCodecs for a list of valid codecs.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 7 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-CalleeCodecs <String[]>** Show sessions where the selected codec was used by the callee. Can query for multiple codecs. Case sensitive. Use Get-NectarCodecs for a list of valid codecs.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 8 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-IPAddresses <IPAddress[]>** Show sessions where the selected IP address was used by either caller or callee. Can query for multiple IPs.

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

**-CallerIPAddresses <IPAddress[]>** Show sessions where the selected IP address was used by the caller. Can query for multiple IPs.

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

**-CalleeIPAddresses <IPAddress[]>** Show sessions where the selected IP address was used by the callee. Can query for multiple IPs.

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

**-Locations <String[]>** Show sessions where the selected location was used by either caller or callee. Can query for multiple locations.

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

**-CallerLocations <String[]>** Show sessions where the selected location was used by the caller. Can query for multiple locations.

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

**-CalleeLocations <String[]>** Show sessions where the selected location was used by the callee. Can query for multiple locations.

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

**-Platforms <String[]>** Show sessions where the selected platform was used by either caller or callee. Can query for multiple platforms. Case sensitive. Choose one or more from: 'SKYPE','CISCO','CISCO_CMS','CISCO_VKM','CISCO_WEBEX_CALLING','TEAMS','SKYPE_ONLINE','CISCO_CMS_VKM','AVAYA_AURA_CM','RIG','LYNC_VKM','SKYPE_FOR_BUSINESS_VKM','CISCO_UNITY','CISCO_EXPRESSWAY','AVAYA_MEDIA_GATEWAY','AVAYA_SESSION_MANAGER','AVAYA_VOICE_PORTAL','ZOOM','ENDPOINT_CLIENT','WEB_RTC_AIR_PHONE','WEB_RTC_AMAZON_CONNECT','WEB_RTC_CISCO_WEBEX','WEB_RTC_FIVE9','WEB_RTC_GENESYS_CLOUD','WEB_RTC_GENESYS_MCPE','WEB_RTC_NICE_CXONE','DIAGNOSTICS','JABRA','MISCELLANEOUS'

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 15 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-Servers <String[]>**

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 16 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-EndpointTypes <String[]>** Show sessions where one or more selected Avaya endpoint types have been used. Choose one or more from: 'medsvr','mgdsp','node','phone','unknown'

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 17 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-CallerEndpointTypes <String[]>** Show sessions where one or more selected Avaya endpoint types have been used by the caller. Choose one or more from: 'medsvr','mgdsp','node','phone','unknown'

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 18 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-CalleeEndpointTypes <String[]>** Show sessions where one or more selected Avaya endpoint types have been used by the callee. Choose one or more from: 'medsvr','mgdsp','node','phone','unknown'

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 19 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-Users <String[]>** Show sessions where the selected user was either caller or callee. Can query for multiple users.

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

**-FromUsers <String[]>** Show sessions where the selected user was the caller. Can query for multiple users.

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

**-ToUsers <String[]>** Show sessions where the selected user was the callee. Can query for multiple users.

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

**-UserIDs <String[]>** Show sessions where the selected user ID was either caller or callee. Can query for multiple user IDs.

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

**-FromUserIDs <String[]>** Show sessions where the selected user ID was the caller. Can query for multiple user IDs.

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

**-ToUserIDs <String[]>** Show sessions where the selected user ID was the callee. Can query for multiple user IDs.

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

**-AgentVersions <String[]>** Show sessions where the selected agent version was used by either caller or callee. Can query for multiple agent. Case sensitive. Use Get-NectarAgentVersion for a list of valid agent versions.

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

**-CallerAgentVersions <String[]>** Show sessions where the selected agent version was used by either caller or callee. Can query for multiple agent. Case sensitive. Use Get-NectarAgentVersion for a list of valid agent versions.

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

**-CalleeAgentVersions <String[]>** Show sessions where the selected agent version was used by either caller or callee. Can query for multiple agent. Case sensitive. Use Get-NectarAgentVersion for a list of valid agent versions.

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

**-TenantName <String>** The name of the Nectar DXP tenant. Used in multi-tenant configurations.

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

**-Scope <String>**

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 30 |
| Required | false |
| Default Value | QUALITY_DETAILS |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-PageSize <Int32>** The size of the page used to return data. Defaults to 1000

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 31 |
| Required | false |
| Default Value | 1000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-ResultSize <Int32>** The total number of results to return. Defaults to 1000. Maximum result size is 9,999,999 results

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 32 |
| Required | false |
| Default Value | 0 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |