Chart Data Sets

post

https://app.financekey.com/OData/ChartDataSets

The ChartDataSet table is a part of the Dashboard package which is used to provide an overview of any given dataset on a graphical chart. This table includes various elements such as the axis labels, data points, chart type, scaling and color settings, as well as other properties used to customize the visualization of the data. ChartDataSet allows the user to quickly and easily understand the summarized data points and any trends that may be present.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

chartId

int32

ChartId is an integer field in the ChartDataSet table, which uniquely identifies each row in the dataset.

name

string | null

The Name of data type nvarchar with a maximum length of 128 in the ChartDataSet table is a string field that stores up to 128 characters of data, such as names or phrases. It is stored in the nvarchar format which supports the use of Unicode characters.

description

string | null

The Description field in the ChartDataSet table is an nvarchar data type with a maximum length of 512 characters. It holds descriptive text about the ChartDataSet.

viewId

int32

The ViewId field in the ChartDataSet table contains a unique identifier for each data set that is used when generating a chart or graph. The data type is an integer.

xColumnId

int32 | null

The XColumnId field in the ChartDataSet table is a unique integer identifier that stores the x coordinates of each point in a graph or chart.

yColumnId

int32 | null

YColumnId is a field of data type int in the ChartDataSet table. It stores an identifier for every Y column in a chart dataset, uniquely identifying each related and corresponding X column. The YColumnId field is used to link chart data from the same dataset.

groupColumnId

int32 | null

The GroupColumnId field in the ChartDataSet table is an integer data type used to uniquely identify individual groups that correspond to a chart in the database. This value will be used to join the table with other related tables and records that contain related chart data for efficient data retrieval.

showTotal

boolean

ShowTotal is a field of data type bit in the ChartDataSet table. It is a boolean field indicating whether or not to display the sum of all data points in a chart alongside the individual bar/columns. ShowTotal has a value of 1 when the sum line is to be displayed, and 0 when it is not.

aggregateOperatorId

string | null

The AggregateOperatorId field in the ChartDataSet table stores an nvarchar (up to 32 characters) value that identifies an aggregation operator used to create the associated data set.

sequence

int32

The Sequence field of type int in the ChartDataSet table holds a numerical sequence value that indicates the order of the data set. It should be used in conjunction with the other fields in the table to identify its location in the data set.

xFormat

string | null

XFormat is a field in the ChartDataSet table that stores textual data of varying length as a data type of nvarchar. It is used to describe different types of formatting associated with a chart, including the layout of the legend, plot, axes, grid lines, etc.

yFormat

string | null

The YFormat field in the ChartDataSet table stores the format specification for the y-axis on a chart or graph. It is an nvarchar datatype and should include appropriate formatting syntax to reproduce the desired chart or graph.

urlColumnId

int32 | null

UrlColumnId is an integer data type field that is used in the ChartDataSet table to identify the URL associated with each chart data set. This allows for easily identifying and referencing the chart associated with each data set.

dashboardFilterId

int32 | null

The DashboardFilterId field in the ChartDataSet table contains a unique integer that allows the user to filter the chart data set for a specific dashboard filter.

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!