v1

latestOpenAPI 3.0.02026-08-06132933.0 KB

Datasets

Create a dataset

Creates a new dataset within the specified data source. A dataset acts as a container for ingested data and can later be populated with rows. Once created, the dataset can be used for reporting, visualizations, and transformations within the platform.

Notes:

Requires a valid x-api-key with permission to manage datasets in the target account.
Each dataset must belong to an existing data source; it cannot exist independently.
The dataset is created empty; data is added afterward through ingestion events.

post/v1/datasets

Headers

Content-Typestring required

Must be set to application/json

Request body

titlestring

Human-readable name of the dataset. May be empty but not null.

dataSourceIdinteger

Unique identifier for the data source.

primaryKeysstring[] nullable

Array of column names that uniquely identify rows in the dataset.
if the dataset has no unique columns or identifiers, this field can be omitted (null).

Example request

{
  "title": "Transactions",
  "dataSourceId": 4754489,
  "primaryKeys": [
    "invoice_id"
  ]
}

Response

Successful response containing the newly created dataset.

requestIdstring

Unique identifier for the request.

statusstring

Indicates the status of the request.

idstring uuid

Unique identifier for the dataset.

titlestring nullable

Human-readable name of the dataset. May be empty but not null.

createdstring date-time

ISO 8601 timestamp when the data source was created.

Example response

{
  "requestId": "b0eac937-c25c-47a5-bb7e-552f6b860458",
  "status": "success",
  "id": "4e1219d8-7fa8-44b7-96c6-a8f2a9cfb0bf",
  "title": "Transactions",
  "created": "2025-10-01T12:00:00.000000Z"
}