Factset · Schema
surprise
FinancialFinancial DataInvestment AnalyticsMarket DataPortfolio AnalyticsResearch
Properties
| Name | Type | Description |
|---|---|---|
| fsymId | string | |
| date | string | Date for data expressed in YYYY-MM-DD format. |
| currency | string | Currency code for adjusting the data. Use 'ESTIMATE' as input value for the values in Estimate Currency. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.c |
| estimateCurrency | string | Estimate currency of the requested Security |
| metric | string | 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.fact |
| statistic | string | Method of calculation for the consensus 'statistic'. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114). |
| periodicity | string | Company's 'periodicity' for the estimate record, reflecting Annual, Quarterly, or Semi-Annual report periods. Next-twelve-months (NTMA) and Last-twelve-months (LTMA) also supported. |
| fiscalEndDate | string | Company's 'fiscal end date' for the estimate record expressed in YYYY-MM-DD format |
| fiscalYear | integer | Company's 'fiscal year' for the estimate record |
| fiscalPeriod | integer | Company's 'fiscal period' for the estimate record. 'Periodicity' defines context for period. |
| surpriseDate | string | Date of the reported event expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16601](https://oa.apps.factset.com/pages/16601). |
| surpriseAmount | number | Amount of difference between last consensus and actual. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145). |
| surprisePercent | number | Percent difference between last consensus and actual. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145). |
| surpriseBefore | number | Last consensus before event. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145). |
| surpriseAfter | number | Actual value after event. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145). |
| eventDescription | string | Description of event. For more details, visit [Online Assistant Page #16601](https://oa.apps.factset.com/pages/16601). |
| eventFlag | integer | Flag for event. Code of Event Flag, where 0 = results and 1 = profit warning. For more details, visit [Online Assistant Page #16601](https://oa.apps.factset.com/pages/16601). |
| requestId | string |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "surprise",
"type": "object",
"properties": {
"fsymId": {
"type": "string"
},
"date": {
"type": "string",
"description": "Date for data expressed in YYYY-MM-DD format."
},
"currency": {
"type": "string",
"description": "Currency code for adjusting the data. Use 'ESTIMATE' as input value for the 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"
},
"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)."
},
"statistic": {
"type": "string",
"description": "Method of calculation for the consensus 'statistic'. For more details, visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)."
},
"periodicity": {
"type": "string",
"description": "Company's 'periodicity' for the estimate record, reflecting Annual, Quarterly, or Semi-Annual report periods. Next-twelve-months (NTMA) and Last-twelve-months (LTMA) also supported."
},
"fiscalEndDate": {
"type": "string",
"description": "Company's 'fiscal end date' for the estimate record expressed in YYYY-MM-DD format"
},
"fiscalYear": {
"type": "integer",
"description": "Company's 'fiscal year' for the estimate record"
},
"fiscalPeriod": {
"type": "integer",
"description": "Company's 'fiscal period' for the estimate record. 'Periodicity' defines context for period."
},
"surpriseDate": {
"type": "string",
"description": "Date of the reported event expressed in YYYY-MM-DD format. For more details, visit [Online Assistant Page #16601](https://oa.apps.factset.com/pages/16601)."
},
"surpriseAmount": {
"type": "number",
"description": "Amount of difference between last consensus and actual. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145)."
},
"surprisePercent": {
"type": "number",
"description": "Percent difference between last consensus and actual. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145)."
},
"surpriseBefore": {
"type": "number",
"description": "Last consensus before event. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145)."
},
"surpriseAfter": {
"type": "number",
"description": "Actual value after event. For more details, visit [Online Assistant Page #16145](https://oa.apps.factset.com/pages/16145)."
},
"eventDescription": {
"type": "string",
"description": "Description of event. For more details, visit [Online Assistant Page #16601](https://oa.apps.factset.com/pages/16601)."
},
"eventFlag": {
"type": "integer",
"description": "Flag for event. Code of Event Flag, where 0 = results and 1 = profit warning. For more details, visit [Online Assistant Page #16601](https://oa.apps.factset.com/pages/16601)."
},
"requestId": {
"type": "string"
}
}
}