Get-NectarEventCount

Return a sampling of event counts for a given time period grouped by event severity.

Description

Return a sampling of event counts for a given time period grouped by event severity. This is only a sample and is not intended to provide a true count of the number of events in a given period.
Its useful for situations where you want to get a sense of event distribution without having to pull the entire list of events, which can take a lot of time.

Syntax

Get-NectarEventCount
  -TimePeriod  <String>
  -TimePeriodFrom  <DateTime>
  -TimePeriodTo  <DateTime>
  -TenantName  <String>

Examples

Example 1

Get-NectarEventCount -TimePeriod LAST_WEEK

Returns a count of events grouped by severity for the last week

Parameters

-TimePeriod <String>
The time period to show event 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_DAY
Accept pipeline input?	false
Accept wildcard characters?	false

-TimePeriodFrom <DateTime>
The earliest date/time to show event 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 event 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

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