GraphSettings
Manages the charts and analytics defined inside an app so administrators can review or update how data is visualized for users.
Select
The AppId column is required in the WHERE clause. The provider will use the Kintone APIs to filter the results by this column. By default, the provider will process other filters client-side within the provider.
For example, the following queries are processed server side:
SELECT * FROM GraphSettings WHERE AppId = 6 SELECT * FROM GraphSettings WHERE AppId = 6 AND Lang = 'en' SELECT * FROM GraphSettings WHERE AppId = 6 AND IsPreview = false
Update
For updating the GraphSettings, provide the Reports as an aggregate. The AppId column is required to update the GraphSettings.
UPDATE GraphSettings SET Reports = '{"Graph1":{"chartType":"BAR","chartMode":"PERCENTAGE","name":"Updated_Graph_Name","index":"0","groups":[{"code":"Created_by"}]}}' WHERE AppId = 6
Columns
| Name | Type | ReadOnly | References | Description |
| AppId | Integer | False |
Identifier of the Kintone app whose graph and reporting settings are being retrieved or updated. | |
| Id [KEY] | String | True |
Unique identifier of the graph configuration within the app. | |
| Index | String | False |
Zero-based position of the graph in the app's graph list, determining the order in which graphs appear to users. | |
| Name | String | False |
Display name of the graph, limited to 64 characters, and returned in the requested language when a lang parameter is provided. | |
| PeriodicReport | String | False |
Object containing the graph's periodic report settings, returned as 'null' when no periodic report has ever been configured. | |
| Sorts | String | False |
Array of objects defining the Sort by settings that determine how graph data is ordered. | |
| Aggregations | String | False |
Function settings used to aggregate field values, such as totals or counts, when generating the graph. | |
| ChartMode | String | False |
Display mode applied to the graph, determining how the chart is rendered in the interface. | |
| ChartType | String | False |
Chart type selected for the graph, such as bar, line, pie, or other supported visualization formats. | |
| FilterCond | String | False |
Record filter condition expressed in query-string format, reflecting the graph's Filter settings. | |
| Groups | String | False |
Function settings used for grouping records in the graph, defining how data is categorized during aggregation. | |
| Revision | String | True |
Revision number of the app settings, helping track updates made to graph configurations. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Lang | String |
Locale code used to retrieve graph-setting values in a specific language. |
| IsPreview | Boolean |
Indicates whether to retrieve graph-setting details from the preview environment ('true') or from the live environment ('false'). The default value is 'true'. |
| Reports | String |
Value used only when performing an update to supply modified graph-report settings. |