get-datahub-dataset

dci get-datahub-dataset <name>

Returns a specific DataHub dataset by name.

• name — Dataset name as shown by dci list-datahub-datasets. The name is the dataset's identifier; there is no separate ID.

Examples

# Show one dataset, including its record count and who last updated it.
dci get-datahub-dataset <dataset-name>

# The full record as JSON, for scripts.
dci get-datahub-dataset <dataset-name> --output json

Output

OK - Dataset returned.

By default dci renders the result as a table. Use --output json to get the full structure described below — see Output formats.

Field	Type	Description
name	string	The name of the dataset.
description	string	The description of the dataset.
records	integer (int64)	The number of records in the dataset.
updatedBy	string	The email of the user who last updated the dataset.
lastUpdated	string	The timestamp of the last update.
displayName	string	Human-readable name shown in the DoiT console and in report results instead of name. Absent when the dataset is displayed by its name. Does not affect ingest, which always uses name as the provider.
logoName	string	The preset logo shown next to the dataset in the DoiT console. Absent when the dataset has no preset logo.

Raw JSON schema

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the dataset.",
      "example": "My Custom Dataset"
    },
    "description": {
      "type": "string",
      "description": "The description of the dataset.",
      "example": "Dataset for tracking custom business metrics"
    },
    "records": {
      "type": "integer",
      "format": "int64",
      "description": "The number of records in the dataset.",
      "example": 1500
    },
    "updatedBy": {
      "type": "string",
      "description": "The email of the user who last updated the dataset.",
      "example": "[email protected]"
    },
    "lastUpdated": {
      "type": "string",
      "description": "The timestamp of the last update.",
      "example": "2024-03-10T23:00:00Z"
    },
    "displayName": {
      "type": "string",
      "description": "Human-readable name shown in the DoiT console and in report results instead of `name`. Absent when the dataset is displayed by its `name`. Does not affect ingest, which always uses `name` as the provider.",
      "example": "Datadog (prod)"
    },
    "logoName": {
      "type": "string",
      "description": "The preset logo shown next to the dataset in the DoiT console. Absent when the dataset has no preset logo.",
      "example": "litellm"
    }
  }
}

Errors

On failure, dci prints a single error message — with a hint when one is available — and exits with a typed code your scripts can branch on. See Errors and exit codes for the full contract.

HTTP status to exit code mapping

HTTP status	Exit code	Error code	Meaning
401	10	AUTHENTICATION_FAILED	Not signed in, or the API token is invalid. Run dci login or check DCI_API_KEY.
403	11	PERMISSION_DENIED	The DoiT user or the active customer context does not have access.
404	20	RESOURCE_NOT_FOUND	The requested resource does not exist. Check the identifier argument.
500	40	API_SERVER_ERROR	The API failed to process the request. Retryable; contact DoiT support if it persists.

Related

• list-datahub-datasets — List datasets
• create-datahub-dataset — Create dataset
• update-datahub-dataset — Update dataset
• ingest-datahub-events — Ingest JSON
• API reference: GET /datahub/v1/datasets/{name}

Aliases: getdatahubdataset