DataHub

Create dataset

Creates a new DataHub dataset. A dataset is a logical grouping of events that share the same provider name. Creating a dataset allows you to define metadata such as name and description before ingesting events.

post/datahub/v1/datasets

Request

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

Request body

namestring required

The name of the dataset. Allowed characters: alphanumeric (0-9,a-z,A-Z), underscore (_), dash (-), and spaces between words.

descriptionstring

An optional description for the dataset.

Example request

{
  "name": "My Custom Dataset",
  "description": "Dataset for tracking custom business metrics"
}

Response

Created - Dataset created successfully.

namestring

The name of the dataset.

descriptionstring

The description of the dataset.

recordsinteger nullable

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",
  "updatedBy": "user@example.com",
  "lastUpdated": "2024-03-10T23:00:00Z"
}

Changes

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