--- title: "Get Report" method: GET path: "/reports/{reportKey}" tags: ["Retrieve Reports"] --- # Get Report `GET /reports/{reportKey}` ## Request - Base URL: `https://eu-west-1.api.silverflow.com/v1` - URL: `https://eu-west-1.api.silverflow.com/v1/reports/{reportKey}` - Auth: one of: - HTTP basic - HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) 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` ## Path parameters - `reportKey` string, required: Uniquely identifies a report object ## Response `200` A report object - union - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object - PublicReport: A report entity. - `key` string, required: Uniquely identifies a report object - `agentKey` string, required: Uniquely identifies an Agent - `reference` string: Unique ID used to identify a report. - `status` 'completed' | 'archived' | 'failed' | 'scheduled', required: The status of the report. - `result` SchemasResult: The result properties of generating the report. - `size` number, required: The file size, in bytes. - `lastToken` string: This value can be used in the `sinceToken` field of a subsequent request to retrieve scheme fee records that have not been returned in a previous report. - `errorMessage` string: The error message, if applicable. - `created` string, date-time, required: The date and time this object was created - `lastModified` string, date-time: The date and time this object was last modified - `version` integer, required: The version of this object - `distributions` DistributionKey[] - `reportScheduleKey` string: Uniquely identifies a report schedule object ## Other responses - `400`: Bad Request - `401`: Unauthorized - `403`: The authenticated client is forbidden to make the request for the resource identified. - `404`: Report not found - `429`: The number of requests (per minute) has exceeded the configured maximum --- [API](https://skmtc.dev/silverflow/apis/silverflow-api.md) - [All operations](https://skmtc.dev/silverflow/apis/silverflow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/silverflow/apis/silverflow-api/revisions/43ecbe4fd6ea?raw)