Data Module API

API reference for data management endpoints.

BriteCore v2 Data API endpoint wrappers.

This module provides wrappers for data export and dashboard-discovery endpoints in the BriteCore v2 data API.

britecore_sdk.api.api_calls.v2.data.export_data_as_csv(as_of_date=None, end_date=None, nonprep_dfs=None, prep_dfs=None, start_date=None, **kwargs)[source]

Export CSV data for the requested date range and data sets.

POST /api/v2/data/export_data_as_csv

Parameters:

  • as_of_date (str | None)

  • end_date (str | None)

  • nonprep_dfs (str | None)

  • prep_dfs (str | None)

  • start_date (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.data.get_available_dashboards(module=None, **kwargs)[source]

Retrieve dashboards available for a module.

POST /api/v2/data/get_available_dashboards

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.data.fetch_json_report_result(params=None, report_name=None, **kwargs)[source]

Fetch Json Report Result.

POST /api/v2/data/fetch_json_report_result

Parameters:

  • params (dict[str, Any] | None)

  • report_name (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.data.get_logical_catalog(**kwargs)[source]

Get Logical Catalog.

POST /api/v2/data/get_logical_catalog

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.data.preview_sql_check(query=None, params=None, **kwargs)[source]

Preview Sql Check.

POST /api/v2/data/preview_sql_check

Parameters:

  • query (str | None)

  • params (dict[str, Any] | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.data.preview_sql_result(query=None, params=None, **kwargs)[source]

Preview Sql Result.

POST /api/v2/data/preview_sql_result

Parameters:

  • query (str | None)

  • params (dict[str, Any] | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any