Reporting
For a deeper dive into Cova Reporting APIs, see Cova Reporting API guide

Base URL: https://api.covasoft.net/reporting
Endpoints
| Endpoint | Description |
|---|---|
GET companies/{companyId}/reports | Returns all available reports for a Company |
GET companies/{companyId}/reports/{reportId} | Returns the details of a specific report |
POST companies/{companyId}/reports/{reportId}/runreport | Executes a particular report and returns the results |
GET companies/{companyId}/reports
Returns all available reports for a Company
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
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| companyId | The unique Company Id that was provided in your onboarding pacakage | integer | Required |
Body Parameters
None.
Response Information
Resource Description
All reports for a Company
Collection of 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
[
{
"Id": "37cbb8f1-41b6-4b6d-8004-87979783aa1d",
"Name": "sample string 2",
"Description": "sample string 3",
"CreatedDateUtc": "2026-10-02T17:43:51.4499539+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"
}
]
},
{
"Id": "37cbb8f1-41b6-4b6d-8004-87979783aa1d",
"Name": "sample string 2",
"Description": "sample string 3",
"CreatedDateUtc": "2026-10-02T17:43:51.4499539+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"
}
]
}
]
Models
ReportParameter
| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | The name of the parameter. | string | None. |
| Required | Whether or not it is required that the parameter be supplied. | boolean | None. |
| Label | string | None. | |
| Options | Values to display in the parameter. | Collection of ParameterOption | None. |
| Multiple | Indicates whether or not selecting multiple values is allowed for the parameter. | boolean | None. |
| DataType | The type of the parameter as defined by the reporting service. | string | None. |
ParameterOption
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | Object | None. | |
| Label | string | None. |
GET companies/{companyId}/reports/{reportId}
Returns the details of a specific report
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
{
"Id": "f98d6ed2-4d25-4a2a-b90b-fd9a0c42f7f0",
"Name": "sample string 2",
"Description": "sample string 3",
"CreatedDateUtc": "2026-10-02T17:43:53.8461744+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"
}
]
}
Models
ReportParameter
| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | The name of the parameter. | string | None. |
| Required | Whether or not it is required that the parameter be supplied. | boolean | None. |
| Label | string | None. | |
| Options | Values to display in the parameter. | Collection of ParameterOption | None. |
| Multiple | Indicates whether or not selecting multiple values is allowed for the parameter. | boolean | None. |
| DataType | The type of the parameter as defined by the reporting service. | string | None. |
ParameterOption
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | Object | None. | |
| Label | string | None. |
POST companies/{companyId}/reports/{reportId}/runreport
Executes a particular report and returns the results
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}/runreport
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
Report request with required parameters
ReportRequest
| Name | Description | Type | Additional information |
|---|---|---|---|
| Parameters | ReportRequestParameters | None. |
Request Formats
application/json, text/json
{
"Parameters": {
"DateRange": {
"StartDate": "2026-10-02T17:43:56.3461958+00:00",
"EndDate": "2026-10-02T17:43:56.3461958+00:00",
"DateRangeType": 3
},
"Parameter1": "sample string 1",
"Parameter2": "sample string 2",
"ParameterN": "sample string 3"
}
}
Response Information
Resource Description
All reports for a Company
Object
None.
Response Formats
application/json, text/json
{}
Models
ReportRequestParameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| DateRange | ReportDateRange | None. | |
| Parameter1 | Additional parameters as defined by the report. | string | None. |
| Parameter2 | string | None. | |
| ParameterN | string | None. |
ReportDateRange
| Name | Description | Type | Additional information |
|---|---|---|---|
| StartDate | date | None. | |
| EndDate | date | None. | |
| DateRangeType | integer | None. |