segmentsEstimate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "segmentsEstimate",
  "type": "object",
  "properties": {
    "requestId": {
      "type": "string",
      "description": "Identifier that was used for the request."
    },
    "fsymId": {
      "type": "string",
      "description": "Factset Regional Security Identifier. Six alpha-numeric characters, excluding vowels, with an -R suffix (XXXXXX-R). Identifies the securitys best regional security data series per currency. For equities, all primary listings per region and currency are allocated a regional-level permanent identifier. The regional-level permanent identifier will be available once a SEDOL representing the region/currency has been allocated and the identifiers are on FactSet."
    },
    "segmentType": {
      "type": "string",
      "description": "Segment selected"
    },
    "metric": {
      "type": "string",
      "description": "Company's Financial statement 'metric' that is estimated. Use the factset-estimates/v#/metrics endpoint for a complete list. For more details, visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034)"
    },
    "fiscalPeriod": {
      "type": "integer",
      "description": "Company's 'fiscal period' for the estimate record. Periods for periodicity of ANN = 1, and SEMI = 2. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)."
    },
    "fiscalYear": {
      "type": "integer",
      "description": "Company's 'fiscal year' for the estimate record. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)"
    },
    "segmentLabel": {
      "type": "string",
      "description": "Displays the specific label of the segment."
    },
    "segmentLevel": {
      "type": "string",
      "description": "Returns the level of the segment item as either P = Parent or S = Subordinate"
    },
    "fiscalEndDate": {
      "type": "string",
      "description": "Company's 'fiscal end date' for the estimate record expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)"
    },
    "estimateDate": {
      "type": "string",
      "description": "The date the estimates are as of in YYYY-MM-DD format."
    },
    "currency": {
      "type": "string",
      "description": "Currency used estimates in consensus calculations. Use 'ESTIMATE' as input for values in Estimate Currency. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470)."
    },
    "estimateCurrency": {
      "type": "string",
      "description": "Estimate currency of the requested Security"
    },
    "mean": {
      "type": "number",
      "description": "Mean of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)"
    },
    "median": {
      "type": "number",
      "description": "Median of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)"
    },
    "standardDeviation": {
      "type": "number",
      "description": "Standard deviation of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)"
    },
    "high": {
      "type": "number",
      "description": "Highest estimate in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)."
    },
    "low": {
      "type": "number",
      "description": "Lowest estimate in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)"
    },
    "estimateCount": {
      "type": "integer",
      "description": "Count or NEST of estimates in consensus calculation. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)"
    },
    "up": {
      "type": "integer",
      "description": "Number of Up Revisions within the consensus for the metric and period. The default window size is 100 days For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)."
    },
    "down": {
      "type": "integer",
      "description": "Number of Up Revisions within the consensus for the metric and period. The default window size is 100 days. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)."
    }
  }
}