Get FalconScheduledReport

Get-FalconScheduledReport

SYNOPSIS

Search for scheduled report or searches and their execution information

DESCRIPTION

Requires 'Scheduled Reports: Read'.

PARAMETERS

Name	Type	Min	Max	Allowed	Pipeline	PipelineByName	Description
Id	String[]				X	X	Scheduled report or scheduled search identifier
Filter	String						Falcon Query Language expression to limit results
Query	String						Perform a generic substring search across available fields
Sort	String			created_on.asc created_on.desc last_updated_on.asc last_updated_on.desc last_execution_on.asc last_execution_on.desc next_execution_on.asc next_execution_on.desc			Property and direction to sort results
Limit	Int32	1	5000				Maximum number of results per request
Offset	Int32						Position to begin retrieving results
Execution	Switch						Retrieve information about scheduled report execution
Detailed	Switch						Retrieve detailed information
All	Switch						Repeat requests until all available results are retrieved
Total	Switch						Display total result count instead of results

SYNTAX

Get-FalconScheduledReport [[-Filter] <String>] [[-Query] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [-Offset <Int32>] [-Detailed] [-All] [-Total] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-FalconScheduledReport -Id <String[]> -Execution [-WhatIf] [-Confirm] [<CommonParameters>]

Get-FalconScheduledReport -Id <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Get-FalconScheduledReport [[-Filter] <String>] [[-Query] <String>] [[-Sort] <String>] [[-Limit] <Int32>] [-Offset <Int32>] -Execution [-Detailed] [-All] [-Total] [-WhatIf] [-Confirm] [<CommonParameters>]

SDK Reference

falconpy

scheduled_reports.query
report_executions.get
scheduled_reports.get
report_executions.query

USAGE

List the first five scheduled report IDs that match a filtered search

Get-FalconScheduledReport -Filter "created_on:<'2021-09-15'+status:'ACTIVE'+type:['hosts','spotlight_remediations']" -Limit 5 [-Detailed]

Retrieve details about a scheduled report

Get-FalconScheduledReport -Id <id>, <id>

List the first five scheduled report execution IDs that match a filtered search

Get-FalconScheduledReport -Filter "created_on:<'2021-10-01'+type:['hosts','dashboard']" -Limit 5 -Sort created_on.desc -Execution [-Detailed]

Retrieve details about a scheduled report execution

Get-FalconScheduledReport -Id <id>, <id> -Execution

2022-10-24: PSFalcon v2.2.3