add_dashboard_item
Add a card to a portal's dashboard. Types (module_type): 2=a chart, 3=a map, 4=a calendar (module_id: its id); 9=a table or report; 10=the sum of a field; 11=the average of a field; 12=the number of records; 13=records added today; 14=records changed today; 15=a link; 16=a page; 17=growth of a table over a period (module_id, date_property_id, change_period); 18=growth between two cards (first_widget_id, second_widget_id); 5=the account's files total; 6=the number of the portal's people. Several charts for a dashboard: create_dashboard_charts.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"app_id": "<app_id>",
"portal_id": "<portal_id>",
"name": "<name>",
"module_type": "<module_type>"
},
"name": "add_dashboard_item"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| icon | No | The icon's FontAwesome class (optional, chosen automatically if not given) | |
| name | Yes | Widget name | |
| app_id | Yes | Project ID (from list_projects) | |
| currency | No | Currency symbol: $, €, ₴ and so on | |
| position | No | Position in the grid (autoincrement if not given) | |
| module_id | No | The table's or report's id (types 9–14, 17) / the chart's (2), map's (3) or calendar's (4) id | |
| portal_id | Yes | Portal ID (from list_portals or describe_project) | |
| block_width | No | Width of the card in the grid (1-12, bootstrap grid) | |
| module_type | Yes | 2=chart, 3=map, 4=calendar, 9=table or report, 10=sum, 11=average, 12=count, 13=added today, 14=changed today, 15=link, 16=page, 17=growth by table, 18=growth between cards, 5=files total, 6=portal's people | |
| property_id | No | ID or name of the number field — for sum (10), average (11). For growth (17): the field that is counted. | |
| block_height | No | Height of the card in px | |
| change_period | No | For growth: 0 = yesterday vs the day before, 1 = this week vs last week, 2 = this month vs last month, 3 = quarter, 4 = year | |
| show_currency | No | Show the currency symbol next to the number | |
| first_widget_id | No | ID of the first dashboard widget for growth_by_widgets (18) — take it from a previous add_dashboard_item | |
| date_property_id | No | ID or name of the date field — for growth_by_table (17), to count the records per period | |
| second_widget_id | No | ID of the second dashboard widget for growth_by_widgets (18) | |
| currency_position | No | 0 = before the number (default), 1 = after the number | |
| show_current_value | No | Show the current value next to the % of growth (default: true) | |
| show_compare_period | No | Show the value for the compared period (default: false) |