StatApiInputDTO

Description

Model to describe the request of a Stat. Please note that the costPrice stat is deprecated and will EOL in 8.12.1. Use the dedicated 'cost' endpoints in /entities, /groups and /markets instead.

Optional Parameters

name

  • type: string

  • description: Name of the stat

relatedEntityType

  • type: string

  • description: Used to get stats from different entity types in the supply chain of {uuid} E.G.costPrice of the VMs where the scope is a PM

filters

  • type: array

  • description: Filters to apply to the requested stats. Commodities supported values: key = {commodity_key}, relation = sold|bought, virtualDisk = {uuid}. Cost Price supported values: cumulative = true|false, cloudService = {uuid}, target = {uuid}, CSP = {name}, category = {name}, businessUnit = {uuid}, costComponent = COMPUTE|IP|LICENSE|STORAGE, costComponentArtifact = {key}. Please note that the costPrice stat is deprecated and will EOL in 8.12.1. Use the dedicated 'cost' endpoints in /entities, /groups and /markets instead.Action stats supported values: actionTypes = {actionType}, actionModes: {action_mode}, actionStates: {action_state}, riskSubCategory: Performance Assurance|Efficiency Improvement|Prevention|Compliance, riskSeverity: UNKNOWN|NORMAL|MINOR|MAJOR|CRITICAL

groupBy

  • type: array

  • description: Execute a groupBy on the values of the stats. Commodities supported values: key, relatedEntity, virtualDisk. Cost Price supported values: cloudService, target, CSP, category, businessUnit, costComponent, costComponentArtifact. Please note that the costPrice stat is deprecated and will EOL in 8.12.1. Use the dedicated 'cost' endpoints in /entities, /groups and /markets instead.Action stats supported values: actionTypes, actionModes, actionStates, risk, riskSubCategory, riskSeverity

    • type: string

historyType

  • type: string

  • description: Query the histUtilization table for these historyTypes

  • enum: ['Percentile', 'Smoothed']