Avena Webapp API - v0.0.1
    Preparing search index...

    Interface ExportRequestPayload

    Export request fields supplied by the caller.

    downloadExportViaNats sends these as JSON with format forced to csv and an ack_subject added.

    interface ExportRequestPayload {
        asset: number;
        box_id?: string;
        channels: number[];
        download_name?: string;
        end: string;
        filters?: ChannelFilterMap;
        format?: "csv";
        start: string;
    }
    Index

    Properties

    asset box_id? channels download_name? end filters? format? start

    Properties

    asset: number

    Asset number; selects the asset<NNN> directory in the edge box's Parquet archive.

    box_id?: string

    Box identifier kept for compatibility with older request shapes. The exporter does not read it; the box is chosen by the request subject.

    channels: number[]

    LabJack channel numbers to export. The exporter sorts them and removes duplicates.

    download_name?: string

    File name the exporter reports in its meta frame. Also used locally when no meta frame arrives. The exporter's default is labjack_asset<NNN>_<start>_<end>.csv.

    end: string

    End of the range, RFC 3339. Inclusive; must not be before start.

    filters?: ChannelFilterMap

    Noise filters per channel, copied from the config's sensor_settings.filters. When set, the CSV gets a filtered_value column (see docs/src/reference/export-protocol.md).

    format?: "csv"

    Export format. Ignored here: downloadExportViaNats always sends csv.

    start: string

    Start of the range, RFC 3339. Inclusive.

    Settings

    Member Visibility

    On This Page

    Properties