Retrieve Reports

Get Report

Returns a report.

Requires the reports:Get permission

For the SchemeFeeDetails and ReconciliationDetails reports, their respective permissions are also accepted as alternatives to reports:Get.

  • reports:GetSchemeFeeDetails
  • reports:GetReconciliationDetails
get/reports/{reportKey}

Request

Path parameters

reportKeystring required

Uniquely identifies a report object

Example:rep-1e1dAHhgstYTUhlphPzZ

Response

A report object

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "key": "rep-1e1dAHhgstYTUhlphPzZ",
  "agentKey": "cgt-1UF2NafdfrdPMf2XrS2",
  "distributions": [
    "dst-1e1dAHhgstYTUhlphPzZ"
  ],
  "reportScheduleKey": "rsk-1e1dAHhgstYTUhlphPzZ"
}

Changes

No recorded changes to this operation across all 1 revision of this API.