|
cards\_info
|
List of contact cards associated with the specified customer.Data type: Array \(content depends on selected customer\)
|
|
cards\_info.data\_configurations
|
Configuration information.Data type: Object
```
"data_configurations": {
"aggregate_field": "String",
"aggregate_function": "String",
"chart_settings": "String"
"decimal_precision": Number,
"filter_query": "String",
"group_by": "String",
"number_of_groups": "String",
"show_other": Boolean,
"source_id": "String",
"source_type": "String",
"stack_by_field": "String",
"sys_id": "String",
"trend_field": "String",
"trend_interval": "String",
"type": "String"
}
```
|
|
cards\_info.data\_configurations.aggregate\_field
|
Column name to aggregate. Data type: String
|
|
cards\_info.data\_configurations.aggregate\_function
|
Function to use to aggregate the specified table column.Possible values:
- AVG
- COUNT
- COUNT\(DISTINCT\)
- SUM
Data type: String
|
|
cards\_info.data\_configurations.decimal\_precision
|
Number of digits to the right of the decimal point to return.Data type: Number
|
|
cards\_info.data\_configurations.filter\_query
|
Query string to use to refine the data used in the report.Data type: String
|
|
cards\_info.data\_configurations.group\_by
|
Name of the column to use to group the report data.Data type: String
|
|
cards\_info.data\_configurations.number\_of\_groups
|
Maximum number of groups to display in the report.Possible values:
- `all`: Show all groups.
- 0: Uses the value in the **glide.ui.chart.generate\_other** system property.
**Note:** It is not recommended to change the value of the **glide.ui.chart.generate\_other** system property, as it applies to all reports in the instance.
- Greater than 0: Number of groups to display. The groups that appear are the ones with the highest values for whatever is being tracked.
Data type: String
|
|
cards\_info.data\_configurations.show\_other
|
Flag that indicates whether the group "Other" appears within the report. If not all groups are to display, as defined by the **number\_of\_groups** parameter, the values of the non-display groups are combined and displayed under a single heading of "Other".Possible values:
- true: Include the "Other" group.
- false: Don't include the "Other" group.
Data type: Boolean
|
|
cards\_info.data\_configurations.source\_id
|
Table name or sys\_id of the report source information. This correlates to the information in the **cards\_info.reportGroupConfigurations.data\_configurations.source\_type** parameter.Data type: String
|
|
cards\_info.data\_configurations.source\_type
|
Type of information in the **cards\_info.reportGroupConfigurations.data\_configurations.source\_id** parameter used to identify the source table.Possible values:
- source: Sys\_id of the source table.
- table: Table name of the source table.
Data type: String
|
|
cards\_info.data\_configurations.stack\_by\_field
|
Name of the table column to use when implementing "stack by" in the report.Data type: String
|
|
cards\_info.data\_configurations.sys\_id
|
Sys\_id of the report used in the report configuration.Data type: String
|
|
cards\_info.data\_configurations.trend\_field
|
Name of table column to use in trend analysis.Data type: String
|
|
cards\_info.data\_configurations.trend\_interval
|
Time interval for the trend information. For example, week, month, year, etc.Data type: String
|
|
cards\_info.data\_configurations.type
|
Type of report, such as single score, donut, vertical, line, stacked bar, etc.Data type: String
|
|
cards\_info.encodedQuery
|
Encoded query string to use to refine the data that appears in the report.Data type: String
|
|
cards\_info.fields
|
List of name-value pairs that define the fields within the associated record.Data type: Array of Objects
```
"fields": [
{
"label": "String",
"value": "String"
}
]
```
|
|
cards\_info.fields.label
|
Field label.Data type: String
|
|
cards\_info.fields.value
|
Field value.Data type: String
|
|
cards\_info.listLimit
|
Pagination limit. Number of records to show on a list card.Data type: String
|
|
cards\_info.reportGroupConfigurations
|
List of objects that define the report groups.Data type: Array of Objects
```
"reportGroupConfigurations": [
{
"data_configurations": {Object},
"style_configurations": {Object},
"title": "String",
"type": "String"
}
]
```
|
|
cards\_info.reportGroupConfigurations.data\_configurations
|
Configuration information.Data type: Object
```
"data_configurations": {
"aggregate_field": "String",
"aggregate_function": "String",
"chart_settings": "String"
"decimal_precision": Number,
"filter_query": "String",
"group_by": "String",
"number_of_groups": "String",
"show_other": Boolean,
"source_id": "String",
"source_type": "String",
"stack_by_field": "String",
"sys_id": "String",
"trend_field": "String",
"trend_interval": "String",
"type": "String"
}
```
|
|
cards\_info.reportGroupConfigurations.data\_configurations.aggregate\_field
|
Column name to aggregate. Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.aggregate\_function
|
Function to use to aggregate the specified table column.Possible values:
- AVG
- COUNT
- COUNT\(DISTINCT\)
- SUM
Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.decimal\_precision
|
Number of digits to the right of the decimal point to return.Data type: Number
|
|
cards\_info.reportGroupConfigurations.data\_configurations.filter\_query
|
Query string to use to refine the data used in the report.Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.group\_by
|
Name of the column to use to group the report data.Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.number\_of\_groups
|
Maximum number of groups to display in the report.Possible values:
- `all`: Show all groups.
- 0: Uses the value in the **glide.ui.chart.generate\_other** system property.
**Note:** It is not recommended to change the value of the **glide.ui.chart.generate\_other** system property, as it applies to all reports in the instance.
- Greater than 0: Number of groups to display. The groups that appear are the ones with the highest values for whatever is being tracked.
Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.show\_other
|
Flag that indicates whether the group "Other" appears within the report. If not all groups are to display, as defined by the **number\_of\_groups** parameter, the values of the non-display groups are combined and displayed under a single heading of "Other".Possible values:
- true: Include the "Other" group.
- false: Don't include the "Other" group.
Data type: Boolean
|
|
cards\_info.reportGroupConfigurations.data\_configurations.source\_id
|
Table name or sys\_id of the report source information. This correlates to the information in the **cards\_info.reportGroupConfigurations.data\_configurations.source\_type** parameter.Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.source\_type
|
Type of information in the **cards\_info.reportGroupConfigurations.data\_configurations.source\_id** parameter used to identify the source table.Possible values:
- source: Sys\_id of the source table.
- table: Table name of the source table.
Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.stack\_by\_field
|
Name of the table column to use when implementing "stack by" in the report.Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.sys\_id
|
Sys\_id of the report used in the report configuration.Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.trend\_field
|
Name of table column to use in trend analysis.Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.trend\_interval
|
Time interval for the trend information. For example, week, month, year, etc.Data type: String
|
|
cards\_info.reportGroupConfigurations.data\_configurations.type
|
Type of report associated with the report group, such as donut or single\_core.Data type: String
|
|
cards\_info.reportGroupConfigurations.style\_configurations
|
Styles to use within the associated report group.Data type: Object
```
"style_configurations": {
"colorPalette": "String",
"scoreColor": "String",
"show_zero": Boolean
}
```
|
|
cards\_info.reportGroupConfigurations.style\_configurations.colorPalette
|
Colors used in the report.Data type: String
|
|
cards\_info.reportGroupConfigurations.style\_configurations.scoreColor
|
Color of the score value within the report.Data type: String
|
|
cards\_info.reportGroupConfigurations.style\_configurations.show\_zero
|
Flag that indicates whether data points equal to zero are shown in the report.Possible values:
- true: Zero values are shown.
- false: Zero values aren't shown.
Data type: Boolean
|
|
cards\_info.reportGroupConfigurations.title
|
Title of the report group.Data type: String
|
|
cards\_info.reportGroupConfigurations.type
|
File type for which the information is being returned.Always sn\_customercentral\_report\_config.
Data type: String
|
|
cards\_info.sourceTableName
|
Name of the table used for the associated list card.Data type: String
|
|
cards\_info.style\_configurations
|
Styles to use within the associated report.Data type: Object
```
"style_configurations": {
"colorPalette": "String",
"dataLabelConfig": {Object},
"height": "String",
"hideRegister": Boolean,
"registerConfig": {Object},
"registerPosition": "String",
"scoreColor": "String",
"showDataLabels": Boolean,
"showTooltip": Boolean,
"show_zero": Boolean,
"width": "String"
}
```
|
|
cards\_info.style\_configurations.colorPalette
|
Colors used in the report.Data type: String
|
|
cards\_info.style\_configurations.dataLabelConfig
|
Configuration parameters that control how data labels appear in the report.Data type: Object
```
"dataLabelConfig": [
{
"showTotal": Boolean
}
]
```
|
|
cards\_info.style\_configurations.dataLabelConfig.showTotal
|
Flag that indicates whether to display the total in the report.Possible values:
- true: Show totals.
- false: Don't show totals.
Data type: Boolean
|
|
cards\_info.style\_configurations.height
|
Height of the associated report.Data type: String
Unit: Pixels or "auto"
|
|
cards\_info.style\_configurations.hideRegister
|
Flag that indicates whether to display the register in the card.Possible values:
- true: Show the register.
- false: Don't show the register.
Data type: Boolean
|
|
cards\_info.style\_configurations.registerConfig
|
Configuration values that control how the register appears in the report.Data type: Object
```
"registerConfig": {
"hideBorder": Boolean,
"showPercentages": Boolean
}
```
|
|
cards\_info.style\_configurations.registerConfig.hideBorder
|
Flag that indicates whether to hide the border around the register.Possible values:
- true: Hide the register border.
- false: Show the register border.
Data type: Boolean
|
|
cards\_info.style\_configurations.registerConfig.showPercentages
|
Flag that indicates whether to show register percentages.Possible values:
- true: Show register percentages.
- false: Hide register percentages.
Data type: Boolean
|
|
cards\_info.style\_configurations.registerPosition
|
Position of the register within a card.Data type: String
|
|
cards\_info.style\_configurations.scoreColor
|
Color of the score value within the report.Data type: String
|
|
cards\_info.style\_configurations.showDataLabels
|
Flag that indicates whether to show the data labels within the report.Possible values:
- true: Show the data labels.
- false: Hide the data labels.
Data type: Boolean
|
|
cards\_info.style\_configurations.showTooltip
|
Flag that indicates whether to show tool tips within the report.Possible values:
- true: Show tool tips.
- false: Hide tool tips.
Data type: Boolean
|
|
cards\_info.style\_configurations.show\_zero
|
Flag that indicates whether data points equal to zero are shown in the report.Possible values:
- true: Zero values are shown.
- false: Zero values aren't shown.
Data type: Boolean
|
|
cards\_info.style\_configurations.width
|
Width of the associated report.Data type: String
Unit: Pixels or "auto"
|
|
cards\_info.subheader\_fields
|
Details to show on the sub-header of the associated card.Data type: Object
```
"subheader_fields": {
"avatar": "String",
"subheader_tags": [Array],
"sys_id": "String",
"title": "String"
}
```
|
|
cards\_info.subheader\_fields.avatar
|
File name of the avatar associated with the specified**context\_instance**, such as the contact's avatar.\[Omitted image "cust-central\_avatar.png"\] Alt text: Avatar placement
Data type: String
|
|
cards\_info.subheader\_fields.subheader\_tags
|
List of tags associated with the record sub-header, such as escalation tags.\[Omitted image "cust-central\_sub-header\_tags.png"\] Alt text: Sub-header tag placement
Data type: Array \(content varies\)
|
|
cards\_info.subheader\_fields.sys\_id
|
Sys\_id of the associated customer.Data type: String
Table: Users \[sys\_user\]
|
|
cards\_info.subheader\_fields.title
|
Title to display on the sub-header.\[Omitted image "cust-central\_sub-header-title.png"\] Alt text: Sub-header title placement
Data type: String
|
|
cards\_info.title
|
Title on the card \(record\).Data type: String
|
|
cards\_info.type
|
File type for which the information is being returned.Possible values:
- sn\_customercentral\_list\_config: List Configuration
- sn\_customercentral\_record\_config: Record Configuration
- sn\_customercentral\_report\_config: Report Configuration
- sn\_customercentral\_report\_group\_config: Report Group Configuration
Data type: String
|
|
cards\_info.viewName
|
Name of the view configured for the table specified in **cards\_info.sourceTableName**.Data type: String
|
|
has\_more\_records
|
Flag that indicates whether there are more records to retrieve.Possible values:
- true: More records to retrieve.
- false: No more records.
Data type: Boolean
|
|
layout
|
Number of columns per row. Each comma separated value defines the width of a column on the report display. For example "6,6" denotes two columns, each being six units wide, for a total of 12 units per row \(maximum\). A value of "3,6,3" denotes a row with three columns.Data type: String
|
|
status
|
HTTP status of the request.Data type: String
|