Nexsets (Data Sets)

Get Nexset Samples

Use this endpoint to fetch some sample records from this Nexset. Use the relevant query parameters to control whether the samples returned are from the live Nexset topic or the Nexset sample cache.

get/data_sets/{set_id}/samples

Request

Path parameters

set_idinteger required

The unique ID of the Nexset that needs to be fetched.

Query parameters

countinteger

The maximum number of samples that should be returned in the response.

include_metadataboolean

Set this to true to fetch Nexla metadata about each sample record along with the record content.

include_metadataboolean

Set this to true to fetch Nexla metadata about each sample record along with the record content.

liveboolean

Set this to true to fetch live sample records from the Nexset topic.

Headers

Accept'application/vnd.nexla.api.v1+json' | 'application/json'

Setting to application/vnd.nexla.api.v1+json is recommended.

Response

Success

object[] required

Output samples without metadata

OR

Example response

[
  {
    "nexlaMetaData": {
      "sourceType": "GDRIVE",
      "ingestTime": 1657222945906,
      "sourceKey": "aBcDeFg",
      "resourceType": "SOURCE",
      "resourceId": 1,
      "lastModified": 1656524615000,
      "runId": 1657222941374,
      "flow_type": "streaming"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.