Plug-in Functions#

This is detailed information on each of the functions available in the plug-in.

Note

For functions that use a ticker symbol, the recommendation is to use the format: “<ticker> <country/region code> EQUITY” for the Symbol parameter value. Use the Get Universe function to retrieve the list of recommended symbol values.

Examples:

  • Walmart: WMT US EQUITY

  • Cineworld: CINE LN EQUITY

Functions#


Get Panels#

This function retrieves all the panels available.

Parameters

  • None

Fields Returned

  • PanelName

  • ProviderName

Get Panel Dimensions#

This function retrieves all the values for the selected dimensions from the selected panel.

Parameters

  • PanelName [Required] Select the desired panel name. Use function ‘Get Panels’ to get list of available panels.

  • Dimensions [Required] Input the desired dimension. Options are ‘Age Group’, ‘Region’, ‘Brand’.

Fields Returned

  • Merchant (dependent on Dimensions value)

  • Generation (dependent on Dimensions value)

  • Region (dependent on Dimensions value)

Get Panel Daily#

This function retrieves data for the selected ticker from the selected panel, and aggregates to the daily level.

Parameters

  • PanelName [Required] Select the desired panel name. Use function ‘Get Panels’ to get list of available panels.

  • Symbol [Optional] Select the desired ticker symbol. Use function ‘Get Universe’ to get list of available symbols. Required if brand is not specified.

  • Brand [Optional] Input the desired brand name(s). Required if symbol is not specified.

  • PoPGrowth [Optional] Input ‘Yes’ to return period over period growth values. If none, PoPGrowth defaults to ‘No’.

  • PoPLookback [Optional] Input the number of years to look back for period over period calculations. If none, PoPLookback defaults to 1. One year is defined as 364 days, this will provide comparisons of the same weekday.

  • Dimensions [Required] Input the desired dimension. Options are ‘Age Group’, ‘Region’, ‘Brand’.

Fields Returned

  • Date

  • Age Group (dependent on panel selected and Dimension value)

  • Brand (dependent on panel selected and Dimension value)

  • Region (dependent on panel selected and Dimension value)

  • Spend (dependent on panel selected)

  • Transaction Count (dependent on panel selected)

  • Cardholder Count (dependent on panel selected)

  • Spend per Transaction (dependent on panel selected)

  • Transactions per Card (dependent on panel selected)

  • Spend per Card (dependent on panel selected)

Get Panel Moving Average#

This function retrieves data for the selected ticker from the selected panel, aggregates to the daily level and applies a moving average.

Parameters

  • PanelName [Required] Select the desired panel name. Use function ‘Get Panels’ to get list of available panels.

  • Symbol [Optional] Select the desired ticker symbol. Use function ‘Get Universe’ to get list of available symbols. Required if brand is not specified.

  • Brand [Optional] Input the desired brand name(s). Required if symbol is not specified.

  • RollingPeriods [Required] Input the size of window for the moving average calculation. RollingPeriods are grouped by day.

  • PoPGrowth [Optional] Input ‘Yes’ to return year-over-year growth. If none, PoPGrowth defaults to ‘No’.

  • PoPLookBack [Optional] Input the number of years for the year-over-year growth calculation. If none, PoPLookback defaults to 1.

  • Dimensions [Optional] Input the desired additional dimensions. Options are ‘Age Group’, ‘Region’, ‘Brand’. If none, Dimensions defaults to none.

Fields Returned

  • Date

  • Age Group (dependent on panel selected and Dimension value)

  • Brand (dependent on panel selected and Dimension value)

  • Region (dependent on panel selected and Dimension value)

  • Spend (average, dependent on panel selected)

  • Transaction Count (average, dependent on panel selected)

  • Cardholder Count (average, dependent on panel selected)

  • Spend per Transaction (average, dependent on panel selected)

  • Transactions per Card (average, dependent on panel selected)

  • Spend per Card (average, dependent on panel selected)

Get Panel Weekly#

This function retrieves data for the selected ticker from the selected panel, and aggregates to the weekly level.

Parameters

  • PanelName [Required] Select the desired panel name. Use function ‘Get Panels’ to get list of available panels.

  • Symbol [Optional] Select the desired ticker symbol. Use function ‘Get Universe’ to get list of available symbols. Required if brand is not specified.

  • Brand [Optional] Input the desired brand name(s). Required if symbol is not specified.

  • PeriodToDate [Optional] Input ‘Yes’ to include period to date values. If none, PeriodToDate defaults to ‘No’.

  • WeekType [Optional] Input the day of week for the week end. Options are ‘Sun’,’Mon’,’Tue’,’Wed’,’Thur’,’Fri’,’Sat’. If none, WeekType defaults to ‘Sat’.

  • PoPGrowth [Optional] Input ‘Yes’ to return year-over-year growth. If none, PoPGrowth defaults to ‘No’.

  • PoPLookback [Optional] Input the number of years for the year-over-year growth calculation. If none, PoPLookback defaults to 1.

  • Dimensions [Optional] Input the desired additional dimensions. Options are ‘Age Group’, ‘Region’, ‘Brand’. If none, Dimensions defaults to none.

Fields Returned

  • PeriodLabel

  • PeriodStartDate

  • PeriodEndDate

  • IsCurrentPeriod

  • Age Group (dependent on panel selected and Dimension value)

  • Brand (dependent on panel selected and Dimension value)

  • Region (dependent on panel selected and Dimension value)

  • Spend (dependent on panel selected)

  • Transaction Count (dependent on panel selected)

  • Cardholder Count (dependent on panel selected)

  • Spend per Transaction (dependent on panel selected)

  • Transactions per Card (dependent on panel selected)

  • Spend per Card (dependent on panel selected)

  • PeriodEndDate_PeriodToDate (dependent on PeriodToDate flag = Yes)

  • Spend_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Transaction Count_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Cardholder Count_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Spend per Transaction_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Transactions per Card_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Spend per Card_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

Get Panel Monthly#

This function retrieves data for the selected ticker from the selected panel, and aggregates to the monthly level.

Parameters

  • PanelName [Required] Select the desired panel name. Use function ‘Get Panels’ to get list of available panels.

  • Symbol [Optional] Select the desired ticker symbol. Use function ‘Get Universe’ to get list of available symbols. Required if brand is not specified.

  • Brand [Optional] Input the desired brand name(s). Required if symbol is not specified.

  • PeriodToDate [Optional] Input ‘Yes’ to include period to date values. If none, PeriodToDate defaults to ‘No’.

  • MonthType [Optional] Input the type of calendar month. Options are ‘Standard’ or ‘Retail’ (4-5-4) calendar month. If none, MonthType defaults to ‘Standard’.

  • PoPGrowth [Optional] Input ‘Yes’ to return year-over-year growth. If none, PoPGrowth defaults to ‘No’.

  • PoPLookback [Optional] Input the number of years for the year-over-year growth calculation. If none, PoPLookback defaults to 1.

  • Dimensions [Optional] Input the desired additional dimensions. Options are ‘Age Group’, ‘Region’, ‘Brand’. If none, Dimensions defaults to none.

Fields Returned

  • PeriodLabel

  • PeriodStartDate

  • PeriodEndDate

  • IsCurrentPeriod

  • Age Group (dependent on panel selected and Dimension value)

  • Brand (dependent on panel selected and Dimension value)

  • Region (dependent on panel selected and Dimension value)

  • Spend (dependent on panel selected)

  • Transaction Count (dependent on panel selected)

  • Cardholder Count (dependent on panel selected)

  • Spend per Transaction (dependent on panel selected)

  • Transactions per Card (dependent on panel selected)

  • Spend per Card (dependent on panel selected)

  • PeriodEndDate_PeriodToDate (dependent on PeriodToDate flag = Yes)

  • Spend_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Transaction Count_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Cardholder Count_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Spend per Transaction_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Transactions per Card_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Spend per Card_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

Get Panel FQ#

This function retrieves data for the selected ticker from the selected panel, and aggregates to fiscal periods.

Parameters

  • PanelName [Required] Select the desired panel name. Use function ‘Get Panels’ to get list of available panels.

  • Symbol [Optional] Select the desired ticker symbol. Use function ‘Get Universe’ to get list of available symbols. Required if brand is not specified.

  • Brand [Optional] Input the desired brand name(s). Required if symbol is not specified.

  • PeriodToDate [Optional] Input ‘Yes’ to include period to date values. If none, PeriodToDate defaults to ‘No’.

  • PoPGrowth [Optional] Input ‘Yes’ to return year-over-year growth. If none, PoPGrowth defaults to ‘No’.

  • PoPLookback [Optional] Input the number of years for the year-over-year growth calculation. If none, PoPLookback defaults to 1.

  • Dimensions [Optional] Input the desired additional dimensions. Options are ‘Age Group’, ‘Region’, ‘Brand’. If none, Dimensions defaults to none.

  • UseReportedForCurrentPeriod [Optional] - Input ‘yes’ to include periods that have not yet reported. If none, UseReportedForCurrentPeriod defaults to ‘yes’.

Fields Returned

  • PeriodLabel

  • PeriodStartDate

  • PeriodEndDate

  • IsCurrentPeriod

  • Age Group (dependent on panel selected and Dimension value)

  • Brand (dependent on panel selected and Dimension value)

  • Region (dependent on panel selected and Dimension value)

  • Spend (dependent on panel selected)

  • Transaction Count (dependent on panel selected)

  • Cardholder Count (dependent on panel selected)

  • Spend per Transaction (dependent on panel selected)

  • Transactions per Card (dependent on panel selected)

  • Spend per Card (dependent on panel selected)

  • PeriodEndDate_PeriodToDate (dependent on PeriodToDate flag = Yes)

  • Spend_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Transaction Count_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Cardholder Count_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Spend per Transaction_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Transactions per Card_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

  • Spend per Card_PeriodToDate (dependent on panel selected and PeriodToDate flag = Yes)

Get KPIs#

This function retrieves all the KPIs available, and mapped, for the selected ticker for the selected panel.

Parameters

  • PanelName [Optional] Select the desired panel name. Use function ‘Get Panels’ to get list of available panels.

  • Symbol [Required] Select the desired ticker symbol. Use function ‘Get Universe’ to get list of available symbols.

  • PrimaryOnly [Optional] Input ‘Yes’ or ‘No’ to filter to primary KPIs only. If none, PrimaryOnly defaults to ‘Yes’.

Fields Returned

  • KPIName

  • UnitOfMeasure

  • StatementType

  • IsPrimary

Get KPI History#

This function retrieves the actual reported values and consensus estimates for an instrument KPI for the selected ticker.

Parameters

  • KPIName [Optional] Input the desired KPI name. Use function ‘Get KPI’ to get list of available KPIs. If none, KPIName defaults to the primary KPI.

  • Symbol [Required] Select the desired ticker symbol. Use function ‘Get Universe’ to get list of available symbols.

Fields Returned

  • PeriodLabel

  • PeriodStartDate

  • PeriodEndDate

  • AsOfDate

  • KPIName

  • UnitOfMeasure

  • MeasureValue

  • EstimateValue

  • EstimateEffectiveDate

  • EstimateName

  • IsCurrentTimePeriod

  • IsNextTimePeriod

  • IsPreviousTimePeriod

Get Models#

This function retrieves all the forecast models available.

Parameters

  • None

Fields Returned

  • ModelName

Get Forecast Data#

This function retrieves the fiscal period data used in forecasts for the selected ticker for the selected panel.

Parameters

  • PanelName [Required] Select the desired panel name. Use function ‘Get Panels’ to get list of available panels.

  • Symbol [Required] Select the desired ticker symbol. Use function ‘Get Universe’ to get list of available symbols.

  • KPIName [Optional] Input the desired KPI name. Use function ‘Get KPI’ to get list of available KPIs. If none, KPIName defaults to the primary KPI.

  • PeriodLength [Required] Input the number of periods to lag for the period over period calculation. Data is grouped by fiscal period so a lag of 4 is equivalent to 1 year.

  • Measure [Optional] Input the desired measure. Options are ‘Spend’, ‘Transaction Count’, ‘Cardholder Count’, ‘Spend per Transaction’, ‘Transactions per Card’, and ‘Spend per Card’. If none, measure defaults to ‘Spend’.

Fields Returned

  • Ticker

  • KPI

  • PeriodLabel

  • PeriodStartDate

  • PeriodEndDate

  • DaysInPeriod

  • NextReportingPeriodFlag

  • PoPLag

  • <KPI> Value

  • <Measure> Value

  • Consensus Mean

  • SurprisePct

  • <KPI> PoP

  • <Measure> PoP

  • Consensus Mean PoP

Get FQ Forecast#

This function retrieves the fiscal period forecast for the selected ticker from the selected panel.

Parameters

  • PanelName [Required] Select the desired panel name. Use function ‘Get Panels’ to get list of available panels.

  • Symbol [Required] Select the desired ticker symbol. Use function ‘Get Universe’ to get list of available symbols.

  • KPIName [Optional] Input the desired KPI name. Use function ‘Get KPI’ to get list of available KPIs. If none, KPIName defaults to the primary KPI.

  • ForecastMethod [Optional] Input the desired forecast method. Options are either ‘Linear’ or ‘Robust’. If none, ForecastMethod defaults to ‘Robust’.

  • ForecastQuarter [Optional] Input the desired forecast quarter. The function will return 8 quarters ending with the forecast quarter. Format is ####-#Q ie. ‘2020-1Q’. If none, ForecastQuarter defaults to the current quarter.

  • Measure [Optional] Input the desired measure. Options are ‘Spend’, ‘Transaction Count’, ‘Cardholder Count’, ‘Spend per Transaction’, ‘Transactions per Card’, and ‘Spend per Card’. If none, measure defaults to ‘Spend’.

  • ReturnMeasure [Optional] Input the desired return measure. This will return only the most recent value for the desired measure. If none, the function returns all possible measures for 8 periods.

Fields Returned

  • PeriodLabel

  • NextReportingPeriodFlag

  • DaysInPeriod

  • PredictedMeasure

  • PredictedYoY

  • ActYoY

  • YoYError

  • EstimateYoY

  • EstimateYoYSurprise

  • ModelPredictedSurprise

  • SurpriseGrid

  • DirectionMatch

Get Multi Panel FQ Forecast#

This function retrieves the fiscal period forecast for the selected ticker from the selected panels.

Parameters

  • PanelNames [Required] Input the desired panel names. Use function ‘Get Panels’ to get list of available panels.

  • Symbol [Required] Select the desired ticker symbol. Use function ‘Get Universe’ to get list of available symbols.

  • KPIName [Optional] Input the desired KPI name. Use function ‘Get KPI’ to get list of available KPIs. If none, KPIName defaults to the primary KPI.

  • ForecastMethod [Optional] Input the desired forecast method. Options are either ‘Linear’ or ‘Robust’. If none, ForecastMethod defaults to ‘Robust’.

  • ForecastQuarter [Optional] Input the desired forecast quarter. The function will return 8 quarters ending with the forecast quarter. Format is ####-#Q ie. ‘2020-1Q’. If none, ForecastQuarter defaults to the current quarter.

  • Measure [Optional] Input the desired measure. Options are ‘Spend’, ‘Transaction Count’, ‘Cardholder Count’, ‘Spend per Transaction’, ‘Transactions per Card’, and ‘Spend per Card’. If none, measure defaults to ‘Spend’.

  • ReturnMeasure [Optional] Input the desired return measure. This will return only the most recent value for the desired measure. If none, the function returns all possible measures for 8 periods.

Fields Returned

  • PanelName

  • PeriodLabel

  • NextReportingPeriodFlag

  • DaysInPeriod

  • PredictedMeasure

  • PredictedYoY

  • ActYoY

  • YoYError

  • EstimateYoY

  • EstimateYoYSurprise

  • ModelPredictedSurprise

Get Universe#

This function retrieves all the instruments available.

Parameters

  • Industry [Optional] Input industry to filter results.

  • Sector [Optional] Input sector to filter results.

Fields Returned

  • Symbol

  • Exchange

  • SymbologyType

  • Sector

  • Industry

Get Universe Screener#

This function retrieves the forecast and estimates for instruments in the selected industry from the selected panel.

Parameters

  • PanelName [Required] Select the desired panel name. Use function ‘Get Panels’ to get list of available panels.

  • Symbols [Optional] Select the desired ticker symbols. Use function ‘Get Universe’ to get list of available symbols.

  • Industry [Optional] Input industry to filter results.

  • IncludeForecast [Optional] Input ‘Yes’ or ‘No’ to include forecast. If none, IncudeForecast defaults to none.

Fields Returned

  • Symbol

  • Exchange

  • Sector

  • Industry

  • PeriodLabel

  • KPIName

  • UnitOfMeasure

  • MeasureName

  • Forecast (dependent on IncludeForecast = Yes)

  • Consensus (dependent on IncludeForecast = Yes)

  • Delta (dependent on IncludeForecast = Yes)

  • MAPE (dependent on IncludeForecast = Yes)

  • Sigma (dependent on IncludeForecast = Yes)

Troubleshooting#

This section provides a reference for the response codes that may appear after running or refreshing a function, what each means, and steps to take to resolve the issue.

Response codes appear in the cell containing the Quantamatics function.

Response Code

Meaning

Steps to Resolve

You’re not signed in

You need to sign in to the plug-in for the functions to run successfully

Choose Login to Hub, in the Quantamatics toolbar

Null response

No response

Re-run the function as the request may have timed out

#N/A Request In Progress…

Request is being processed

Await the results

404 Error

You lack permissions to the requested resource

Contact support@quantamatics.com if you believe you should have access to the requested resource