Datasets

List datasets

get

Retrieves a list of datasets

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Query parameters

pageintegerOptional

The page number to be returned, must be greater than zero. Defaults to 1.

Example: 1

pageSizeintegerRequired

The elements amount on a single page, must be greater than zero.

Example: 25

querystringOptional

A search keyword to match dataset, fields and description against.

Example: name

connectionsstring[]Optional

A list of connection names to filter by. All connections will be included when no value is supplied.

tagsstring[]Optional

A list of tag names to filter by. All tags will be included when no value is supplied.

sortBystring · enumOptional

The field to sort results by

Possible values:

sortingOrderstring · enumOptional

Sorting order. Defaults to ascending

Possible values:

includeSystemEntitiesbooleanOptional

A flag to include in the search also system entities (e.g. Kafka's __consumer_offsets topic).

includeMetadatabooleanOptional

Whether to search only by table name, or also to include field names/documentation (defaults to true)

formatstring[]Optional

Schema format. Relevant only when sourceType is SchemaRegistrySubject

hasRecordsbooleanOptional

Filter based on whether the dataset has records

compactedbooleanOptional

Filter based on compacted. Relevant only when sourceType is Kafka

Responses

200

A response wrapping a paginated list of datasets and the set of relative source types

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

/api/v1/environments/{environment}/proxy/api/v1/datasets

GET /api/v1/environments/{environment}/proxy/api/v1/datasets?pageSize=1 HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "datasets": {
    "values": [
      {
        "name": "telecom_italia",
        "highlights": [],
        "records": 80000000,
        "recordsPerSecond": 1813,
        "keyType": "AVRO",
        "valueType": "AVRO",
        "connectionName": "Kafka",
        "replication": 1,
        "consumers": 0,
        "partitions": 6,
        "fields": {
          "key": [],
          "value": [
            {
              "type": "STRING",
              "name": "name",
              "typeDetails": {
                "lensesDataType": "STRING",
                "kind": "Lenses"
              },
              "ancestors": [],
              "highlights": [
                {
                  "fieldName": "name",
                  "startIndex": 1,
                  "endIndex": 5,
                  "arrayIndex": 0
                }
              ],
              "isNullable": false
            }
          ]
        },
        "isSystemEntity": false,
        "isMarkedForDeletion": false,
        "isCompacted": false,
        "sizeBytes": 25,
        "policies": [],
        "permissions": [
          "ShowTopic"
        ],
        "tags": [],
        "retentionMs": 604800000,
        "retentionBytes": 1073741824,
        "backupRestoreState": "backup-restore",
        "lrn": "kafka:topic:my-env/kafka/telecom_italia",
        "sourceType": "Kafka"
      }
    ],
    "pagesAmount": 1,
    "totalCount": 2
  },
  "sourceTypes": [
    "Kafka"
  ]
}

Bulk delete datasets

post

Deletes multiple datasets at once

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Body

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

post

/api/v1/environments/{environment}/proxy/api/v1/bulk/datasets/delete

POST /api/v1/environments/{environment}/proxy/api/v1/bulk/datasets/delete HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "items": [
    {
      "id": "kafka://telecom_italia"
    },
    {
      "id": "kafka://bank"
    }
  ]
}

{
  "items": [
    {
      "id": "telecom_italia",
      "success": true
    },
    {
      "id": "bank",
      "success": false,
      "message": "Dataset not found"
    }
  ]
}

Set dataset description

put

Sets a dataset description. Will respond with a bad request if a blank description is supplied

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

connectionstringRequiredExample: kafka

datasetNamestringRequiredExample: user_details

Body

descriptionstringOptional

Responses

200Success

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

/api/v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{datasetName}/description

PUT /api/v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{datasetName}/description HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "description": "Details about user's purchase history"
}

No content

Set dataset tags

put

Add one or more tags to a dataset

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

connectionstringRequiredExample: kafka

datasetNamestringRequiredExample: user_details

Body

Responses

200Success

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

/api/v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{datasetName}/tags

PUT /api/v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{datasetName}/tags HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "tags": [
    {
      "name": "crm"
    },
    {
      "name": "PII"
    },
    {
      "name": "legacy"
    }
  ]
}

No content

Get dataset details

get

Get a single dataset by connection/name. While information mastered externally might be a few second out of sync with their respective sources (e.g. JMX metadata, etc), information mastered in Lenses's db is guaranteed to be up to date (e.g. tags, descriptions).

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

connectionstringRequiredExample: kafka

datasetstringRequiredExample: customer-positions

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

/api/v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{dataset}

GET /api/v1/environments/{environment}/proxy/api/v1/datasets/{connection}/{dataset} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "text",
  "highlights": [
    {
      "fieldName": "text",
      "startIndex": 1,
      "endIndex": 1,
      "arrayIndex": 1
    }
  ],
  "records": 1,
  "recordsPerSecond": 1,
  "keyType": "text",
  "valueType": "text",
  "connectionName": "text",
  "replication": 1,
  "consumers": 1,
  "partitions": 1,
  "fields": {
    "key": [
      {
        "name": "text",
        "typeDetails": {
          "lensesDataType": "text"
        },
        "description": "text",
        "ancestors": [
          "text"
        ],
        "highlights": [
          {
            "fieldName": "text",
            "startIndex": 1,
            "endIndex": 1,
            "arrayIndex": 1
          }
        ],
        "isNullable": true,
        "default": "text"
      }
    ],
    "value": [
      {
        "name": "text",
        "typeDetails": {
          "lensesDataType": "text"
        },
        "description": "text",
        "ancestors": [
          "text"
        ],
        "highlights": [
          {
            "fieldName": "text",
            "startIndex": 1,
            "endIndex": 1,
            "arrayIndex": 1
          }
        ],
        "isNullable": true,
        "default": "text"
      }
    ]
  },
  "isSystemEntity": true,
  "isMarkedForDeletion": true,
  "isCompacted": true,
  "sizeBytes": 1,
  "policies": [
    {
      "policyId": "text",
      "policyName": "text",
      "policyCategory": "text",
      "obfuscation": "text",
      "matchingKeyFields": [
        {
          "name": "text",
          "parents": [
            "text"
          ]
        }
      ],
      "matchingValueFields": [
        {
          "name": "text",
          "parents": [
            "text"
          ]
        }
      ],
      "lrn": "text"
    }
  ],
  "permissions": [
    "text"
  ],
  "description": "text",
  "tags": [
    {
      "name": "text"
    }
  ],
  "retentionMs": 1,
  "retentionBytes": 1,
  "backupRestoreState": {},
  "lrn": "text",
  "sourceType": "text"
}

Get dataset tags

get

Get tags sorted by dataset count

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Query parameters

querystringOptional

Match tag by keyword

Example: user

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

/api/v1/environments/{environment}/proxy/api/v1/datasets/tags

GET /api/v1/environments/{environment}/proxy/api/v1/datasets/tags HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "tags": [
    {
      "name": "user-generated-content",
      "count": 5
    },
    {
      "name": "user-details",
      "count": 2
    },
    {
      "name": "testuser",
      "count": 1
    }
  ]
}

Get dataset connections

get

Get a list of available dataset connections

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

Query parameters

querystringOptional

Match connection by keyword

Example: kafka

perPageintegerOptional

Number of results to be returned. Defaults to 25 if not supplied

Example: 50

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

/api/v1/environments/{environment}/proxy/api/v1/datasets/connections

GET /api/v1/environments/{environment}/proxy/api/v1/datasets/connections HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "connections": [
    {
      "name": "kafka",
      "sourceType": "Kafka",
      "connectionStatus": "Green"
    },
    {
      "name": "kafka-reconcilation.dev",
      "sourceType": "Kafka",
      "connectionStatus": "Yellow"
    }
  ]
}

Get dataset ranged metrics

get

get ranged metrics for requested dataset

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

environmentstringRequired

entityNamestringRequired

Dataset's entity name

Example: topic

Responses

200Success

application/json

400

The request input was invalid

text/plain

401

Authentication error

text/plain

402

The purchased Lenses license does not provide access to this feature

text/plain

403

Authorisation error

text/plain

404

The requested resource cannot be found

text/plain

500

An internal server error has occurred

text/plain

get

/api/v1/environments/{environment}/proxy/api/v1/datasets/kafka/{entityName}/messages/metrics

GET /api/v1/environments/{environment}/proxy/api/v1/datasets/kafka/{entityName}/messages/metrics HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "date": "2025-12-29T11:35:08.680Z",
    "messagesCount": 1
  }
]

PreviousK2K Apps NextKafka

Last updated 9 days ago

Was this helpful?

Good morning

List datasets

Bulk delete datasets

Set dataset description

Set dataset tags

Get dataset details

Get dataset tags

Get dataset connections

Get dataset ranged metrics