Cloudharness Dev Portal
CloudCron Schedule Next API

Reports

Endpoint:https://api.cloudharness.com

Generate/Fetch a report

GET
https://api.cloudharness.com
/v1/reports/{report_name}

Generates a report based on the specified report name. This endpoint may make multiple internal API calls and perform data collation. Reports may take time to generate and could be processed asynchronously.

Generate/Fetch a report › path Parameters

  • report_namestring · required

    Name identifying the type of report to generate

Generate/Fetch a report › query Parameters

  • start_datestring · date

    Start date for the report period (ISO 8601 format)

  • end_datestring · date

    End date for the report period (ISO 8601 format)

  • formatstring · enum

    Output format for the report (defaults to JSON)

    Enum values:
    json
    csv
    xlsx
    Default: json

Generate/Fetch a report › Headers

  • Authorizationstring · required

    The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Generate/Fetch a report › Responses

Report generated successfully

  • successboolean · required
  • metadataobject · required
  • statusstring · required

    Descriptive status message

  • dataobject
ParseGenerate