​
Prerequisites

  • Have a Heex CLI
  • Have an API_KEY. Should be accessible in your personnal space on the heex cloud platform. If you already logged-in you don’t need to add the Api-Key in your command line.

​
Usage

SubcommandDescription
getRetrieve recording with a given ID.
listList all recordings available on the cloud, with filters …
downloadDownload all recordings available on the cloud, with filters …
deleteDelete a recording with a given ID.
Usage: 
./heex recordings SUBCOMMAND [--help]

​
How to get recordings

There are 2 possibilities to get recordings: Download in a given folder or provide a list of recordings (list). This command allows you to retrieve recordings based on event IDs or recording IDs. Note that all filters are optional, if no filters are provided, it will return a list of all available recordings (json format) or it will download all available recordings. The flags that are available to achieve these commands are the following:
  • --api-key: Add your user API_KEY which can be found on the cloud [required]. No need to provide if you have an active userconfig.
  • --event-id: Filter on a specific event IDs. Multiple can be given: --event-id ID1 --event-id ID2 ...
  • --recording-id: Filter on specific recording IDs. Multiple can be given: --recording-id ID1 --recording-id ID2 ...
  • --max-number: The maximum number of recordings to list. If not provided, it will display all available results.
  • --output-folder: (Only for download) If provided, all listed recordings shall be downloaded into the provided folder path. If not provided, a ‘recordings’ folder shall be created next to the CLI location.
  • --output-file: (Only for list) The result will be saved into this provided filepath. The output format is json, so please provide a filepath with that format: /path/to/file.json
  • --json-output: Disables all logging (except errors), and your command shall only output the result in a json format. Not compatible with ‘—output-file’ option.
Usage: 
./heex recordings download --event-id <EVENT_ID> --output-folder /path/to/recordings

./heex recordings list --event-id <EVENT_ID> --output-file allRecodingsForThisEvent.json

​
How to get a specific recording

This command allows you to retrieve a recording with a given ID. Note that the recording ID is mandatory. You can save output in a json file by using the --output-file option. Available options:
  • --api-key: Add your user API_KEY which can be found on the cloud [required]. No need to provide if you have an active userconfig.
  • --recording-id: ID of the involved recording [required].
  • --output-file: The result will be saved into this provided filepath. The output format is json, so please provide a filepath with that format: /path/to/file.json
  • --json-output: Disables all logging (except errors), and your command shall only output the result in a json format. Not compatible with ‘—output-file’ option.
Usage: 
./heex recording get --recording-id <RECORDING_ID> --output-file RecordingDetailsID.json

​
How to delete a recording

To be able to delete a recording you need to provide an recording-id and use the command below. Available options:
  • --api-key: Add your user API_KEY which can be found on the cloud [required]. No need to provide if you have an active userconfig.
  • --recording-id: ID of the involved recording [required].
Usage: 
./heex recordings delete --recording-id <RECORDING_ID>

​
Getting Help

./heex recordings --help
./heex recordings get --help
./heex recordings list --help
./heex recordings download --help
./heex recordings delete --help