StatPro Revolution Web API
The Signed-Off Portfolio Analysis Resource
- Media types
- Related resources
- Processing messages
- Update history
- Annotated Representations (JSON)
- Annotated Representations (XML)
The Signed-Off Portfolio Analysis resource represents an analysis of one of the identified user's portfolios. The portfolio in question may be owned by the user, or may be owned by another user and shared to the identified user. The resource contains basic information about the portfolio, analysis-specific information and information about the calculation (or execution) of that analysis. If the analysis has finished being calculated, then the resource exposes links to further resources that contain the analysis's results data.
A portfolio only exposes a Signed-Off Portfolio Analysis if some results have been previously proposed for sign-off from the Portfolio Sign-Off Dashboard and subsequently signed-off within the Revolution website.
From within the Portfolio Sign-Off Dashboard it is possible to propose results for any portfolio to calculate results using a specific start and/or end date. When results are first proposed for sign-off then the portfolio will have an Awaiting Sign-Off Portfolio Analysis. Once the results for this analysis have been calculated, then the results are frozen and they will not be modified unless they are re-proposed with either the same or new dates. It is then possible to sign-off these awaiting sign-off results using the same Portfolio Sign-Off Dashboard which will transform the Awaiting Sign-Off Portfolio Analysis into a Signed-Off Portfolio Analysis. The results for the signed-off analysis cannot be modified once signed-off unless new results are re-proposed and those results signed-off (i.e. there can only be one set of signed-off results at any point in time). However, it is possible for there to exist a single Awaiting Sign-Off Portfolio Analysis at the same time as a single Signed-Off Portfolio Analysis for any given portfolio.
Unlike the portfolio's default analysis, only the latest version of the awaiting sign-off portfolio analysis can be requested (i.e. it is not possible to request the last successful).
A portfolio analysis's status is important. It indicates whether the calculation of the analysis is in progress, has finished, has failed, or whether no results are available. If the analysis is in progress then it will become either finished or failed at some point in the future. Re-request the resource periodically (say once every three seconds) to determine its final status.
If a portfolio analysis has finished (with or without messages), then analysis results are available, and returned representations will include links to the Segments Tree Node, Whole Segments Tree, Time Series and Multiple OCP Time Series resources that contain the analysis's segments, securities, measures and time series data.
If a portfolio analysis has failed, then no analysis results are available. Instead the returned representation will include one or more error messages detailing why the analysis failed. The only exceptions to this are the Interactive Risk Analysis and Interactive Statistics Analysis which are available regardless of the portfolio analysis's status. This is because these resources enable a new calculation on-the-fly and don't depend on any previously calculated results.
If a portfolio analysis's status indicates that no results are available, then no results can be extracted given the current state of the portfolio and/or its awaiting sign-off analysis. It may be that the portfolio has been recently created, and currently has no holdings.
The Signed-Off Portfolio Analysis resource is exposed via XML and JSON representations, which have the following media type names:-
When a response is received from the web service with status 200 (= OK), the fact that the response contains a Signed-Off Portfolio Analysis resource representation is indicated by the presence of one of these two response headers:-
Content-Type: application/vnd.statpro.revolution.api.signedoff-portfolio-analysis+json; charset=utf-8
Content-Type: application/vnd.statpro.revolution.api.signedoff-portfolio-analysis+xml; charset=utf-8
The Signed-Off Portfolio Analysis resource always links to the Service, Porfolios, Portfolio Analysis Controller, Interactive Statistics Analysis and Interactive Risk Analysis resources (and to itself). If the signed-off portfolio analysis has finished then analysis results are available, and the resource will also link to the Segments Tree Node, Whole Segments Tree, Time Series and Multiple OCP Time Series resources. To do so, its resource representations use link relations:-
self link relation identifies the link to the current Signed-Off Portfolio Analysis resource. Use this link to poll for availability of results (or calculation failure) if the current status indicates that the analysis is in-progress.
service link relation identifies the Service resource link.
portfolios-query link relation identifies the link that allows a new query for portfolios to be made.
portfolio-analysis-controller-query link relation identifies the link that supports triggering actions on portfolio analyses (currently allows triggering custom time period portfolio analyses).
interactive-risk-analysis-query link relation identifies the link that allows a new query for performing an on-the-fly interactive risk calculation to be made.
segments-tree-root-node-query link relation identifies the link that allows a client application to extract segments, securities and measures from the Segments Tree via a query that starts at the tree's root node.
whole-segments-tree-query link relation identifies the link that allows a client application to extract segments, securities and measures from (potentially) the whole of the Segments Tree, without having to query for each node.
time-series-query link relation identifies the link that allows a client application to extract time series data for one or more measures for the Total segment. (Links to time series data for other segments are exposed by the Segments Tree Node resource.)
multiple-ocp-time-series-query link relation identifies the link that allows a client application to query for Overall Custom Period (OCP) time series data for multiple segments, multiple measures and multiple time periods.
interactive-statistics-analysis-query link relation identifies the link that allows a new query for performing on-the-fly interactive statistics calculations to be made.
All related resources are accessed using the HTTP GET method, with the exception of the following which are accessed via the POST method:
Please refer to Portfolio Analysis - Processing Messages.
- Additional attributes
categoriesare now available for the
errorscollections - Oct 2018
- Interactive Risk Analysis resource is now available for all tiers of Portfolio including Platinum - April 2018
- The property
statusUpdatedis now available - May 2018
- The property
securityAllocationClassifiersis now available - October 2017
- The properties
investmentStrategyare now available - August 2017.
- Added link to request custom time period portfolio analysis calculations - June 2017.
- Added link to request interactive statistics analysis calculations - Mar 2017
- The following properties have been added - December 2016:
- analysis -> statisticsSampleType
- analysis -> statisticsMinimumSampleSize
- analysis -> risk -> exponentialDecayFactor
- analysis -> risk -> riskFactorHistory
- analysis -> benchmarks -> id
- analysis -> benchmarks -> marketValueMode
- analysis -> benchmarks -> rescalingMode
- The "earliestDate" property has been added - February 2016
- The "useLogReturns" property has been added - November 2015
- The "id" property has been added to the classifiers - November 2015
- The analysis "code" property has been introduced - August 2015.
- The benchmark "code" and "description" properties have been introduced - August 2015.
- Interactive Risk Analysis resource is now available for Platinum Portfolios - August 2015
- Initial Version - December 2014
Annotated Representations (JSON)
Annotated Representations (XML)
Last updated: October 2018