StatPro Revolution Web API


The Compliance Backtesting History Resource


Overview

The Compliance Backtesting History resource represents the historic set of compliance backtesting results for a portfolio that has been activated for compliance. It will contain total level results only.

See annotated representations below for further details of the results output by this resource.


Media types

The Compliance Backtesting History resource is exposed via XML and JSON representations, which have the following media type names:-

application/vnd.statpro.revolution.api.compliance-backtesting-history+json

application/vnd.statpro.revolution.api.compliance-backtesting-history+xml

When a response is received from the web service with status 200 (= OK), the fact that the response contains a Compliance Backtesting History resource representation is indicated by the presence of one of these two response headers:-

Content-Type: application/vnd.statpro.revolution.api.compliance-backtesting-history+json; charset=utf-8

Content-Type: application/vnd.statpro.revolution.api.compliance-backtesting-history+xml; charset=utf-8


Related resources

The Compliance Backtesting History resource always links to the Service and Porfolios resources (and to itself). To access these resources use the link relations:-

  • self
  • service
  • portfolios-query

The self link relation identifies the link to the current Compliance Backtesting History resource.

The service link relation identifies the Service resource link.

The portfolios-query link relation identifies the link that allows a new query for portfolios to be made.


Update history

  • Initial Version - June 2017

Annotated Representation (JSON)

Legend

{
  "complianceBacktestingHistory": {
    "links": {
      "service": {
        "rel": "service",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.service+json"
      },
      "portfoliosQuery": {
        "rel": "portfolios-query",
        "href": "...?$filter={filter}&$orderby={orderby}&$skip={skip}&$top={top}&includePublishedPortfolios=false&portfolioClassifierCode=",
        "type": "application/vnd.statpro.revolution.api.portfolios+json"
      },
      "self": {
        "rel": "self",
        "href": "...",
        "type": "application/vnd.statpro.revolution.api.compliance-backtesting-history+json"
      }
    },
    "complianceBacktestingResults": [
      {
        "varAsOf": "2016-01-25",
        "returnAsOf": "2016-01-26",
        "coveragePercentage": 78.2936125833218,
        "percentile": 0.99,
        "valueAtRisk": 2.24763754807771,
        "portfolioReturn": 0.868456267167776,
        "numberOfComments": 1,
        "isIgnored": false,
        "returnOverride": 1.557,
        "valueAtRiskOverride": 1.889,
        "isBreach": false,
        "portfolioComments": {
          "rel": "portfolio-comments",
          "href": "...",
          "type": "application/vnd.statpro.revolution.api.portfolio-comments+json"
        }
      },
      {
        "varAsOf": "2016-01-13",
        "returnAsOf": "2016-01-14",
        "coveragePercentage": 78.3047595965788,
        "percentile": 0.99,
        "valueAtRisk": 2.24509864683714,
        "portfolioReturn": 1.51150407423923,
        "numberOfComments": 0,
        "isIgnored": false,
        "returnOverride": null,
        "valueAtRiskOverride": null,
        "isBreach": false
      }
    ]
  }
}


Annotated Representation (XML)

Legend

<?xml version="1.0" encoding="utf-8"?>
<complianceBacktestingHistory xmlns="http://statpro.com/2012/Revolution">
  <link rel="service"
        href="..."
        type="application/vnd.statpro.revolution.api.service+xml" />
  <link rel="portfolios-query"
        href="...?$filter={filter}&amp;$orderby={orderby}&amp;$skip={skip}&amp;$top={top}&amp;includePublishedPortfolios=false&amp;portfolioClassifierCode="
        type="application/vnd.statpro.revolution.api.portfolios+xml" />
  <link rel="self"
        href="..."
        type="application/vnd.statpro.revolution.api.compliance-backtesting-history+xml" />
  <complianceBacktestingResults>
    <dp varAsOf="2016-01-25" returnAsOf="2016-01-26">
      <coveragePercentage>78.2936125833218</coveragePercentage>
      <percentile>0.99</percentile>
      <valueAtRisk>2.24763754807771</valueAtRisk>
      <portfolioReturn>0.868456267167776</portfolioReturn>
      <numberOfComments>1</numberOfComments>
      <isIgnored>false</isIgnored>
      <returnOverride>1.557</returnOverride>
      <valueAtRiskOverride>1.889</valueAtRiskOverride>
      <isBreach>false</isBreach>
      <link rel="portfolio-comments"
            href="..."
            type="application/vnd.statpro.revolution.api.portfolio-comments+xml" />
    </dp>
    <dp varAsOf="2016-01-13" returnAsOf="2016-01-14">
      <coveragePercentage>78.3047595965788</coveragePercentage>
      <percentile>0.99</percentile>
      <valueAtRisk>2.24509864683714</valueAtRisk>
      <portfolioReturn>1.51150407423923</portfolioReturn>
      <numberOfComments>0</numberOfComments>
      <isIgnored>false</isIgnored>
      <returnOverride />
      <valueAtRiskOverride />
      <isBreach>false</isBreach>
    </dp>
  </complianceBacktestingResults>
</complianceBacktestingHistory>


Last updated: June 2017


To Top