Admin data scanner

Changed on

Creates a job to export data scan results to CSV. The exported file includes scan name, workspace, database, table, field, row ID, matched value, and timestamps for each result. Enterprise feature.

post/api/admin/data-scanner/results/export/

Request

  • Base URL
    https://api.baserow.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.baserow.io/api/admin/data-scanner/results/export/
  • Auth
    HTTP bearer

Request body

urlstring uri required
export_charset'utf-8' | 'iso-8859-6' | 'windows-1256' | 'iso-8859-4' | 'windows-1257' | 'iso-8859-14' | 'iso-8859-2' | 'windows-1250' | 'gbk' | 'gb18030' | 'big5' | 'koi8-r' | 'koi8-u' | 'iso-8859-5' | 'windows-1251' | 'x-mac-cyrillic' | 'iso-8859-7' | 'windows-1253' | 'iso-8859-8' | 'windows-1255' | 'euc-jp' | 'iso-2022-jp' | 'shift-jis' | 'euc-kr' | 'macintosh' | 'iso-8859-10' | 'iso-8859-16' | 'windows-874' | 'windows-1254' | 'windows-1258' | 'iso-8859-1' | 'windows-1252' | 'iso-8859-3'
  • utf-8 - utf-8
  • iso-8859-6 - iso-8859-6
  • windows-1256 - windows-1256
  • iso-8859-4 - iso-8859-4
  • windows-1257 - windows-1257
  • iso-8859-14 - iso-8859-14
  • iso-8859-2 - iso-8859-2
  • windows-1250 - windows-1250
  • gbk - gbk
  • gb18030 - gb18030
  • big5 - big5
  • koi8-r - koi8-r
  • koi8-u - koi8-u
  • iso-8859-5 - iso-8859-5
  • windows-1251 - windows-1251
  • x-mac-cyrillic - mac-cyrillic
  • iso-8859-7 - iso-8859-7
  • windows-1253 - windows-1253
  • iso-8859-8 - iso-8859-8
  • windows-1255 - windows-1255
  • euc-jp - euc-jp
  • iso-2022-jp - iso-2022-jp
  • shift-jis - shift-jis
  • euc-kr - euc-kr
  • macintosh - macintosh
  • iso-8859-10 - iso-8859-10
  • iso-8859-16 - iso-8859-16
  • windows-874 - cp874
  • windows-1254 - windows-1254
  • windows-1258 - windows-1258
  • iso-8859-1 - iso-8859-1
  • windows-1252 - windows-1252
  • iso-8859-3 - iso-8859-3
csv_column_separator',' | ';' | '|' | 'tab' | 'record_separator' | 'unit_separator'
  • , - ,
  • ; - ;
  • | - |
  • tab -
  • record_separator - 
  • unit_separator - 
csv_first_row_headerboolean

Whether or not to generate a header row at the top of the csv file.

filter_scan_idinteger

Optional: Filter results by scan ID.

Response

urlstring uri required

The URL to download the exported file.

export_charset'utf-8' | 'iso-8859-6' | 'windows-1256' | 'iso-8859-4' | 'windows-1257' | 'iso-8859-14' | 'iso-8859-2' | 'windows-1250' | 'gbk' | 'gb18030' | 'big5' | 'koi8-r' | 'koi8-u' | 'iso-8859-5' | 'windows-1251' | 'x-mac-cyrillic' | 'iso-8859-7' | 'windows-1253' | 'iso-8859-8' | 'windows-1255' | 'euc-jp' | 'iso-2022-jp' | 'shift-jis' | 'euc-kr' | 'macintosh' | 'iso-8859-10' | 'iso-8859-16' | 'windows-874' | 'windows-1254' | 'windows-1258' | 'iso-8859-1' | 'windows-1252' | 'iso-8859-3'
  • utf-8 - utf-8
  • iso-8859-6 - iso-8859-6
  • windows-1256 - windows-1256
  • iso-8859-4 - iso-8859-4
  • windows-1257 - windows-1257
  • iso-8859-14 - iso-8859-14
  • iso-8859-2 - iso-8859-2
  • windows-1250 - windows-1250
  • gbk - gbk
  • gb18030 - gb18030
  • big5 - big5
  • koi8-r - koi8-r
  • koi8-u - koi8-u
  • iso-8859-5 - iso-8859-5
  • windows-1251 - windows-1251
  • x-mac-cyrillic - mac-cyrillic
  • iso-8859-7 - iso-8859-7
  • windows-1253 - windows-1253
  • iso-8859-8 - iso-8859-8
  • windows-1255 - windows-1255
  • euc-jp - euc-jp
  • iso-2022-jp - iso-2022-jp
  • shift-jis - shift-jis
  • euc-kr - euc-kr
  • macintosh - macintosh
  • iso-8859-10 - iso-8859-10
  • iso-8859-16 - iso-8859-16
  • windows-874 - cp874
  • windows-1254 - windows-1254
  • windows-1258 - windows-1258
  • iso-8859-1 - iso-8859-1
  • windows-1252 - windows-1252
  • iso-8859-3 - iso-8859-3
csv_column_separator',' | ';' | '|' | 'tab' | 'record_separator' | 'unit_separator'
  • , - ,
  • ; - ;
  • | - |
  • tab -
  • record_separator - 
  • unit_separator - 
csv_first_row_headerboolean

Whether or not to generate a header row at the top of the csv file.

filter_scan_idinteger

Optional: Filter results by scan ID.

created_onstring date-time required

The date and time when the export job was created.

exported_file_namestring required

The name of the file that was created by the export job.

Changes