Dashboards Module API

API reference for dashboard endpoints.

BriteCore v2 Dashboards API endpoint wrappers.

This module provides wrappers for dashboard metrics, report URLs, transaction reports, and loss-run validation in the BriteCore v2 dashboards API.

britecore_sdk.api.api_calls.v2.dashboards.get_agency_experience_data(contact_id=None, to_date=None, **kwargs)[source]

Retrieve agency experience dashboard data.

POST /api/v2/dashboards/get_agency_experience_data

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.dashboards.get_csr_data(contact_id=None, **kwargs)[source]

Retrieve CSR dashboard data.

POST /api/v2/dashboards/get_csr_data

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.dashboards.get_loss_ratio_chart(contact_id=None, to_date=None, **kwargs)[source]

Retrieve loss ratio chart data.

POST /api/v2/dashboards/get_loss_ratio_chart

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.dashboards.get_policy_count_data(contact_id=None, to_date=None, **kwargs)[source]

Retrieve policy count dashboard data.

POST /api/v2/dashboards/get_policy_count_data

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.dashboards.get_premium_data(contact_id=None, to_date=None, **kwargs)[source]

Retrieve premium dashboard data.

POST /api/v2/dashboards/get_premium_data

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.dashboards.get_report_url(contact_id=None, from_date=None, payment_types=None, to_date=None, **kwargs)[source]

Retrieve a dashboard report URL.

POST /api/v2/dashboards/get_report_url

Parameters:

  • contact_id (str | None)

  • from_date (str | None)

  • payment_types (str | None)

  • to_date (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.dashboards.get_transaction_report(contact_id=None, from_date=None, page=None, payment_types=None, records_per_page=None, sort_obj=None, to_date=None, **kwargs)[source]

Retrieve a paginated dashboard transaction report.

POST /api/v2/dashboards/get_transaction_report

Parameters:

  • contact_id (str | None)

  • from_date (str | None)

  • page (int | None)

  • payment_types (str | None)

  • records_per_page (str | None)

  • sort_obj (str | None)

  • to_date (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.dashboards.validate_loss_run(contact_id=None, policy_number=None, **kwargs)[source]

Validate whether a loss run is available for a policy or contact.

POST /api/v2/dashboards/validate_loss_run

Parameters:

  • contact_id (str | None)

  • policy_number (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any