---
title: "Get-NectarEndpointTestCount"
slug: "get-nectarendpointtestcount"
updated: 2024-08-21T15:49:13Z
published: 2024-08-21T15:49:13Z
canonical: "support.nectarcorp.com/get-nectarendpointtestcount"
---

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

Returns summary information about Endpoint Client tests

## Description

Returns summary information about Endpoint Client tests

## Syntax

```
Get-NectarEndpointTestCount
  -TimePeriod  <String>
  -TimePeriodFrom  <DateTime>
  -TimePeriodTo  <DateTime>
  -TestTypes  <String[]>
  -TestResults  <String[]>
  -HubOrEndpoint  <String>
  -ResponseCodes  <String[]>
  -Users  <String[]>
  -FromUsers  <String[]>
  -ToUsers  <String[]>
  -UserIDs  <String[]>
  -FromUserIDs  <String[]>
  -ToUserIDs  <String[]>
  -Locations  <String[]>
  -CallerLocations  <String[]>
  -CalleeLocations  <String[]>
  -ExtCities  <String[]>
  -CallerExtCities  <String[]>
  -CalleeExtCities  <String[]>
  -ExtCountries  <String[]>
  -CallerExtCountries  <String[]>
  -CalleeExtCountries  <String[]>
  -ExtISPs  <String[]>
  -CallerExtISPs  <String[]>
  -CalleeExtISPs  <String[]>
  -OrderDirection  <String>
  -TenantName  <String>
```

## Examples

### Example 1

```
Get-NectarEndpointTestCount -TimePeriod LAST_HOUR -TestTypes P2P -TestResults FAILED
```

Returns a count of all Endpoint Client P2P tests that failed within the last hour

### Example 2

```
Get-NectarEndpointTestCount -TimePeriod LAST_DAY -Locations 'Head Office', Warehouse
```

Returns a count of all Endpoint Client tests where either the caller or callee was in the corporate head office or the warehouse

### Example 3

```
Get-NectarEndpointTestSummary -TimePeriod LAST_WEEK -CallerExtCities Chicago, Dallas
```

Returns a count of all Endpoint Client tests from the last week where the caller was in either Chicago or Dallas

## 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 | named |
| 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 | named |
| 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 | named |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-TestTypes <String[]>** The types of EPC tests to return. Choose from one or more of 'P2P', 'PING', 'AUDIO', or 'VIDEO'

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

**-TestResults <String[]>** The result type to return. Choose from one or more of 'PASSED','FAILED', 'INCOMPLETE' or 'UNKNOWN'

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

**-HubOrEndpoint <String>**

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | named |
| Required | false |
| Default Value | ENDPOINT |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-ResponseCodes <String[]>** Show tests that match one or more SIP response codes. Accepts numbers from 0 to 699

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | named |
| 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 | named |
| 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 | named |
| 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 | named |
| 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 | named |
| 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 | named |
| 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 | named |
| 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 | named |
| 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 | named |
| 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 | named |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-ExtCities <String[]>** Show sessions where the caller or callee was located in the selected city (as detected via geolocating the user's external IP address). Can query for multiple cities.

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

**-CallerExtCities <String[]>** Show sessions where the caller was located in the selected city (as detected via geolocating the user's external IP address). Can query for multiple cities.

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

**-CalleeExtCities <String[]>** Show sessions where the callee was located in the selected city (as detected via geolocating the user's external IP address). Can query for multiple cities.

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

**-ExtCountries <String[]>** Show sessions where the caller or callee was located in the selected country (as detected via geolocating the user's external IP address). Can query for multiple countries.

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

**-CallerExtCountries <String[]>** Show sessions where the caller was located in the selected country (as detected via geolocating the user's external IP address). Can query for multiple countries.

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

**-CalleeExtCountries <String[]>** Show sessions where the callee was located in the selected country (as detected via geolocating the user's external IP address). Can query for multiple countries.

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

**-ExtISPs <String[]>** Show sessions where the caller or callee was located in the selected ISP (as detected via geolocating the user's external IP address). Can query for multiple ISPs.

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

**-CallerExtISPs <String[]>** Show sessions where the caller was located in the selected ISP (as detected via geolocating the user's external IP address). Can query for multiple ISPs.

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

**-CalleeExtISPs <String[]>** Show sessions where the callee was located in the selected ISP (as detected via geolocating the user's external IP address). Can query for multiple ISPs.

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

**-OrderDirection <String>** Sort direction. Use with OrderByField. Not case sensitive. Choose from: ASC, DESC

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

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

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