Get-NectarSessionSummary
- 15 May 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-NectarSessionSummary
- Updated on 15 May 2023
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Returns call summary information for a given session
Description
Returns call summary information for a given session. This is used to populate the top few sections of an individual session on the session OVERVIEW screen.
Syntax
Get-NectarSessionSummary
-SessionID <String>
-Platform <String>
-TenantName <String>
Examples
Example 1
Get-NectarSessionSummary 2021-04-30T16:04:28.572701_1_1_*_*_*_6_*_29fe15a4-99e5-4a2c-92a6-fbf3024944fc_29abe23a4-33e5-4a2c-92a6-faf30445e5bc_* -Platform TEAMS
Returns summary information for a specific Teams session
Example 2
Get-NectarSessions -Platform TEAMS -Users tferguson@contoso.com -SessionTypes PEER2PEER -TimePeriod LAST_DAY | Get-NectarSessionSummary -Platform TEAMS
Returns summary information for all Teams peer-to-peer calls for TFerguson for the last day.
Parameters
-SessionID <String>
The session ID of the selected session
| Parameter | Value |
|---|---|
| Required | true |
| Position | 1 |
| Required | true |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
-Platform <String>
The platform where the session took place
| Parameter | Value |
|---|---|
| Required | true |
| Position | 2 |
| Required | true |
| 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 | 3 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Was this article helpful?