Method
getEdaForecastingAnalysis GET
Copy GET

Gets the Forecasting analysis for the Exploratory Data Analysis.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes edaVersion str Unique string identifier associated with the EDA version.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result EdaForecastingAnalysis
KEY TYPE Description
primaryKeys list Name of the primary keys in the data
forecastingTargetFeature str Feature in the data that represents the target.
timestampFeature str Feature in the data that represents the timestamp column.
forecastFrequency str Frequency of data, could be hourly, daily, weekly, monthly, quarterly or yearly.
salesAcrossTime ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across time
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
cummulativeContribution ForecastingAnalysisGraphData Data showing what percent of items contribute to what amount of sales.
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
missingValueDistribution ForecastingAnalysisGraphData Data showing missing or null value distribution
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
historyLength ForecastingAnalysisGraphData Data showing length of history distribution
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
numRowsHistogram ForecastingAnalysisGraphData Data showing number of rows for an item distribution
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
productMaturity ForecastingAnalysisGraphData Data showing length of how long a product has been alive with average, p10, p90 and median
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
seasonalityYear ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across grouped years
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
seasonalityMonth ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across grouped months
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
seasonalityWeekOfYear ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across week of year seasonality
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
seasonalityDayOfYear ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across day of year seasonality
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
seasonalityDayOfMonth ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across day of month seasonality
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
seasonalityDayOfWeek ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across day of week seasonality
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
seasonalityQuarter ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across grouped quarters
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
seasonalityHour ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across grouped hours
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
seasonalityMinute ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across grouped minutes
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
seasonalitySecond ForecastingAnalysisGraphData Data showing average, p10, p90, median sales across grouped seconds
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
autocorrelation ForecastingAnalysisGraphData Data showing the correlation of the forecasting target and its lagged values at different time lags.
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
partialAutocorrelation ForecastingAnalysisGraphData Data showing the correlation of the forecasting target and its lagged values, controlling for the effects of intervening lags.
KEY TYPE Description
data list List of graph data
xAxis str Feature that represents the x axis
yAxis str Feature that represents the y axis
dataColumns list Ordered name of the column for each rowwise data
chartName str Name of the chart represented by the data
chartTypes list Type of charts in that can exist in the current data.
itemStatistics ItemStatistics In item wise charts, gives the mean, median, count, missing_percent, p10, p90, standard_deviation, min, max
KEY TYPE Description
missingPercent float percentage of missing values in data
count int count of data
median float median of the data
mean float mean value of the data
p10 float 10th percentile of the data
p90 float 90th_percentile of the data
stddev float standard deviation of the data
min int min value in the data
max int max value in the data
lowerBound float lower bound threshold of the data
upperBound float upper bound threshold of the data
chartDescriptions EdaChartDescription List of descriptions of what the chart contains
KEY TYPE Description
chartType str Name of chart.
description str Description of the eda chart.
Language:

© Copyright