account

Download one export part

Downloads one part of a full data export. Results are paged with a cursor rather than an offset, so rows are not skipped or duplicated if data changes while the export is running. Secret values are replaced with a marker rather than removed, so a withheld value can be told apart from one that was never set. Pass ?format=csv to receive the same data as CSV, encoded with a UTF-8 byte-order mark for compatibility with Excel and guarded against spreadsheet formula injection. Use the x-brix-next-cursor response header to fetch the next page.

Notes.

  • Credentials are never exported: their columns are kept with null or a [secret; not exported] / [encrypted; not exported] marker (the manifest lists them in redactedColumns).
  • ?format=csv answers text/csv instead, with the cursor in the X-Brix-Next-Cursor header.
get/v1/account/export/part/{part}

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/account/export/part/{part}
  • Auth: HTTP bearer

Path parameters

partstring required

A part from the manifest (a table name).

Query parameters

cursorstring

nextCursor of the previous page.

Response

Success.

dataobject[] required

Rows of the table, all columns (withheld ones marked).

nextCursorstring nullable required

Null on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.