Skip to main content

Get Dataset

Route

/v2/datasets/{id}

Description

Retrieve a specific dataset by its unique identifier. Returns detailed information about the dataset configuration and properties.

Method

GET

Inputs

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the dataset to retrieve

Output

FieldTypeDescription
typestringAlways "datasets"
sizeintegerNumber of datasets returned (always 1)
resourcesarray[Dataset]Array containing the requested dataset
errorsarray[Error]Any errors encountered

Dataset Object Structure

FieldTypeDescription
idstringUnique dataset identifier
versionstringVersion identifier for concurrency control
namestringHuman-readable name
descriptionstringDetailed description
sensitivitystringSensitivity level (unrestricted, low, moderate, high, critical)
domainstringDomain category (corporate, partner, personal, public)
queryobjectQuery conditions defining dataset membership
created_atstringCreation timestamp (ISO 8601)
last_modifiedstringLast modification timestamp (ISO 8601)
backfills_enabledbooleanWhether historical data processing is enabled
policy_idsarray[string]Associated policy identifiers

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response

{
"type": "datasets",
"size": 1,
"resources": [
{
"id": "dataset-123",
"version": "v1.2.3",
"name": "Customer PII",
"description": "Personal identifiable information of customers",
"sensitivity": "high",
"domain": "corporate",
"query": {
"rules": [
{
"conditions": [
{
"field_name": "content_tags",
"operator": "has_tag",
"values": [{"value": "customer_pii"}]
}
]
}
]
},
"created_at": "2024-01-15T10:30:00Z",
"last_modified": "2024-01-20T14:15:00Z",
"backfills_enabled": true,
"policy_ids": ["policy-456", "policy-789"]
}
],
"errors": []
}