Reporting/Scope Simple Performance Example

Purpose: This is a sample of a simple Performance request utilizing the /Reporting/Scope endpoint. Please be sure to reference the exhaustive Reporting/Scope document for detailed instructions on how to gather additional data. Reporting Scope – Performance/Allocation/Activity Summary – Exhaustive

Simple Use Case: If you need standard Performance data for a given entity at monthly intervals from inception.

Scope and Outputs: This example is for monthly Registration level performance data as of 03/31/2022 from inception.

Process Overview: The below is a POST example to the /Reporting/Scope endpoint. Steps for setting scope of report and additional data that can be gathered are located in Reporting Scope – Performance/Allocation/Activity Summary – Exhaustive.

Process steps:
1. Sample POST
2. Response

POST: /Reporting/Scope

{
    "entity": "Registration",
    "entityIds": [
        64
    ],
    "asOfDate": "2022-03-31",
    "calculations": [{
        "$type": "grouping",
        "grouping": "Registration",
        "calculations": [{
            "$type": "performance-series",
            "returnStyle": {
                                "frequency": "Monthly",
                "basedOn": "Calendar",
                "cumulative": false,
                "breakBehavior": "AllowPartialPeriods"
            },
            "contextChange": {
                "dateRange": {
                    "$type": "date-range",
                    "startDate": "1970-12-31",
                    "endDate": "2022-03-31"
                },
 
                "performanceOption": {
                    "$type": "performance",
                    "calculationMethod": "TWR",
                    "calcGrossOfFees": false
                }
            }
        }]
    }]
}

2. Response sample: Only the 1^st partial month, 1^st full month, and last month are shown in the response below.

{
  "sessionId": "bf098152-56f2-491a-8f77-2f59263f5a39",
  "asOfDate": "2022-03-31",
  "dataLastUpdated": "2022-08-19T14:54:32.2571511-05:00",
  "calculations": [
    {
      "$type": "calculated-list",
      "calculations": [
        {
          "$type": "calculated-group",
          "groupId": 2,
          "grouping": "Registration",
          "groupEntityId": 64,
          "groupEntityIdPath": null,
          "name": "John & Jane Smith, Conservatorship",
          "inceptionDate": "2007-07-17",
          "calculations": [
            {
              "$type": "calculated-performance-series",
              "calculatedPerformanceOptionId": 4,
              "series": [
                {
                  "startDate": "2007-07-17",
                  "endDate": "2007-07-31",
                  "performance": -0.005200583333
                },
                {
                  "startDate": "2007-08-01",
                  "endDate": "2007-08-31",
                  "performance": 0.005037903621
                },
                                {
                  "startDate": "2022-03-01",
                  "endDate": "2022-03-31",
                  "performance": -0.003973727552
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Process Tips or Controls:

Percentages are decimals and will need to be converted.

Development Guides

Reporting/Scope Simple Performance Example