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
Example Response

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

Fields Description

This description covers only the fields that contain information useful for Portal Page development, the fields that are not covered are for internal use only.

Field Name Value Type Description
business_owner string The name of the Element Business Owner.
business_owner_email string The email of the Element Business Owner.
category_id string The ID of the element's category.
certification_level_color string The hex value of the certification level color.
certification_level_id string The ID of the certification level.
certification_level_name string The name of the certification level.
certified_ind string Whether or not the element is certified. Takes value “Y” if the element is certified, “N” - if not.
content_type string The type of the content.
data_source_name string The name of the data source from which the element is populated.
data_steward string The name of the element's Data Steward.
data_steward_email string The email of the element's Data Steward.
description_markdown_ind string Whether or not markdown is applied to the element's description. Takes value “Y” if markdown is enabled, “N” - if not.
element_dashboard_name string The name of the element.
element_id string The ID of the element.
element_type string The type of the element.
enable_click_in_mobile_ind string If the element is an External Report or External Content, defines whether or not the “Enable click-through” option is activated for its content type.
external_content_type_name string If the element is an External Content, describes its type.
external_report_display string If the element is an External Report, describes its display options.
external_report_download_url_info object Information about element download.
favorite_content string The type of favorite content.
favorite_id string The IDs of the element instances in favorites.
folder_id array An array of folders where the element is present.
global_total_view_count string The engagement count of the element.
has_access string Whether or not the user who ran the API request has access to the element.
has_preview boolean Whether or not preview is enabled for the element.
in_dashboard_ind_flag string Whether or not the element is displayed on the dashboard.
in_favorites string The IDs of favorites where the element is present.
is_empty_instance_ind string Whether or not the last instance of the report is empty.
is_expired string Whether or not the element is expired.
is_in_favorites string Whether or not the element is displayed on the dashboard.
is_in_favorites string Whether or not the element is in favorites. Takes value “1” if the element is in favorites, “0” - if not.
is_in_folders string Whether or not the element is in any folder. Takes value “1” if the element is in any folder, “0” - if not.
is_owned string Whether or not the element has an owner. Takes value “1” if the element has an owner, “0” - if not.
is_tech_editor string Whether or not the user who ran the API request can edit the element. Takes value “1” if the user who ran the API request can edit the element, “0” - if not.
last_activity_time string The date and time of the last element activity.
last_alert_event_activity_time string The date and time of the last alert activity.
last_alert_news_type string The type of the last alert. Can take one of the three value: “good”, “bad”, and “neutral”.
last_alert_text string The text of the last alert.
last_alert_text_news_type string The news type of the last alert.
last_annotation_text string The text of the last annotation.
last_certified_by_email string The email of the user who certified the element.
last_certified_by_name string The name of the user who certified the element.
last_certified_time string The date and time of the last certification of the element.
last_commentary_text string The text of the last comment.
last_updated_time string The date and time of the last element update.
metric_last_moving_average_value_formatted string The last collected value of a metric.
metric_tile_display_pct_variance string The percentage ratio between the two latest metric values.
refresh_frequency_sec string The frequency of element refresh in seconds.
reporting_tool_name string If the element is an External Report, displays the name of the BI tool from which the element is populated.
segment_value_id string The dimension value of the element.
technical_owner string The element's Technical Owner.
technical_owner_email string The email of the element's Technical Owner.
topics array An array of the element's tags' IDs.
total_view_count string The engagement count of the element.
user_dashboard_element_instance_id string A unique ID of the element record.
user_id string The ID of the user who ran the API request.