OutputViewDefinition
objectDefinition of a view, including the datapoints it contains.
* Additional properties are NOT allowed.
idstringrequired
Identifier of an entitled view or dataset. Use this value as viewId in investment detail requests.
>= 1 characters
Example:equity-short-interest
dataPointsarray[object]required
Datapoint included in the view and its dependency flags
* Additional properties are NOT allowed.
Show Child Parameters
Example
OutputViewDefinitionDataPoint
objectDatapoint included in the view and its dependency flags
* Additional properties are NOT allowed.
idstringrequired
Fully-qualified datapoint identifier.
>= 1 characters
Example:shortInterest.daysToCover
isLanguageDependentbooleanrequired
Indicates whether the datapoint varies by language.
isCountryDependentbooleanrequired
Indicates whether the datapoint varies by country.
isCurrencyDependentbooleanrequired
Indicates whether the datapoint varies by currency.
Example
OutputViewDetails
objectA view package and the dataset viewIds it contains.
* Additional properties are NOT allowed.
packageobjectrequired
Identifies the entitled package-level view.
* Additional properties are NOT allowed.
Show Child Parameters
datasetsarray[object]required
Identifies a dataset viewId associated with a package.
>= 0 items
* Additional properties are NOT allowed.
Show Child Parameters
Example
OutputViewId
stringIdentifier of an entitled view or dataset. Use this value as viewId in investment detail requests.
>= 1 characters
Example
OutputViewPackage
objectIdentifies the entitled package-level view.
* Additional properties are NOT allowed.
viewIdstringrequired
Identifier of an entitled view or dataset. Use this value as viewId in investment detail requests.
>= 1 characters
Example:equity-short-interest
Example