GET
/
v1
/
report
/
schedule
/
{reportScheduleId}
/
download
/
cURL
curl --request GET \
  --url https://api.covalenthq.com/v1/report/schedule/{reportScheduleId}/download/ \
  --header 'Authorization: Bearer <token>'
"<string>"

Credit Cost

0 per call

Processing

Realtime

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form: Bearer <token>, where <token> is your GoldRush API Key.

Path Parameters

​
reportScheduleId
string
required

The ID of the report schedule.

Query Parameters

​
days
integer

Either 30 (default) or 60. Ignored if time-period param is provided.

​
time-period
string

Either month_to_date or year_to_date.

​
frequency
string

Either hourly (default) or daily.

Response

200 - application/json

Successful response

The response is of type string.