XExentral
Reporting Settings

Update reporting settings

Updates the current settings

patch/api/v1/analytics/settings

Request

Request body

delimiterstring required

The delimiter character used for CSV or TXT exports

escapeSpecialCharactersboolean required

Whether to escape special characters in TXT exports (e.g. quotes, newlines)

disableQuotesboolean required

Whether to disable enclosing all values with double quotes in TXT exports. This is useful for handling special characters or values that contain the delimiter character. It's problematic if values contain double quotes themselves.

exportFormat'csv' | 'xlsx' | 'json' | 'txt' | 'parquet' | 'pdf' required

Export format for reports

numberFormattingMode'raw' | 'locale' required

Number formatting mode that should be applied when visualizing numbers (does not affect exports)

Example request

{
  "delimiter": ",",
  "escapeSpecialCharacters": true,
  "exportFormat": "txt",
  "numberFormattingMode": "raw"
}

Response

Operation completed successfully, no response body

Changes

No recorded changes to this operation across all 2 revisions of this API.