StylorDocs

Retrieve dataset

get/v1/datasets/{datasetId}

Returns one dataset with its store configuration, free-form metadata and live item counts.

Good to know

  • items merges two sources: active and archived count processed catalogue items, while pending, processing and failed count rows still in the ingest queue. A dataset whose upload has not finished will therefore show most of its items under pending or processing.
  • metadata is omitted from the response when it was never set.
Private keyapi.v1.datasets.retrieveNo demo

Path parameters

1
datasetIdstring (uuid)required

The dataset id returned by *Create dataset*.

Response

200The dataset.
DatasetDetailrequired

The *Retrieve dataset* shape. organizationId and autoPublish are omitted; items is added.

datasetIdstring (uuid)required

Unique id of the dataset.

statusstringrequired

Lifecycle state of a dataset. - draft — newly created; not visible to search, chat or the widget. - active — live. Any number of datasets can be active at once. - archived — parked. Data is kept, items and sources are switched off.

One ofdraftactivearchived
default: "draft"
namestringrequired

Display name.

descriptionstring

Free-text description. May be an empty string.

metadataobject

Arbitrary JSON attached to the dataset. Omitted when never set.

DatasetConfigrequired

Store details attached to a dataset. Set on create, editable field-by-field on update.

createdAtstring (date-time)required

When the dataset was created.

updatedAtstring (date-time)required

When the dataset record was last written.

DatasetItemCountsrequired

Live counts of the records inside a dataset, split between processed items and the ingest queue.

Errors

20

Every error is JSON with a single error string unless noted. Match on the status code; the message is for humans.

401
Organization not found. Please check the organizationId.

The organization that owns the key no longer exists.

404
Dataset not found for this organization.

No dataset with that id belongs to your organization.

422
A valid datasetId must be provided.

datasetId is empty.

curl -X GET "https://stylor.ai/api/v1/datasets/YOUR_DATASET_ID" \
  -H "Authorization: Bearer $STYLOR_API_KEY"
Response · 200
{
  "dataset": {
    "datasetId": "c9b3c6c0-9b0f-4f42-bf3f-2b7a6b1b9d31",
    "status": "active",
    "name": "Spring 2026",
    "description": "Women's spring drop",
    "metadata": null,
    "config": {
      "storeUrl": "https://example-boutique.com",
      "storeId": "58712345678",
      "storeDomain": "example-boutique.com",
      "storeName": "Example Boutique",
      "currency": "USD",
      "targetGender": "womens"
    },
    "createdAt": "2026-03-02T09:14:31.208Z",
    "updatedAt": "2026-08-19T16:40:02.911Z",
    "items": {
      "active": 1284,
      "archived": 12,
      "pending": 0,
      "processing": 0,
      "failed": 2
    }
  }
}