Report Executions

Using the Report Executions service collection

Table of Contents

Operation ID	Description
report_executions_download_get PEP8 get_download	Get report entity download
report_executions_get PEP8 get_reports	Retrieve report details for the provided report IDs.
report_executions_query PEP8 query_reports	Find all report execution IDs matching the query with filter

report_executions_download_get

Get report entity download

PEP8 method name

get_download

Content-Type

• Consumes: application/json
• Produces: application/octet-stream

Parameters

Required	Name	Type	Datatype	Description
✅	ids	query	string	The report_execution id to download

Usage

Service class example (PEP8 syntax)

from falconpy.report_executions import ReportExecutions

falcon = ReportExecutions(client_id="API_CLIENT_ID_HERE",
                          client_secret="API_CLIENT_SECRET_HERE"
                          )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_download(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy.report_executions import ReportExecutions

falcon = ReportExecutions(client_id="API_CLIENT_ID_HERE",
                          client_secret="API_CLIENT_SECRET_HERE"
                          )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.report_executions_download_get(ids=id_list)
print(response)

Uber class example

from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("report_executions_download_get", ids=id_list)
print(response)

report_executions_get

Retrieve report details for the provided report IDs.

PEP8 method name

get_reports

Content-Type

• Consumes: application/json
• Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
✅	ids	query	array (string)	The report_execution id to get details about.

Usage

Service class example (PEP8 syntax)

from falconpy.report_executions import ReportExecutions

falcon = ReportExecutions(client_id="API_CLIENT_ID_HERE",
                          client_secret="API_CLIENT_SECRET_HERE"
                          )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.get_reports(ids=id_list)
print(response)

Service class example (Operation ID syntax)

from falconpy.report_executions import ReportExecutions

falcon = ReportExecutions(client_id="API_CLIENT_ID_HERE",
                          client_secret="API_CLIENT_SECRET_HERE"
                          )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.report_executions_get(ids=id_list)
print(response)

Uber class example

from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("report_executions_get", ids=id_list)
print(response)

report_executions_query

Find all report execution IDs matching the query with filter

PEP8 method name

query_reports

Content-Type

• Consumes: application/json
• Produces: application/json

Parameters

Required	Name	Type	Datatype	Description
	sort	query	string	Possible order by fields: created_on, last_updated_on
	filter	query	string	FQL query specifying the filter parameters. Filter term criteria: type, scheduled_report_id, status. Filter range criteria: created_on, last_updated_on, expiration_on; use any common date format, such as '2010-05-15T14:55:21.892315096Z'.
	q	query	string	Match query criteria, which includes all the filter string fields
	offset	query	string	Starting index of overall result set from which to return ids.
	limit	query	integer	Number of ids to return.

Usage

Service class example (PEP8 syntax)

from falconpy.report_executions import ReportExecutions

falcon = ReportExecutions(client_id="API_CLIENT_ID_HERE",
                          client_secret="API_CLIENT_SECRET_HERE"
                          )

response = falcon.query_reports(sort="string",
                                filter="string",
                                q="string",
                                offset="string",
                                limit=integer
                                )
print(response)

Service class example (Operation ID syntax)

from falconpy.report_executions import ReportExecutions

falcon = ReportExecutions(client_id="API_CLIENT_ID_HERE",
                          client_secret="API_CLIENT_SECRET_HERE"
                          )

response = falcon.report_executions_query(sort="string",
                                          filter="string",
                                          q="string",
                                          offset="string",
                                          limit=integer
                                          )
print(response)

Uber class example

from falconpy.api_complete import APIHarness

falcon = APIHarness(client_id="API_CLIENT_ID_HERE",
                    client_secret="API_CLIENT_SECRET_HERE"
                    )

PARAMS = {
    "sort": "string",
    "filter": "string",
    "q": "string",
    "offset": "string",
    "limit": integer
}

response = falcon.command("report_executions_query", parameters=PARAMS)
print(response)