Settings
Per-user view preferences and snapshot configuration, plus the Dataset's query parameters. Settings are stored per user per Dataset: two people viewing the same Dataset each keep their own.
GET /api/datasets/{id}/settings
Get your settings for a Dataset.
Authentication: Required
Path Parameters:
| Parameter | Type | Description |
|---|---|---|
id | string | Dataset UUID or ownerId:slug natural id |
Get my settings for a DatasetGET /api/datasets/admin:northwind-orders/settings
Settings are per user per Dataset. Answers {} when you have never saved any.
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/settings"
},
"inf:restore": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/settings/_restore"
}
},
"id": "00000000-0000-4000-8000-000000000001",
"datasetId": "00000000-0000-4000-8000-000000000002",
"reportId": null,
"queryId": null,
"templateId": null,
"userId": "admin",
"settings": {
"grid": {
"sortBy": [
{
"dir": "desc",
"field": "OrderDate"
}
],
"pageSize": 50
}
},
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"tenant": "acme",
"snapshots": {
"tenant": "acme",
"id": "00000000-0000-4000-8000-000000000003",
"type": "n",
"includeLatest": true,
"n": 3,
"userSettingsId": "00000000-0000-4000-8000-000000000001",
"jobDatasetId": null,
"assistantDatasetId": null,
"reportDatasetId": null,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"snapshotDatasets": []
}
}
Key Fields:
| Field | Description |
|---|---|
settings | Free-form object owned by the client. The Informer web client stores grid layout here (grid.columns, grid.pageSize, grid.sortBy, …); the server does not validate or interpret it |
snapshots | Your snapshot view configuration (see PUT below) |
userId / datasetId | Who and what the settings row belongs to |
When you have never saved settings for the Dataset, the response is an empty
resource (only _links).
PUT /api/datasets/{id}/settings
Save your settings and snapshot configuration. The settings object is
replaced wholesale, not merged.
Authentication: Required
Request Body:
| Field | Type | Description |
|---|---|---|
settings | object | Free-form view preferences; replaces the stored value |
snapshots | object | Snapshot view configuration; omit to leave it unchanged |
Snapshot Configuration (snapshots):
| Property | Type | Description |
|---|---|---|
includeLatest | boolean | Include the live data alongside snapshots (default true) |
type | string | null (no snapshots), "n" (latest n snapshots), or "ids" (specific snapshots) |
n | integer | How many snapshots to include when type is "n" (min 1) |
snapshotDatasets | array | Snapshot Dataset ids to include when type is "ids" |
Save my view settingsPUT /api/datasets/admin:northwind-orders/settings
settings is a free-form object owned by the client (grid layout, sort, page size). snapshots configures which snapshots appear in the data view; type 'n' shows the latest n.
Request body
{
"settings": {
"grid": {
"pageSize": 50,
"sortBy": [
{
"field": "OrderDate",
"dir": "desc"
}
]
}
},
"snapshots": {
"includeLatest": true,
"type": "n",
"n": 3
}
}
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/settings"
},
"inf:restore": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/settings/_restore"
}
},
"id": "00000000-0000-4000-8000-000000000001",
"datasetId": "00000000-0000-4000-8000-000000000002",
"reportId": null,
"queryId": null,
"templateId": null,
"userId": "admin",
"settings": {
"grid": {
"sortBy": [
{
"dir": "desc",
"field": "OrderDate"
}
],
"pageSize": 50
}
},
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"tenant": "acme",
"dataset": {
"naturalId": "admin:northwind-orders",
"permissions": {
"edit": true,
"share": true,
"delete": true,
"write": true,
"addVisual": true,
"deleteVisual": true,
"changeOwner": true,
"copy": true,
"rename": true,
"refresh": true,
"modifyFlows": true,
"replaceFile": true,
"modifySettings": true,
"createDataView": true,
"assignTags": true,
"createFilter": true,
"scriptFields": true,
"setIndex": false
},
"id": "00000000-0000-4000-8000-000000000002",
"tenant": "acme",
"ownerId": "admin",
"slug": "northwind-orders",
"name": "Northwind Orders",
"description": "A dataset consisting of all orders in the northwind system (public schema)",
"embedded": false,
"esIndex": "docsex.acme.northwind-orders.1700000000000",
"esIndexName": "northwind-orders",
"esType": "data",
"records": 2155,
"size": "524288",
"source": "northwind-datasets",
"sourceId": null,
"params": {},
"dataUpdatedAt": "2026-01-15T16:20:00.000Z",
"dataExpiresAt": null,
"ttl": null,
"append": false,
"shared": false,
"timestampField": null,
"lastDurationMillis": "1500",
"windowSize": 500,
"settings": {},
"flow": [],
"esId": null,
"lastQueriedAt": "2026-01-15T16:20:00.000Z",
"esWorkers": 1,
"datasetFieldReportAccess": false,
"parentId": null,
"templateProcessorId": null,
"deleteDate": null,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"datasourceId": null,
"reportId": null,
"queryId": "00000000-0000-4000-8000-000000000003",
"editingId": null,
"folderId": null
},
"snapshots": {
"tenant": "acme",
"id": "00000000-0000-4000-8000-000000000004",
"type": "n",
"includeLatest": true,
"n": 3,
"userSettingsId": "00000000-0000-4000-8000-000000000001",
"jobDatasetId": null,
"assistantDatasetId": null,
"reportDatasetId": null,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"snapshotDatasets": []
}
}
Response:
The full saved settings row, including the resolved snapshots object.
POST /api/datasets/{id}/settings/_restore
Delete your settings row for this Dataset, restoring the default view.
Authentication: Required
Restore default settingsPOST /api/datasets/admin:northwind-orders/settings/_restore
Deletes your saved settings row. Responds 200 with an empty body.
Response · 200 · no body
Behavior:
- Removes your saved settings and snapshot configuration for this Dataset
- Responds
200with an empty body - A subsequent GET answers the empty resource again
GET /api/datasets/{id}/params
Get the Dataset's query parameters.
Authentication: Required
Get Dataset parametersGET /api/datasets/00000000-0000-4000-8000-000000000001/params
Response · 200
[
{
"name": "category",
"dataType": "string",
"defaultValue": "Beverages"
}
]
Answers {} when the Dataset has no parameters.
PUT /api/datasets/{id}/params
Set the Dataset's query parameters. Unlike view settings, parameters belong to the Dataset itself and require write permission.
Authentication: Required
Permission: dataset:write (Data Wizard or above on the owning team)
Request Body:
The entire payload is stored as the params value verbatim; the server does
not validate its shape. By convention parameters are an array of
{ name, dataType, defaultValue, … } definitions referenced by the query.
Set Dataset parametersPUT /api/datasets/00000000-0000-4000-8000-000000000001/params
The whole payload becomes the params value verbatim; the response is the stored value, not the Dataset.
Request body
[
{
"name": "category",
"dataType": "string",
"defaultValue": "Beverages"
}
]
Response · 200
[
{
"name": "category",
"dataType": "string",
"defaultValue": "Beverages"
}
]
Response:
The stored params value (not the full Dataset).
Settings vs. Parameters
settings are your personal view preferences and never affect other users.
params configure the Dataset's query and affect everyone, which is why they
need write permission.