Catalog: Dashboard Element Endpoint
The call to the /home/index/refresh/ajax/Y
API endpoint returns information about all the elements within the Catalog. The response can be parsed to populate objects with information specific to one or more element IDs.
API Call
let dashboardElements;
$.ajax({
url: '/home/index/refresh/ajax/Y',
type: 'GET',
success: (res) => {
dashboardElements = new DashboardStorage(res.data).rows;
console.log(dashboardElements)
},
});
Click to copy
This example demonstrates an object which represents a single element.
{
alert_event_id: null
business_owner: "Robert"
business_owner_email: "[email protected]"
category_id: "1216"
certification_level_color: null
certification_level_id: null
certification_level_name: null
certified_ind: "N"
content_type: "Microsoft PowerBI"
data_source_name: "Microsoft Power BI Cloud - MS Microsoft Power BI Cloud Data Source For Documentation"
data_steward: null
data_steward_email: null
description_markdown_ind: "N"
display_order: "1000000"
element_dashboard_name: "Ext.report(test main)"
element_id: "147447"
element_info: "Ext.report(test main)"
element_type: "external report"
enable_click_in_mobile_ind: "Y"
external_content_type_name: null
external_report_display: "iframe"
external_report_download_url_info: Object { label: "Down", url: "" }
label: "Down"
url: ""
favorite_content: null
favorite_id: "0"
folder_id: Array []
length: 0
global_total_view_count: "1"
has_access: "Y"
has_preview: true
in_dashboard_ind_flag: "Y"
in_favorites: null
is_alert_active: "0"
is_annotation_active: "0"
is_collaborative_alert_active: "0"
is_collaborative_annotation_active: "0"
is_commentary_active: "0"
is_empty_instance_ind: "N"
is_expired: "0"
is_in_favorites: "0"
is_in_folders: "0"
is_owned: "0"
is_tech_editor: "N"
last_activity_time: null
last_alert_event_activity_time: null
last_alert_news_type: null
last_alert_text: null
last_alert_text_news_type: ""
last_annotation_text: ""
last_certified_by_email: null
last_certified_by_name: null
last_certified_time: null
last_commentary_text: ""
last_display_generation_time: ""
last_file_updated_time: ""
last_measurement_time: null
last_measurement_time_formatted: null
last_measurement_value_formatted: null
last_modified: "unknown"
last_notable_event_activity_time: null
last_stoplight_value: "0"
last_updated_time: "2023-03-24 08:55:52"
last_user_annotation_activity_time: null
last_user_note_activity_time: null
metric_display_on_tile: "value"
metric_display_on_tile_prefix: null
metric_home_page_compare_line_id: null
metric_home_page_compare_target_id: null
metric_home_page_compare_value_type: "last value"
metric_last_moving_average_value_formatted: null
metric_moving_average_interval: null
metric_tile_display_pct_variance: null
metric_unit_of_measure: null
mi_name: "Daily"
mi_sequence: "30"
no_access: "N"
parent_segment_value_id: null
pct_variance_text: "from last day"
refresh_frequency_sec: "86400"
refresh_frequency_text: "Daily"
remove_preview_link_ind: "N"
report_multiple_units_label: null
report_no_units_label: null
report_on_demand_generation_ind: "Y"
report_rows: null
report_single_unit_label: null
reporting_tool_name: "Microsoft PowerBI"
section_type: "Category"
segment_value_id: "0"
supports_last_refreshed_check: "none"
technical_owner: "Robert"
technical_owner_email: "[email protected]"
topics: Array []
length: 0
total_forecast_amount_formatted: null
total_ind: "N"
total_view_count: 0
user_dashboard_element_instance_id: "3068501"
user_id: "634"
}
Click to copy