Component description

The extraRequestData property is used when the API table loads data from an external source. It defines which data source to call and which fields from that source are available for use in the table.

Minimal JSON

{}
{
  "type": "api-table",
  "tableId": "simple_table_most_active_users",
  "api": "https://help.dawiso.com/api/sql-external/table",
  "columns": [
    {
      "type": "externalKey",
      "value": "user_link",
      "title": "user_link",
      "isHtml": true
    },
    {
      "type": "externalKey",
      "value": "viewed_pages",
      "title": "viewed_pages"
    }
  ],
  "extraRequestData": {
    "datasource": "core_statistic_table_most_active_users",
    "columns": [
      {
        "title": "user_link",
        "value": "user_link"
      },
      {
        "title": "viewed_pages",
        "value": "viewed_pages"
      }
    ]
  },
  "defaultSort": {
    "predicate": "viewed_pages",
    "reverse": true
  },
  "hideActions": true
}

Example taken from the core_dashboard_adoption package.

Nested properties

PropertyDescriptionValuesMandatory
dataSourceIdentifies the external source that is queried to provide data for the API table.stringNo
columnsArray of fields that are requested from that data source and then used as the API table’s columns (externalKey column type). Each column has a title (name) and value: { "title": "", "value": "" }arrayNo

Supported data sources

Data sourceDescription
core_statistic_table_most_active_usersReturns a list of most active users.
core_statistics_list_of_relationsReturns a list of relations.
core_statistics_most_visited_applicationsReturns a list of most visited applications.