DataHub

Retrieve a dataset

Returns a specific DataHub dataset by name.

get/datahub/v1/datasets/{name}

Request

  • Base URL
    https://api.doit.com
  • URL
    https://api.doit.com/datahub/v1/datasets/{name}
  • Auth
    • API key in header Authorization
    • or API key in header X-Tenant-Id and API key in header Authorization

Path parameters

namestring required

The name of the dataset to retrieve.

Response

OK - Dataset returned.

namestring

The name of the dataset.

descriptionstring

The description of the dataset.

recordsinteger

The number of records in the dataset.

updatedBystring

The email of the user who last updated the dataset.

lastUpdatedstring

The timestamp of the last update.

Example response

{
  "name": "My Custom Dataset",
  "description": "Dataset for tracking custom business metrics",
  "records": 1500,
  "updatedBy": "user@example.com",
  "lastUpdated": "2024-03-10T23:00:00Z"
}

Changes

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