Info & Metadata

Lightweight Dataset lookups and refresh exception listings.

GET /api/datasets/{id}/info

Get minimal Dataset information: ids, name, owner, the Datasource id, and your permissions. No fields, query, or index stats are loaded, so this is much faster than the full GET /api/datasets/{id}.

Authentication: Required

Path Parameters:

Parameter	Type	Description
`id`	string	Dataset UUID or `ownerId:slug` natural id

Get minimal Dataset infoGET /api/datasets/admin:northwind-orders/info

A fast lookup for breadcrumbs and references: ids, name, owner, the datasource id, and your permissions. No fields, query, or stats.

Response · 200

{
  "_links": {
    "self": {
      "href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/info"
    }
  },
  "id": "00000000-0000-4000-8000-000000000001",
  "slug": "northwind-orders",
  "name": "Northwind Orders",
  "ownerId": "admin",
  "datasourceId": "00000000-0000-4000-8000-000000000002",
  "datasourceEmbedded": false,
  "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
  }
}

Captured from the API examples test suite; ids and timestamps are normalized.

Key Fields:

Field	Description
`naturalId`	`ownerId:slug` when the Dataset has a slug, otherwise the UUID
`datasourceId`	The query's Datasource id (`null` for external Datasets)
`datasourceEmbedded`	`true` when the Datasource is an internal upload datasource
`permissions`	Permission flags for the current user

Use Case:

Breadcrumbs, references, and quick lookups where the full Dataset payload would be wasteful.

ETag Support: Based on dataset table changes.

GET /api/datasets/{id}/_exceptions

List the rows that failed to index during the Dataset's most recent refresh.

Authentication: Required

Path Parameters:

Parameter	Type	Description
`id`	string	Dataset UUID or `ownerId:slug` natural id

Query Parameters:

Parameter	Type	Default	Description
`start`	integer	0	Pagination offset
`limit`	integer	30	Number of results per page

List refresh exceptions for a DatasetGET /api/datasets/admin:northwind-orders/_exceptions?limit=10

Rows that failed indexing during the last refresh. Empty when the refresh was clean.

Response · 200

{
  "_links": {
    "self": {
      "href": "https://informer.example.com/api/datasets/admin%3Anorthwind-orders/_exceptions?start=0&limit=10"
    }
  },
  "items": [],
  "start": 0,
  "count": 0,
  "total": 0
}

Captured from the API examples test suite; ids and timestamps are normalized.

Response:

A paginated collection. Each item is the raw data payload of one rejected record, so the shape of items entries follows the Dataset's own fields. items is empty when the last refresh indexed cleanly.

Use Case:

After a refresh reports indexing exceptions, page through this endpoint to see exactly which records were rejected (typically type conflicts with the index mapping) and fix them at the source.

GET /api/datasets/{id}/info​

GET /api/datasets/{id}/_exceptions​

GET /api/datasets/{id}/info

GET /api/datasets/{id}/_exceptions