GET companies/{companyId}/reports/{reportId}

Returns the details of a specific report

Information:

The Cova Reporting API guide contains critical information regarding parameter processing.

Base URL:

https://api.covasoft.net/reporting

Example of a call would be:

https://api.covasoft.net/reporting/companies/{companyId})/reports/{reportId}

Request Information

URI Parameters

Name	Description	Type	Additional information
companyId	The unique Company Id that was provided in your onboarding pacakage	integer	Required
reportId	The report Identifier	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

the requested report

ReportDefinition

Name	Description	Type	Additional information
Id	The unique identifier of the report.	globally unique identifier	None.
Name	The name of the report.	string	None.
Description	Description of the report.	string	None.
CreatedDateUtc	The UTC date that the report was created. This attribute is readonly and will be ignored if provided on POST and PUT.	date	None.
Category	Used to group reports into categories.	string	None.
Parameters	Parameters that can be specified for this report.	Collection of ReportParameter	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "875b3ac0-5a63-4f77-8b71-276d0c629e0a",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "CreatedDateUtc": "2025-06-10T09:03:10.7018764+00:00",
  "Category": "sample string 5",
  "Parameters": [
    {
      "Name": "sample string 1",
      "Required": true,
      "Label": "sample string 3",
      "Options": [
        {
          "Id": {},
          "Label": "sample string 2"
        },
        {
          "Id": {},
          "Label": "sample string 2"
        }
      ],
      "Multiple": true,
      "DataType": "sample string 5"
    },
    {
      "Name": "sample string 1",
      "Required": true,
      "Label": "sample string 3",
      "Options": [
        {
          "Id": {},
          "Label": "sample string 2"
        },
        {
          "Id": {},
          "Label": "sample string 2"
        }
      ],
      "Multiple": true,
      "DataType": "sample string 5"
    }
  ]
}