--- title: "Get-NectarSession" slug: "get-nectarsessions" updated: 2023-05-15T17:41:31Z published: 2023-05-15T17:41:31Z canonical: "support.nectarcorp.com/get-nectarsessions" --- > ## 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-NectarSession Returns all session information. ## Description Returns all session information as presented on the SESSION LIST section of the CALL DETAILS page ## Syntax ``` Get-NectarSession -TimePeriod -TimePeriodFrom -TimePeriodTo -SessionQualities -DurationFrom -DurationTo -Modalities -Protocols -ResponseCodes -SessionScenarios -SessionTypes -Codecs -CallerCodecs -CalleeCodecs -Devices -CallerDevices -CalleeDevices -DeviceVersions -CallerDeviceVersions -CalleeDeviceVersions -IPAddresses -CallerIPAddresses -CalleeIPAddresses -Locations -CallerLocations -CalleeLocations -ExtCities -CallerExtCities -CalleeExtCities -ExtCountries -CallerExtCountries -CalleeExtCountries -ExtISPs -CallerExtISPs -CalleeExtISPs -ExtConnectionTypes -CallerExtConnectionTypes -CalleeExtConnectionTypes -NetworkTypes -CallerNetworkTypes -CalleeNetworkTypes -Platforms -Users -FromUsers -ToUsers -ConfOrganizers -VPN -CallerVPN -CalleeVPN -ParticipantsMinCount -ParticipantsMaxCount -FeedbackRating -Insights -OrderByField -OrderDirection -TenantName -Scope -PageSize -ResultSize ``` ## Examples ### Example 1 ``` Get-NectarSessions -TimePeriod LAST_HOUR -Platforms TEAMS -Modalities AUDIO -SessionQualities POOR ``` Returns a list of all Teams audio sessions for the past hour where the quality was rated Poor ### Example 2 ``` (Get-NectarSession -SessionTypes CONFERENCE -TimePeriod CUSTOM -TimePeriodFrom '2021-05-06' -TimePeriodTo '2021-05-07').Count ``` Returns a count of all conferences between May 6 and 7 (all times/dates UTC) ### Example 3 ``` Get-NectarSession -SessionTypes PEER2PEER,PEER2PEER_MULTIMEDIA -TimePeriod CUSTOM -TimePeriodFrom '2021-05-06 14:00' -TimePeriodTo '2021-05-06 15:00' ``` Returns a list of all P2P calls between 14:00 and 15:00 UTC on May 6 ### Example 4 ``` Get-NectarSession -TimePeriod LAST_WEEK -SessionTypes CONFERENCE | Select-Object confOrganizerOrSpace | Group-Object confOrganizerOrSpace | Select-Object Name, Count | Sort-Object Count -Descending ``` Returns a list of conference organizers and a count of the total conferences organized by each, sorted by count. ## Parameters **-TimePeriod ** 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 ** 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 ** 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 | **-SessionQualities ** 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 | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-DurationFrom ** The shortest call length (in seconds) to show session data. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | 0 | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-DurationTo ** The longest call length (in seconds) to show session data. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | 99999999 | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-Modalities ** Show sessions that match one or more modality types. Not case sensitive. Choose one or more from: 'AUDIO','VIDEO','APP_SHARING','FILE_TRANSFER','IM','UNKNOWN','TOTAL','VBSS','REMOTE_ASSISTANCE','APP_INVITE','FOCUS','UNKNOWN' | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-Protocols ** Show sessions that match one or more network protocol types. Case sensitive. Choose one or more from: 'TCP','UDP','Unknown' | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-ResponseCodes ** Show sessions that match one or more SIP response codes. Accepts numbers from 200 to 699 | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-SessionScenarios ** Show sessions that match one or more session scenarios. Not case sensitive. Choose one or more from: 'External','Internal','Internal-External','External-Internal','Federated','Internal-Federated','External-Federated','Unknown' | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-SessionTypes ** Show sessions that match one or more session scenarios. Case sensitive. Choose one or more from: 'Conference','Peer To Peer','Peer To Peer (Multimedia)','PSTN/External' | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-Codecs ** 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 | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-CallerCodecs ** 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 | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-CalleeCodecs ** 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 | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-Devices ** Show sessions where the selected device was used by either caller or callee. Can query for multiple devices. Case sensitive. Use Get-NectarSupportedDevice for a list of valid devices. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-CallerDevices ** Show sessions where the selected device was used by the caller. Can query for multiple devices. Case sensitive. Use Get-NectarSupportedDevice for a list of valid devices. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-CalleeDevices ** Show sessions where the selected device was used by the callee. Can query for multiple devices. Case sensitive. Use Get-NectarSupportedDevice for a list of valid devices. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-DeviceVersions ** Show sessions where the selected device version was used by either caller or callee. Can query for multiple devices. Case sensitive. Use Get-NectarClientVersion for a list of valid client versions. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-CallerDeviceVersions ** Show sessions where the selected device version was used by the caller. Can query for multiple devices. Case sensitive. Use Get-NectarClientVersion for a list of valid client versions. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-CalleeDeviceVersions ** Show sessions where the selected device version was used by the callee. Can query for multiple devices. Case sensitive. Use Get-NectarClientVersion for a list of valid client versions. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-IPAddresses ** Show sessions where the selected IP address was used by either caller or callee. Can query for multiple IPs. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-CallerIPAddresses ** Show sessions where the selected IP address was used by the caller. Can query for multiple IPs. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-CalleeIPAddresses ** Show sessions where the selected IP address was used by the callee. Can query for multiple IPs. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-Locations ** 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 ** 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 ** 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 ** 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 ** 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 ** 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 ** 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 ** 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 ** 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 ** 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 ** 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 ** 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 | **-ExtConnectionTypes ** Show sessions that match the caller or callee external connection type (as detected via geolocating the user's external IP address). Can query for multiple types. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-CallerExtConnectionTypes ** Show sessions that match the caller external connection type (as detected via geolocating the user's external IP address). Can query for multiple types. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-CalleeExtConnectionTypes ** Show sessions that match the callee external connection type (as detected via geolocating the user's external IP address). Can query for multiple types. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | | **-NetworkTypes ** | | | Show sessions where the selected network type was used by either caller or callee. Can query for multiple network types. Case sensitive. Choose one or more from: | | | 'Enterprise WiFi','Enterprise Wired','External Mobile','External WiFi','External Wired','Unknown','Unavailable' | | | Parameter | Value | | ---- | ---- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-CallerNetworkTypes ** Show sessions where the selected network type was used by the caller. Can query for multiple network types. Case sensitive. Choose one or more from: 'Enterprise WiFi','Enterprise Wired','External Mobile','External WiFi','External Wired','Unknown','Unavailable' | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-CalleeNetworkTypes ** Show sessions where the selected network type was used by the callee. Can query for multiple network types. Case sensitive. Choose one or more from: 'Enterprise WiFi','Enterprise Wired','External Mobile','External WiFi','External Wired','Unknown','Unavailable' | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-Platforms ** 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','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','MISCELLANEOUS' | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-Users ** 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 ** 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 ** 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 | **-ConfOrganizers ** Show sessions hosted by a specified conference organizer. Can query for multiple organizers. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | true (ByPropertyName) | | Accept wildcard characters? | false | **-VPN ** Show sessions where the selected VPN was used by either caller or callee. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-CallerVPN ** Show sessions where the selected VPN was used by the caller. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-CalleeVPN ** Show sessions where the selected VPN was used by the callee. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-ParticipantsMinCount ** Show sessions where the number of participants is greater than or equal to the entered value | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | 0 | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-ParticipantsMaxCount ** Show sessions where the number of participants is less than or equal to the entered value | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | 0 | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-FeedbackRating ** Show sessions where users provided specific feedback ratings from BAD to EXCELLENT. Allowed values are BAD, POOR, FAIR, GOOD, EXCELLENT. Corresponds to ratings from 1 to 5 stars. | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-Insights ** Show sessions that match one or more given insights. Choose from NORMAL_SESSION, VOICE_MAIL, HIGH_JITTER, HIGH_PACKET_LOSS, HIGH_ROUNDTRIP_DELAY | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-OrderByField ** Sort the output by the selected field | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | None | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-OrderDirection ** 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 ** 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 | **-Scope ** | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | DEFAULT | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-PageSize ** The size of the page used to return data. Defaults to 1000 | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | 1000 | | Accept pipeline input? | false | | Accept wildcard characters? | false | **-ResultSize ** The total number of results to return. Defaults to 1000. Maximum result size is 9,999,999 results | Parameter | Value | | --- | --- | | Required | false | | Position | named | | Required | false | | Default Value | 0 | | Accept pipeline input? | false | | Accept wildcard characters? | false |