Copy & Snapshots
Duplicate a Dataset, and keep point-in-time snapshots of its data. A snapshot
is itself a Dataset whose parentId points at the original; snapshots appear
in searches according to each user's snapshot settings.
POST /api/datasets/{id}/copy
Copy a Dataset. The query definition and fields always copy; query-string flags opt into more.
Authentication: Required
Permission: dataset:copy (delegates to dataset:write: Data Wizard or
above on the owning team)
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
data | boolean | Copy the indexed data (requires the source to have an index; otherwise 422) |
visuals | boolean | Copy visuals |
filters | boolean | Copy saved filters |
sharing | boolean | Copy shares; only honored when you may share the original, and shares pointing at filters that were not copied are skipped |
Request Body:
| Field | Type | Description |
|---|---|---|
name | string | Name for the copy |
progress | string | Progress channel id |
Response: 201 Created with a Location header. The copy is owned by
the calling user.
Copy a DatasetPOST /api/datasets/admin:northwind-orders/copy?data=true&filters=true
The query and fields always copy. Query flags opt into data, visuals, filters, and sharing; sharing only copies when you may share the original, and shares whose filter was not copied are skipped. The copy lands owned by you.
Request body
{
"name": "Northwind Orders Copy"
}
Response · 201
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy"
},
"inf:draft": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/draft"
},
"inf:run": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/_run"
},
"inf:benchmark": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/_benchmark"
},
"inf:refresh": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/_refresh"
},
"inf:data": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/data{?start,limit,q,sort,show,report}",
"templated": true
},
"inf:user-settings": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/settings"
},
"inf:query": {
"href": "https://informer.example.com/api/queries/00000000-0000-4000-8000-000000000001"
},
"inf:owner": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/owner"
},
"inf:search": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/_search{?query,_source,sort,from,size,searchType,aggs,report,aggregations,alias,snapshots}",
"templated": true
},
"inf:mapping": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/mapping"
},
"inf:job-templates": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000002/job-templates"
},
"inf:fields": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/fields"
},
"inf:count": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/count"
},
"inf:comments": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/comments"
},
"inf:visuals": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/visuals"
},
"inf:visual-templates": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/visual-templates"
},
"inf:dataset-tags": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/tags"
},
"inf:dataset-tag": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/tags/{tagId}",
"templated": true
},
"inf:discover": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000002/discover"
},
"inf:filters": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/filters"
},
"inf:dataset-shares": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/shares"
},
"inf:flow": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/flow"
},
"inf:group": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/group"
},
"inf:group-rows": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/group-rows"
},
"inf:dataset-share": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/shares/{principalId}",
"templated": true
},
"inf:import": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/_import"
},
"inf:exceptions": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/_exceptions"
},
"inf:search-aggregates": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/_search-aggregates"
},
"inf:exporters": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/exporters"
},
"inf:favorite": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/favorite"
},
"inf:export-bundle": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders-copy/_export"
},
"edit": {
"href": "https://informer.example.com/api/reports/admin%3Anorthwind-orders-copy/_edit"
}
},
"naturalId": "admin:northwind-orders-copy",
"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-copy",
"name": "Northwind Orders Copy",
"description": "A dataset consisting of all orders in the northwind system (public schema)",
"embedded": false,
"esIndex": "docsex.acme.northwind-orders-copy.1700000000000",
"esIndexName": "northwind-orders-copy",
"esType": "data",
"records": 2155,
"size": "524288",
"source": null,
"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": null,
"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-000000000001",
"editingId": null,
"folderId": null
}
POST /api/datasets/{id}/snapshots
Take a snapshot: copies the live index into a child Dataset owned by the parent's owner.
Authentication: Required
Permission: dataset:copy (Data Wizard or above on the owning team)
Request Body:
| Field | Type | Description |
|---|---|---|
name | string | Snapshot name |
description | string | Description |
progress | string | Progress channel id |
Response: 201 Created. A Dataset without an index answers 422
(refresh first).
Take a snapshotPOST /api/datasets/admin:northwind-orders/snapshots
Copies the live index into a child Dataset owned by the parent's owner. The first snapshot also adds the reserved _snapshots script field to the parent.
Request body
{
"name": "February month end",
"description": "Before the March load"
}
Response · 201
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end"
},
"inf:draft": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/draft"
},
"inf:run": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_run"
},
"inf:benchmark": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_benchmark"
},
"inf:refresh": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_refresh"
},
"inf:data": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/data{?start,limit,q,sort,show,report}",
"templated": true
},
"inf:user-settings": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/settings"
},
"inf:query": {
"href": "https://informer.example.com/api/queries/"
},
"inf:owner": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/owner"
},
"inf:search": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_search{?query,_source,sort,from,size,searchType,aggs,report,aggregations,alias,snapshots}",
"templated": true
},
"inf:mapping": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/mapping"
},
"inf:job-templates": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000001/job-templates"
},
"inf:fields": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/fields"
},
"inf:count": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/count"
},
"inf:comments": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/comments"
},
"inf:visuals": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/visuals"
},
"inf:visual-templates": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/visual-templates"
},
"inf:dataset-tags": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/tags"
},
"inf:dataset-tag": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/tags/{tagId}",
"templated": true
},
"inf:discover": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000001/discover"
},
"inf:filters": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/filters"
},
"inf:dataset-shares": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/shares"
},
"inf:flow": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/flow"
},
"inf:group": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/group"
},
"inf:group-rows": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/group-rows"
},
"inf:dataset-share": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/shares/{principalId}",
"templated": true
},
"inf:import": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_import"
},
"inf:exceptions": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_exceptions"
},
"inf:search-aggregates": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_search-aggregates"
},
"inf:exporters": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/exporters"
},
"inf:favorite": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/favorite"
},
"inf:export-bundle": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_export"
},
"edit": {
"href": "https://informer.example.com/api/reports/admin%3Afebruary-month-end/_edit"
}
},
"naturalId": "admin:february-month-end",
"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-000000000001",
"tenant": "acme",
"embedded": false,
"esType": "data",
"params": {},
"append": false,
"shared": false,
"timestampField": null,
"lastDurationMillis": "1500",
"windowSize": 500,
"settings": {},
"lastQueriedAt": null,
"esWorkers": 1,
"datasetFieldReportAccess": false,
"templateProcessorId": null,
"name": "February month end",
"description": "Before the March load",
"parentId": "00000000-0000-4000-8000-000000000002",
"ownerId": "admin",
"records": 2155,
"dataUpdatedAt": "2026-01-15T16:20:00.000Z",
"size": "524288",
"updatedAt": "2026-01-15T16:20:00.000Z",
"createdAt": "2026-01-15T16:20:00.000Z",
"slug": "february-month-end",
"esIndex": "docsex.acme.february-month-end.snapshot.1700000000000",
"source": null,
"sourceId": null,
"flow": [],
"ttl": null,
"dataExpiresAt": null,
"_altid": null,
"datasourceId": null,
"reportId": null,
"queryId": null,
"editingId": null,
"folderId": null,
"esId": null,
"esIndexName": "february-month-end",
"deleteDate": null
}
The first snapshot also adds the reserved _snapshots script field to the
parent, which labels each row's snapshot in combined views.
GET /api/datasets/{id}/snapshot-list
List the Dataset's snapshots: a plain array with live record counts and index sizes.
Authentication: Required
List snapshotsGET /api/datasets/admin:northwind-orders/snapshot-list
A plain array with live record counts and index sizes.
Response · 200
[
{
"id": "00000000-0000-4000-8000-000000000001",
"name": "February month end",
"createdAt": "2026-01-15T16:20:00.000Z",
"parent": "00000000-0000-4000-8000-000000000002",
"records": 2155,
"index": "docsex.acme.february-month-end.snapshot.1700000000000",
"type": "data",
"size": 524288,
"description": "Before the March load",
"dataUpdatedAt": "2026-01-15T16:20:00.000Z",
"parentId": "00000000-0000-4000-8000-000000000002"
}
]
GET /api/datasets/{id}/snapshots/{snapshotId}
Get one snapshot (a full Dataset resource).
Authentication: Required
Get a snapshotGET /api/datasets/admin:northwind-orders/snapshots/00000000-0000-4000-8000-000000000001
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001"
},
"inf:draft": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/draft"
},
"inf:run": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_run"
},
"inf:benchmark": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_benchmark"
},
"inf:refresh": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_refresh"
},
"inf:data": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/data{?start,limit,q,sort,show,report}",
"templated": true
},
"inf:user-settings": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/settings"
},
"inf:query": {
"href": "https://informer.example.com/api/queries/"
},
"inf:owner": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/owner"
},
"inf:search": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_search{?query,_source,sort,from,size,searchType,aggs,report,aggregations,alias,snapshots}",
"templated": true
},
"inf:mapping": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/mapping"
},
"inf:job-templates": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000001/job-templates"
},
"inf:fields": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/fields"
},
"inf:count": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/count"
},
"inf:comments": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/comments"
},
"inf:visuals": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/visuals"
},
"inf:visual-templates": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/visual-templates"
},
"inf:dataset-tags": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/tags"
},
"inf:dataset-tag": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/tags/{tagId}",
"templated": true
},
"inf:discover": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000001/discover"
},
"inf:filters": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/filters"
},
"inf:dataset-shares": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/shares"
},
"inf:flow": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/flow"
},
"inf:group": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/group"
},
"inf:group-rows": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/group-rows"
},
"inf:dataset-share": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/shares/{principalId}",
"templated": true
},
"inf:import": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/_import"
},
"inf:exceptions": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/_exceptions"
},
"inf:search-aggregates": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/_search-aggregates"
},
"inf:exporters": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/exporters"
},
"inf:favorite": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/favorite"
},
"inf:export-bundle": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/_export"
},
"edit": {
"href": "https://informer.example.com/api/reports/admin%3Afebruary-month-end/_edit"
}
},
"naturalId": "admin:february-month-end",
"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-000000000001",
"tenant": "acme",
"ownerId": "admin",
"slug": "february-month-end",
"name": "February month end",
"description": "Before the March load",
"embedded": false,
"esIndex": "docsex.acme.february-month-end.snapshot.1700000000000",
"esIndexName": "february-month-end",
"esType": "data",
"records": 2155,
"size": "524288",
"source": null,
"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": null,
"esWorkers": 1,
"datasetFieldReportAccess": false,
"parentId": "00000000-0000-4000-8000-000000000002",
"templateProcessorId": null,
"deleteDate": null,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"datasourceId": null,
"reportId": null,
"queryId": null,
"editingId": null,
"folderId": null,
"query": null,
"fields": [],
"filters": []
}
PUT /api/datasets/{id}/snapshots/{snapshotId}
Rename a snapshot. Only name and description are accepted; other keys are
stripped.
Authentication: Required
Permission: dataset:write on the parent
Rename a snapshotPUT /api/datasets/admin:northwind-orders/snapshots/00000000-0000-4000-8000-000000000001
Only name and description are accepted; other keys are stripped.
Request body
{
"name": "February month end",
"description": "Verified against the GL"
}
Response · 200
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001"
},
"inf:draft": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/draft"
},
"inf:run": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_run"
},
"inf:benchmark": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_benchmark"
},
"inf:refresh": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_refresh"
},
"inf:data": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/data{?start,limit,q,sort,show,report}",
"templated": true
},
"inf:user-settings": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/settings"
},
"inf:query": {
"href": "https://informer.example.com/api/queries/"
},
"inf:owner": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/owner"
},
"inf:search": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-month-end/_search{?query,_source,sort,from,size,searchType,aggs,report,aggregations,alias,snapshots}",
"templated": true
},
"inf:mapping": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/mapping"
},
"inf:job-templates": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000001/job-templates"
},
"inf:fields": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/fields"
},
"inf:count": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/count"
},
"inf:comments": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/comments"
},
"inf:visuals": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/visuals"
},
"inf:visual-templates": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/visual-templates"
},
"inf:dataset-tags": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/tags"
},
"inf:dataset-tag": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/tags/{tagId}",
"templated": true
},
"inf:discover": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000001/discover"
},
"inf:filters": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/filters"
},
"inf:dataset-shares": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/shares"
},
"inf:flow": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/flow"
},
"inf:group": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/group"
},
"inf:group-rows": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/group-rows"
},
"inf:dataset-share": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/shares/{principalId}",
"templated": true
},
"inf:import": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/_import"
},
"inf:exceptions": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/_exceptions"
},
"inf:search-aggregates": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/_search-aggregates"
},
"inf:exporters": [
{
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/exporters"
},
{
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/exporters"
}
],
"inf:favorite": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/favorite"
},
"inf:export-bundle": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/_export"
},
"edit": {
"href": "https://informer.example.com/api/reports/admin%3Afebruary-month-end/_edit"
},
"inf:permissions": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/permissions"
},
"inf:download": {
"href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/snapshots/00000000-0000-4000-8000-000000000001/_download"
}
},
"naturalId": "admin:february-month-end",
"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-000000000001",
"tenant": "acme",
"ownerId": "admin",
"slug": "february-month-end",
"name": "February month end",
"description": "Verified against the GL",
"embedded": false,
"esIndex": "docsex.acme.february-month-end.snapshot.1700000000000",
"esIndexName": "february-month-end",
"esType": "data",
"records": 2155,
"size": "524288",
"source": null,
"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": null,
"esWorkers": 1,
"datasetFieldReportAccess": false,
"parentId": "00000000-0000-4000-8000-000000000002",
"templateProcessorId": null,
"deleteDate": null,
"createdAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"datasourceId": null,
"reportId": null,
"queryId": null,
"editingId": null,
"folderId": null,
"tags": []
}
DELETE /api/datasets/{id}/snapshots/{snapshotId}
Delete a snapshot and its index.
Authentication: Required
Permission: dataset:write on the parent
Delete a snapshotDELETE /api/datasets/admin:northwind-orders/snapshots/00000000-0000-4000-8000-000000000001
Responds 200 with an empty body.
Response · 200 · no body
Responds 200 with an empty body.
POST /api/datasets/{id}/snapshots/{snapshotId}/promote
Promote a snapshot into a brand-new standalone Dataset (for example to keep a quarter-end archive permanently).
Authentication: Required
Permission: dataset:copy on the parent
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Name for the new Dataset |
description | string | No | Description |
preserveSnapshot | boolean | No | Keep the snapshot; by default it is deleted after promotion |
Response: 201 Created with a Location header.
Promote a snapshot to a DatasetPOST /api/datasets/admin:northwind-orders/snapshots/00000000-0000-4000-8000-000000000001/promote
Copies the snapshot index into a brand-new standalone Dataset. Without preserveSnapshot: true the snapshot is deleted after promotion.
Request body
{
"name": "February Archive",
"preserveSnapshot": true
}
Response · 201
{
"_links": {
"self": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive"
},
"inf:draft": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/draft"
},
"inf:run": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/_run"
},
"inf:benchmark": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/_benchmark"
},
"inf:refresh": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/_refresh"
},
"inf:data": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/data{?start,limit,q,sort,show,report}",
"templated": true
},
"inf:user-settings": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/settings"
},
"inf:query": {
"href": "https://informer.example.com/api/queries/"
},
"inf:owner": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/owner"
},
"inf:search": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/_search{?query,_source,sort,from,size,searchType,aggs,report,aggregations,alias,snapshots}",
"templated": true
},
"inf:mapping": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/mapping"
},
"inf:job-templates": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000002/job-templates"
},
"inf:fields": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/fields"
},
"inf:count": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/count"
},
"inf:comments": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/comments"
},
"inf:visuals": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/visuals"
},
"inf:visual-templates": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/visual-templates"
},
"inf:dataset-tags": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/tags"
},
"inf:dataset-tag": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/tags/{tagId}",
"templated": true
},
"inf:discover": {
"href": "https://informer.example.com/api/datasets/00000000-0000-4000-8000-000000000002/discover"
},
"inf:filters": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/filters"
},
"inf:dataset-shares": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/shares"
},
"inf:flow": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/flow"
},
"inf:group": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/group"
},
"inf:group-rows": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/group-rows"
},
"inf:dataset-share": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/shares/{principalId}",
"templated": true
},
"inf:import": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/_import"
},
"inf:exceptions": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/_exceptions"
},
"inf:search-aggregates": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/_search-aggregates"
},
"inf:exporters": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/exporters"
},
"inf:favorite": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/favorite"
},
"inf:export-bundle": {
"href": "https://informer.example.com/api/datasets/admin%3Afebruary-archive/_export"
},
"edit": {
"href": "https://informer.example.com/api/reports/admin%3Afebruary-archive/_edit"
}
},
"naturalId": "admin:february-archive",
"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",
"embedded": false,
"esType": "data",
"append": false,
"shared": false,
"timestampField": null,
"lastDurationMillis": "1500",
"windowSize": 500,
"settings": {},
"lastQueriedAt": null,
"esWorkers": 1,
"datasetFieldReportAccess": false,
"parentId": null,
"templateProcessorId": null,
"name": "February Archive",
"description": null,
"params": {},
"dataUpdatedAt": "2026-01-15T16:20:00.000Z",
"updatedAt": "2026-01-15T16:20:00.000Z",
"createdAt": "2026-01-15T16:20:00.000Z",
"ownerId": "admin",
"slug": "february-archive",
"esIndex": "docsex.acme.february-archive.1700000000000",
"records": null,
"size": null,
"source": null,
"sourceId": null,
"flow": [],
"ttl": null,
"dataExpiresAt": null,
"_altid": null,
"datasourceId": null,
"reportId": null,
"queryId": null,
"editingId": null,
"folderId": null,
"esId": null,
"esIndexName": "february-archive",
"deleteDate": null
}