Investment Details API

Retrieve a view definition

get

Path Parameters

viewIdstringrequired

A view id, a standard package/dataset id, or the id of a saved dataset. When omitted, returns all entitled views and saved datasets.

Response

application/json

OK

ResponseGetView

Response containing a view definition and the datapoints included in the view.

* Additional properties are NOT allowed.
viewDefinitionobjectrequired

Definition of a view, including the datapoints it contains.

* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired

All fields are nullable. Empty or null value fields are not returned.

* Additional properties are NOT allowed.
Show Child Parameters
get/direct-web-services/v1/investments/views/{viewId}
 
application/json

List views

Retrieve the list of data views your account is entitled to access, along with the corresponding viewId values required to request investment details.

get

Response

application/json

OK

ResponseListViews

Response containing entitled view packages and their associated dataset viewIds.

* Additional properties are NOT allowed.
viewsarray[object]required

A view package and the dataset viewIds it contains.

* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired

All fields are nullable. Empty or null value fields are not returned.

* Additional properties are NOT allowed.
Show Child Parameters
get/direct-web-services/v1/investments/views
 
application/json

ResponseCustomView

object

Contains one property per view or dataset included in the custom view, named as in the response of that view (for example activeShare), alongside identifiers and metadata.

identifiersobject

All fields are nullable. Empty or null value fields are not returned.

* Additional properties are NOT allowed.
Show Child Parameters
metadataobject

All fields are nullable. Empty or null value fields are not returned.

* Additional properties are NOT allowed.
Show Child Parameters
Example

OutputErrorDetails

object

Error details

* Additional properties are NOT allowed.
statusCodeinteger(int32)

Status Code

errorCodestring

Custom error code

messagestring

Message

requestIdstring

RequestId

Example

CodeMappingBoolean

object
* Additional properties are NOT allowed.
valuestring
codeboolean
Example