List FunctionsΒΆ
The list of functions is unique to each user based on what assets they have assigned, below is how you can lookup functions for your account and their respective params
Request:
POST /api/function/ListUserFunctions HTTP/1.1
Host: api.quantamatics.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json
Response:
{
"id": 1,
"name": "Get Panel FQ",
"assetId": 33,
"assetName": "Facteus Functions",
"description": "This function retrieves data for the selected ticker from the selected panel, and aggregates to fiscal periods.",
"params": [
{
"id": 2539,
"name": "Symbol",
"type": 6,
"description": "[Optional] Select the desired ticker symbol. Use function 'Get Universe' to get list of available symbols. Required if brand is not specified.",
"required": false,
"functionId": 1,
"sortValue": 0,
"context": null
},
{
"id": 2538,
"name": "PanelName",
"type": 8,
"description": "[Required] Select the desired panel name. Use function 'Get Panels' to get list of available panels.",
"required": true,
"functionId": 1,
"sortValue": 0,
"context": null
},
{
"id": 2545,
"name": "UseReportedForCurrentPeriod",
"type": 0,
"description": "[Optional] - Input 'yes' to include periods that have not yet reported. If none, UseReportedForCurrentPeriod defaults to 'yes'.",
"required": false,
"functionId": 1,
"sortValue": 0,
"context": null
},
{
"id": 2544,
"name": "Dimensions",
"type": 4,
"description": "[Optional] Input the desired additional dimensions. Options are 'Age Group', 'Region', 'Brand'. If none, Dimensions defaults to none.",
"required": false,
"functionId": 1,
"sortValue": 0,
"context": null
},
{
"id": 2543,
"name": "PoPLookback",
"type": 1,
"description": "[Optional] Input the number of years for the year-over-year growth calculation. If none, PoPLookback defaults to 1.",
"required": false,
"functionId": 1,
"sortValue": 0,
"context": null
},
{
"id": 2542,
"name": "PoPGrowth",
"type": 0,
"description": "[Optional] Input 'Yes' to return year-over-year growth. If none, PoPGrowth defaults to 'No'.",
"required": false,
"functionId": 1,
"sortValue": 0,
"context": null
},
{
"id": 2541,
"name": "PeriodToDate",
"type": 0,
"description": "[Optional] Input 'Yes' to include period to date values. If none, PeriodToDate defaults to 'No'.",
"required": false,
"functionId": 1,
"sortValue": 0,
"context": null
},
{
"id": 2540,
"name": "Brand",
"type": 4,
"description": "[Optional] Input the desired brand name(s). Required if symbol is not specified.",
"required": false,
"functionId": 1,
"sortValue": 0,
"context": null
}
],
"sortValue": 0,
"groupId": 2,
"groupName": null,
"authorId": 0,
"authorUserName": null,
"isShared": false,
"entryPoint": "GetPanelFQ",
"uniqueId": "9ca45abf...",
"notebookId": "a82483ec...",
"notebookName": null,
"orgName": null,
"type": null,
"source": null,
"context": null
},
{
"id": 2,
"name": "Get Panel Daily",
"assetId": 33,
"assetName": "Facteus Functions",
"description": "This function retrieves data for the selected ticker from the selected panel, and aggregates to the daily level.",
"params": [
{
"id": 2525,
"name": "PanelName",
"type": 8,
"description": "[Required] Select the desired panel name. Use function 'Get Panels' to get list of available panels.",
"required": true,
"functionId": 2,
"sortValue": 0,
"context": null
},
{
"id": 2526,
"name": "Symbol",
"type": 6,
"description": "[Optional] Select the desired ticker symbol. Use function 'Get Universe' to get list of available symbols. Required if brand is not specified.",
"required": false,
"functionId": 2,
"sortValue": 0,
"context": null
},
{
"id": 2527,
"name": "Brand",
"type": 4,
"description": "[Optional] Input the desired brand name(s). Required if symbol is not specified.",
"required": false,
"functionId": 2,
"sortValue": 0,
"context": null
},
{
"id": 2528,
"name": "PoPGrowth",
"type": 0,
"description": "[Optional] Input 'Yes' to return period over period growth values. If none, PoPGrowth defaults to 'No'.",
"required": false,
"functionId": 2,
"sortValue": 0,
"context": null
},
{
"id": 2529,
"name": "PoPLookback",
"type": 1,
"description": "[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.",
"required": false,
"functionId": 2,
"sortValue": 0,
"context": null
},
{
"id": 2530,
"name": "Dimensions",
"type": 4,
"description": "[Optional] Input the desired additional dimensions. Options are 'Age Group', 'Region', 'Brand'. If none, Dimensions defaults to none.",
"required": false,
"functionId": 2,
"sortValue": 0,
"context": null
}
],
"sortValue": 0,
"groupId": 0,
"groupName": null,
"authorId": 0,
"authorUserName": null,
"isShared": false,
"entryPoint": "GetPanelDaily",
"uniqueId": "abf495ec...",
"notebookId": "0314451c...",
"notebookName": null,
"orgName": null,
"type": null,
"source": null,
"context": null
},
{
"id": 3,
"name": "Get KPIs",
"assetId": 33,
"assetName": "Facteus Functions",
"description": "This function retrieves all the KPIs available, and mapped, for the selected ticker for the selected panel.",
"params": [
{
"id": 2522,
"name": "PanelName",
"type": 8,
"description": "[Optional] Select the desired panel name. Use function 'Get Panels' to get list of available panels.",
"required": false,
"functionId": 3,
"sortValue": 0,
"context": null
},
{
"id": 2524,
"name": "PrimaryOnly",
"type": 0,
"description": "[Optional] Input 'Yes' or 'No' to filter to primary KPIs only. If none, PrimaryOnly defaults to 'Yes'",
"required": false,
"functionId": 3,
"sortValue": 0,
"context": null
},
{
"id": 2523,
"name": "Symbol",
"type": 6,
"description": "[Required] Select the desired ticker symbol. Use function 'Get Universe' to get list of available symbols.",
"required": true,
"functionId": 3,
"sortValue": 0,
"context": null
}
],
"sortValue": 0,
"groupId": 0,
"groupName": null,
"authorId": 0,
"authorUserName": null,
"isShared": false,
"entryPoint": "GetKPIs",
"uniqueId": "64e5fae0-...",
"notebookId": "1dd90a50-...",
"notebookName": null,
"orgName": null,
"type": null,
"source": null,
"context": null
}
...