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-NectarReport

Prev Next

Gets basic information about all available reports

Syntax

Get-NectarReport
  -SearchQuery  <String>
  -OrderByField  <String>
  -OrderDirection  <String>
  -TenantName  <String>
  -PageSize  <Int32>
  -ResultSize  <Int32>

Examples

Example 1

Get-NectarReport

Returns information about all reports

Parameters

-SearchQuery <String>

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

-OrderByField <String>

Parameter Value
Required false
Position 2
Required false
Default Value name
Accept pipeline input? false
Accept wildcard characters? false

-OrderDirection <String>

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

-PageSize <Int32>

Parameter Value
Required false
Position 5
Required false
Default Value 1000
Accept pipeline input? false
Accept wildcard characters? false

-ResultSize <Int32>

Parameter Value
Required false
Position 6
Required false
Default Value 0
Accept pipeline input? false
Accept wildcard characters? false