Factset · Schema

Metric

Metadata for a single available fundamental metric including its category, data type, and documentation reference.

FinancialFinancial DataInvestment AnalyticsMarket DataPortfolio AnalyticsResearch

Properties

Name	Type	Description
metric	['string', 'null']	Metric identifier to be used as input in the metrics parameter.
name	['string', 'null']	Plain text name of the metric.
category	['string', 'null']	Primary category such as INCOME_STATEMENT, BALANCE_SHEET, CASH_FLOW, or RATIOS.
subcategory	['string', 'null']	Sub-category such as ASSETS, SUPPLEMENTAL, SHAREHOLDERS_EQUITY, VALUATION, PROFITABILITY, etc.
oaPageId	['string', 'null']	Online Assistant Page ID in D***** format for methodology lookup.
oaUrl	['string', 'null']	Online Assistant URL for methodology definitions.
factor	['integer', 'null']	The factor for the metric (e.g. 1000000 = millions).
sdfPackage	['string', 'null']	Standard Data Feed package availability. BASIC or ADVANCED. Null indicates API-only availability.
dataType	['string', 'null']	The data type for the metric (date, doubleArray, float, floatArray, intArray, string, stringArray).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Metric",
  "type": "object",
  "description": "Metadata for a single available fundamental metric including its category, data type, and documentation reference.",
  "properties": {
    "metric": {
      "type": "['string', 'null']",
      "description": "Metric identifier to be used as input in the metrics parameter."
    },
    "name": {
      "type": "['string', 'null']",
      "description": "Plain text name of the metric."
    },
    "category": {
      "type": "['string', 'null']",
      "description": "Primary category such as INCOME_STATEMENT, BALANCE_SHEET, CASH_FLOW, or RATIOS."
    },
    "subcategory": {
      "type": "['string', 'null']",
      "description": "Sub-category such as ASSETS, SUPPLEMENTAL, SHAREHOLDERS_EQUITY, VALUATION, PROFITABILITY, etc."
    },
    "oaPageId": {
      "type": "['string', 'null']",
      "description": "Online Assistant Page ID in D***** format for methodology lookup."
    },
    "oaUrl": {
      "type": "['string', 'null']",
      "description": "Online Assistant URL for methodology definitions."
    },
    "factor": {
      "type": "['integer', 'null']",
      "description": "The factor for the metric (e.g. 1000000 = millions)."
    },
    "sdfPackage": {
      "type": "['string', 'null']",
      "description": "Standard Data Feed package availability. BASIC or ADVANCED. Null indicates API-only availability."
    },
    "dataType": {
      "type": "['string', 'null']",
      "description": "The data type for the metric (date, doubleArray, float, floatArray, intArray, string, stringArray)."
    }
  }
}