module `data_insight_mixin`

Mixin class containing data specific methods To be used by OpenMetadata class

class `DataInsightMixin`

data insight mixin used to write results

method `add_data_insight_report_data`

add_data_insight_report_data(record: 'ReportData') → ReportData

Given a ReportData object convert it to a json payload and send a POST request to the report data endpoint Args:

record (ReportData): report data

method `add_kpi_result`

add_kpi_result(fqn: 'str', record: 'KpiResult') → KpiResult

Given a ReportData object convert it to a json payload and send a POST request to the report data endpoint Args:

record (ReportData): report data

method `add_web_analytic_events`

add_web_analytic_events(
    event_data: 'WebAnalyticEventData'
) → List[WebAnalyticEventData]

Get web analytic event

method `create_kpi`

create_kpi(create: 'CreateKpiRequest') → Kpi

method `delete_report_data`

delete_report_data(report_data_type: 'ReportDataType') → None

Delete report data for a specific report data type Args:

report_data_type (ReportDataType): report date type to delete

method `delete_report_data_at_date`

delete_report_data_at_date(
    report_data_type: 'ReportDataType',
    date: 'str'
) → None

Delete report data at a specific date for a specific report data type Args:

report_data_type (ReportDataType): report date type to delete
date (str): date for which to delete the report data

method `delete_web_analytic_event_before_ts_exclusive`

delete_web_analytic_event_before_ts_exclusive(
    event_type: 'WebAnalyticEventType',
    tmsp: 'int'
)

Deletes web analytics events before a timestamp Args:

event_type (WebAnalyticEventData): web analytic event type
tmsp (int): timestamp

method `get_aggregated_data_insight_results`

get_aggregated_data_insight_results(
    start_ts: 'int',
    end_ts: 'int',
    data_insight_chart_name: 'str',
    data_report_index: 'str',
    params: 'Optional[dict]' = None
) → DataInsightChartResult

summary Args:

start_ts (int): description
end_ts (int): description
data_insight_chart_name (str): description
data_report_index (str): description
params (Optional[dict], optional): description. Defaults to None.

Returns:

DataInsightChartResult: description

method `get_data_insight_report_data`

get_data_insight_report_data(
    start_ts: 'int',
    end_ts: 'int',
    report_data_type: 'str'
) → dict[str, list[ReportData]]

Return dict with a list of report data given a start and end date Args:

start_ts (type): start_timestamp
end_ts (type): end timestampe
report_data_type (ReportDataType): report data type

Returns: List[ReportData]:

method `get_kpi_result`

get_kpi_result(fqn: 'str', start_ts, end_ts) → list[KpiResult]

Given FQN return KPI results Args:

fqn (str): fullyQualifiedName

method `get_web_analytic_events`

get_web_analytic_events(
    event_type: 'WebAnalyticEventType',
    start_ts: 'int',
    end_ts: 'int'
) → List[WebAnalyticEventData]

Get web analytic event

API Reference

Data Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Main Concepts

Data Insight Mixin

module `data_insight_mixin`

class `DataInsightMixin`

method `add_data_insight_report_data`

method `add_kpi_result`

method `add_web_analytic_events`

method `create_kpi`

method `delete_report_data`

method `delete_report_data_at_date`

method `delete_web_analytic_event_before_ts_exclusive`

method `get_aggregated_data_insight_results`

method `get_data_insight_report_data`

method `get_kpi_result`

method `get_web_analytic_events`

​module data_insight_mixin

​class DataInsightMixin

​method add_data_insight_report_data

​method add_kpi_result

​method add_web_analytic_events

​method create_kpi

​method delete_report_data

​method delete_report_data_at_date

​method delete_web_analytic_event_before_ts_exclusive

​method get_aggregated_data_insight_results

​method get_data_insight_report_data

​method get_kpi_result

​method get_web_analytic_events

module `data_insight_mixin`

class `DataInsightMixin`

method `add_data_insight_report_data`

method `add_kpi_result`

method `add_web_analytic_events`

method `create_kpi`

method `delete_report_data`

method `delete_report_data_at_date`

method `delete_web_analytic_event_before_ts_exclusive`

method `get_aggregated_data_insight_results`

method `get_data_insight_report_data`

method `get_kpi_result`

method `get_web_analytic_events`