POST companies/{companyId}/reports/{reportId}/runreport

Executes a particular report and returns the results

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}/runreport

Request Information

URI Parameters

NameDescriptionTypeAdditional 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
NameDescriptionTypeAdditional information
Parameters

ReportRequestParameters

None.

Request Formats

application/json, text/json

Sample: 
{
  "Parameters": {
    "DateRange": {
      "StartDate": "2025-05-28T23:18:52.3933587+00:00",
      "EndDate": "2025-05-28T23:18:52.3933587+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

Sample: 
{}