# Dataset Toolbox (`cyberfly/dataset-toolbox`) Actor

Perform common actions on datasets - merge, unify, validate, transform, order fields etc.

- **URL**: https://apify.com/cyberfly/dataset-toolbox.md
- **Developed by:** [Vasek Codey Vlcek](https://apify.com/cyberfly) (community)
- **Categories:** Automation, Open source
- **Features:** Full permissions
- **Stats:** 48 total users, 1 monthly users, 90.0% runs succeeded, 5 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## Dataset Toolbox

### Input

| Field | Type | Optional | Description |
| ----- | ---- | -------- | ----------- |
|Actor IDs|Array|depends|Load latest default datasets
|Dataset IDs|Array|depends|Load the specified datasets

**Access 3rd party datasets**

Define secret environment variable to access other users' datasets: `CUSTOM_SOURCE_APIFY_TOKEN`

### Features

- [Dataset unification](#dataset-unification)
  - merge datasets in uniform output
  - limit number of items extracted
- [Latest dataset detection](#latest-dataset-detection)
  - detect and use the latest datasets
- [Output fields management](#output-fields-management)
  - filter out fields from source data
  - output data in custom field order
- [Dataset post-processing](#dataset-post-processing)
  - apply custom function to each item
- [Output schema validation](#output-schema-validation)
  - validate records against schema
  - capture invalid items for recycling

#### Dataset unification

Use features described below to produce a single uniform dataset from datasets sharing a single common output schema and expected output structure

#### Latest dataset detection

Automatically detects and uses default datasets of the latest actor runs when:

- Actor ID(s) are specified AND
- Dataset ID(s) are not specified

#### Output fields management

Produces a download link for obtaining the resulting dataset with top level fields sorted and filtered based on the list of fields provided on input. This link is stored in default KV store:

`DATASET_DOWNLOAD-CUSTOM_FIELD_ORDER-{selected file type}`

**Filter fields**

Filter and pick only certain fields from source dataset(s)

**Order fields**

Apply custom order to top level fields in custom order instead of alphabetical (default)

#### Dataset post-processing

Apply custom javascript function to every item from source dataset(s) before saving to result dataset

#### Output schema validation

**Validate schema**

Validate every item against JSON schema specified on input and filter out invalid items before saving to result dataset

**Reuse invalid items**

Invalid items are captured in separate `requestListSources` saved in KV store.

# Actor input Schema

## `actorIds` (type: `array`):

IDs of actors to use as source of latest default datasets

## `datasetIds` (type: `array`):

IDs of datasets to use as data sources directly

## `outputFormat` (type: `string`):

Output file format of the result dataset

## `itemsLimit` (type: `integer`):

Limit number of items from the source datasets

## `manageFields` (type: `boolean`):

Pick top level fields from the source dataset and sort them in custom order specified below

## `sortedFields` (type: `array`):

Extract these fields from source datasets and sort them in specified order on output linked from dataset download link in KV

## `postProcessing` (type: `boolean`):

Enable post-processing of individual items

## `postProcessFun` (type: `string`):

Function for post-processing with individual dataset item as its single argument

## `validateSchema` (type: `boolean`):

Validates dataset items against output schema

## `validateOnly` (type: `boolean`):

Validate source items without storing them in default dataset

## `outputSchema` (type: `object`):

Dataset items are validated against this schema

## Actor input object example

```json
{
  "outputFormat": "json",
  "postProcessFun": "(item) => item"
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "postProcessFun": (item) => item
};

// Run the Actor and wait for it to finish
const run = await client.actor("cyberfly/dataset-toolbox").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "postProcessFun": "(item) => item" }

# Run the Actor and wait for it to finish
run = client.actor("cyberfly/dataset-toolbox").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "postProcessFun": "(item) => item"
}' |
apify call cyberfly/dataset-toolbox --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,cyberfly/dataset-toolbox"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/bawuiX5bWrBAXTwLQ/builds/2J8mKVOLVIVWlLFXt/openapi.json
