Reports Module API

API reference for report generation and retrieval endpoints.

BriteCore v2 Reports API endpoint wrappers.

britecore_sdk.api.api_calls.v2.reports.create_report_category(payload=None, **kwargs)[source]

Create a new report category.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.data_frame_preview(payload=None, **kwargs)[source]

Preview a report data frame.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.delete_file(payload=None, **kwargs)[source]

Delete a report-related file.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.delete_report(payload=None, **kwargs)[source]

Delete a report definition.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.delete_report_category(payload=None, **kwargs)[source]

Delete an existing report category.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.fetch_prepared_yml(payload=None, **kwargs)[source]

Retrieve prepared YML content for report processing.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.get_s3_token(payload=None, **kwargs)[source]

Retrieve an S3 upload token for report files.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.list_df_cache_files(payload=None, **kwargs)[source]

List files attached to a dataframe cache record.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.list_df_caches(payload=None, **kwargs)[source]

List available dataframe cache entries.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.list_files(report_id, **kwargs)[source]

List files associated with a report.

POST /api/v2/reports/list_files

Parameters:

report_id (str)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.rename_report_category(payload=None, **kwargs)[source]

Rename an existing report category.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.retrieve_report(report_id, **kwargs)[source]

Retrieve a report by identifier.

POST /api/v2/reports/retrieve_report

Parameters:

report_id (str)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.retrieve_reports(**kwargs)[source]

Retrieve the available reports.

POST /api/v2/reports/retrieve_reports

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.reports.upload_file(payload=None, **kwargs)[source]

Upload a file used by report processing.

Parameters:

payload (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.check_report_process_status(report_process_id=None, **kwargs)[source]

Check Report Process Status.

POST /api/v2/reports/check_report_process_status

Parameters:

report_process_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.download_report_file(file_id=None, **kwargs)[source]

Download Report File.

POST /api/v2/reports/download_report_file

Parameters:

file_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.generate_consolidated_declaration(policy_group=None, **kwargs)[source]

Generate Consolidated Declaration.

POST /api/v2/reports/generate_consolidated_declaration

Parameters:

policy_group (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.retrieve_report_categories(**kwargs)[source]

Retrieve Report Categories.

POST /api/v2/reports/retrieve_report_categories

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.reports.retrieve_sql_reports(**kwargs)[source]

Retrieve Sql Reports.

POST /api/v2/reports/retrieve_sql_reports

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.reports.run_report(additional_report_configuration=None, start_date=None, end_date=None, report_name=None, **kwargs)[source]

Run Report.

POST /api/v2/reports/run_report

Parameters:

additional_report_configuration (dict[str, Any] | None)
start_date (str | None)
end_date (str | None)
report_name (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.reports.save_report(report_data=None, **kwargs)[source]

Save Report.

POST /api/v2/reports/save_report

Parameters:

report_data (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any