GET
/
v1
/
report
/
schedule
/
{reportScheduleId}
/
cURL
curl --request GET \
  --url https://api.covalenthq.com/v1/report/schedule/{reportScheduleId}/ \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "label": "<string>",
    "description": "<string>",
    "config": [
      {
        "tags": [
          "<string>"
        ],
        "tokens": [
          {
            "symbol": "<string>",
            "address": "<string>",
            "decimals": 123
          }
        ],
        "chain_id": "<string>"
      }
    ],
    "report_type": "<string>",
    "frequency": "<string>",
    "utc_offset": 123,
    "version": 123,
    "webhook_url": "<string>",
    "recipient_emails": [
      "<string>"
    ],
    "wallets": [
      "<string>"
    ],
    "state": "<string>",
    "email_frequency": "<string>",
    "created_by": {
      "id": "<string>",
      "email": "<string>",
      "display_name": "<string>",
      "full_name": "<string>"
    },
    "group": {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "is_paid": true,
      "is_over_limit": true,
      "is_reseller_user_group": true,
      "is_free_trial_expired": true,
      "has_trackable_usage": true
    },
    "latest_report_run": {
      "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"
    },
    "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 to retrieve.

Response

200 - application/json

Successful response

The response is of type object.