POST
/
v1
/
report
/
schedule
/
{reportScheduleId}
/
run
/
cURL
curl --request POST \
  --url https://api.covalenthq.com/v1/report/schedule/{reportScheduleId}/run/ \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "status": "<string>",
    "run_type": "<string>",
    "trigger_type": "<string>",
    "download_url": "<string>",
    "completed_at": "2023-11-07T05:31:56Z",
    "failed_at": "2023-11-07T05:31:56Z",
    "error_message": "<string>",
    "hash": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

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.

Response

200 - application/json

Successful response

The response is of type object.