Loading...

TABLE PROFILE TYPES

TABLE PROFILES BASED ON MAGENTO API ENDPOINTS

With the help of this functionality, any data that is accessible via the Magento REST APIs may be sent to Power BI.

Upon successful establishment of the API connection between Power BI and user's Magento instance, the user will have access to API endpoints for creating relevant Table Profiles and extracting data to Power BI.

Creation of Tables Profiles based on Magento API endpoints

To navigate to the "Power BI Table Profiles" page, click on "Reports" and see Insights Ready section in there. After settling on the Power BI Table Profiles page and clicking "Add New Table Profile", users are allowed to choose the profile's type, where the user can pick the API type from the dropdown.

Graphical user interface, table Description automatically
generated
Picture: Graphical user interface, table Description automatically generated

The next step requires the user to fill 2 mandatory fields:

  • Profile name

  • API Path (the user has the option to select an endpoint that corresponds to their specific objectives.)

Filling the Profile Name and API Path mandatory
fields
Picture: Filling the Profile Name and API Path mandatory fields

The next required action is clicking the "Read API Response Format" button which will allow the user to receive a list of columns (API Response Fields) from the requested endpoint. In order to create a table and display the corresponding values in Power BI, the user needs to choose the relevant columns from the list provided, which will help construct the table profile.

Selection of the needed API Response
Fields
Picture: Selection of the needed API Response Fields

Further, user can navigate to the "Configure selected fields" button and the system will recognize the data in the table. Interface will display columns' names and two settings for them PBI Column Name and Data Type:

Adjusting the columns' Data
Types
Picture: Adjusting the columns' Data Types

Moreover, users can notice the Parameters section, which contains several fields: Incremental Field, Search Criteria Field Name and Incremental Mode.

  • Incremental Field: Incremental Field can be used to help the user choose the field with increasing values, so that Power BI can easily recognize it. It serves as a unique identifier for each record or row, and whose value increases incrementally with each new record added.
  • Search Criteria Field: The utilization of Search Criteria enables the retrieval of a list response of an entity based on specific conditions, which are expected to align with the selected Incremental Field. The Search Criteria are subsequently passed on for filtering and sorting purposes, specifically by utilizing the Incremental Field as a reference point.
  • Incremental Mode: It contains 2 variants - New Data Only and Full Data Refresh. Selecting 'New Data Only' will transmit solely the new records to the BI application, while 'Full Data Refresh' will send the entirety of the API data. This option is available when an incremental field is selected.

Selecting of the column to determine it as the Incremental
Field
Picture: Selecting of the column to determine it as the Incremental Field

Filling the Search Criteria field name, selecting the Incremental
Mode
Picture: Filling the Search Criteria field name, selecting the Incremental Mode

After ensuring that all the fields are set correctly, the user should click the Save Profile button on the top of the page.

Saving of the Table
Profile
Picture: Saving of the Table Profile

\newpage