list-datahub-datasets

dci list-datahub-datasets

Returns a list of all DataHub datasets for the customer.

CLI default view

dci list-datahub-datasets presents a curated table by default:

• Columns: name, display name (from displayName), updated (UTC) (from lastUpdated), and updated by (from updatedBy).
• The display name column appears only when at least one dataset has one — it is what the DoiT console and report results show instead of name, and is set with dci update-datahub-dataset <dataset-name> displayName: "...".
• In interactive tables, updated (UTC) renders in your local timezone and is titled updated (local); machine formats, agent mode, and --utc keep UTC — see Timestamps and timezones.
• --output json and explicit -C/--fields selections return the raw fields documented below.

Examples

# All datasets, with when and by whom each was last updated.
dci list-datahub-datasets

# Only datasets whose name or description mentions LiteLLM (client-side substring match).
dci list-datahub-datasets --search litellm

# The raw records, including descriptions and record counts, as JSON.
dci list-datahub-datasets --output json

Output

OK - List of datasets returned successfully.

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
datasets	array of object
datasets[].name	string	The name of the dataset.
datasets[].description	string	The description of the dataset.
datasets[].records	integer (int64)	The number of records in the dataset.
datasets[].updatedBy	string	The email of the user who last updated the dataset.
datasets[].lastUpdated	string	The timestamp of the last update.
datasets[].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.
datasets[].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": {
    "datasets": {
      "type": "array",
      "items": {
        "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.
500	40	API_SERVER_ERROR	The API failed to process the request. Retryable; contact DoiT support if it persists.

Related

• get-datahub-dataset — Retrieve a dataset
• create-datahub-dataset — Create dataset
• update-datahub-dataset — Update dataset
• ingest-datahub-events — Ingest JSON
• API reference: GET /datahub/v1/datasets

Aliases: listdatahubdatasets