> ## Documentation Index
> Fetch the complete documentation index at: https://code.dcycle.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Dataset

> Create a new custom KPI dataset with optional inline KPI definitions

# Create Dataset

Create a new custom KPI dataset for your organization. You can optionally include KPI definitions inline — each KPI defines a question that data owners will answer during campaigns.

## Request

### Headers

<ParamField header="x-api-key" type="string" required>
  Your API key for authentication

  **Example:** `sk_live_1234567890abcdef`
</ParamField>

<ParamField header="x-organization-id" type="string" required>
  Your organization UUID

  **Example:** `a8315ef3-dd50-43f8-b7ce-d839e68d51fa`
</ParamField>

### Body Parameters

<ParamField body="name" type="string" required>
  Dataset name (1–255 characters)

  **Example:** `"Water Usage Survey"`
</ParamField>

<ParamField body="description" type="string">
  Dataset description (max 2000 characters)

  **Example:** `"Monthly water consumption across all facilities"`
</ParamField>

<ParamField body="kpis" type="array[object]">
  Optional list of KPI definitions to create with the dataset (max 100).

  Each KPI object accepts:

  | Field         | Type    | Required    | Description                                                                        |
  | ------------- | ------- | ----------- | ---------------------------------------------------------------------------------- |
  | `name`        | string  | Yes         | KPI name (1–255 chars)                                                             |
  | `description` | string  | No          | KPI description (max 2000 chars)                                                   |
  | `unit`        | string  | No          | Measurement unit (max 50 chars), e.g. `"m³"`, `"kWh"`                              |
  | `value_type`  | string  | No          | Answer type: `number` (default), `text`, `percentage`, `date`, `boolean`, `select` |
  | `required`    | boolean | No          | Whether a value is mandatory (default `true`)                                      |
  | `sort_order`  | integer | No          | Display order (default `0`)                                                        |
  | `options`     | array   | Conditional | Required for `select` type — list of `{label, sort_order}` objects (2–100 options) |
</ParamField>

## Response

Returns the created dataset with its KPI definitions (HTTP 201). The response uses the same shape as [Get Dataset](/api-reference/custom-kpi/get-dataset).

<ResponseField name="id" type="string">
  Dataset UUID.
</ResponseField>

<ResponseField name="organization_id" type="string">
  UUID of the organization that owns this dataset.
</ResponseField>

<ResponseField name="name" type="string">
  Dataset display name.
</ResponseField>

<ResponseField name="description" type="string | null">
  Dataset description.
</ResponseField>

<ResponseField name="created_by" type="string | null">
  UUID of the user who created the dataset.
</ResponseField>

<ResponseField name="created_at" type="datetime">
  Timestamp when the dataset was created
</ResponseField>

<ResponseField name="updated_at" type="datetime | null">
  Timestamp when the dataset was last updated
</ResponseField>

<ResponseField name="kpis" type="array[object]">
  KPI definitions created with this dataset. See [Get Dataset](/api-reference/custom-kpi/get-dataset) for the full KPI object shape.
</ResponseField>

## Example

<CodeGroup>
  ```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
  curl -X POST "https://api.dcycle.io/v1/custom-kpi-datasets" \
    -H "x-api-key: ${DCYCLE_API_KEY}" \
    -H "x-organization-id: ${DCYCLE_ORG_ID}" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Water Usage Survey",
      "description": "Monthly water consumption across facilities",
      "kpis": [
        {
          "name": "Total water consumed",
          "unit": "m³",
          "value_type": "number",
          "required": true,
          "sort_order": 0
        },
        {
          "name": "Water source",
          "value_type": "select",
          "options": [
            {"label": "Municipal supply", "sort_order": 0},
            {"label": "Well water", "sort_order": 1},
            {"label": "Rainwater harvesting", "sort_order": 2}
          ],
          "sort_order": 1
        }
      ]
    }'
  ```

  ```python Python theme={"theme":{"light":"github-light","dark":"github-dark"}}
  import requests
  import os

  headers = {
      "x-api-key": os.getenv("DCYCLE_API_KEY"),
      "x-organization-id": os.getenv("DCYCLE_ORG_ID"),
      "Content-Type": "application/json",
  }

  response = requests.post(
      "https://api.dcycle.io/v1/custom-kpi-datasets",
      headers=headers,
      json={
          "name": "Water Usage Survey",
          "description": "Monthly water consumption across facilities",
          "kpis": [
              {
                  "name": "Total water consumed",
                  "unit": "m³",
                  "value_type": "number",
                  "required": True,
                  "sort_order": 0,
              },
              {
                  "name": "Water source",
                  "value_type": "select",
                  "options": [
                      {"label": "Municipal supply", "sort_order": 0},
                      {"label": "Well water", "sort_order": 1},
                      {"label": "Rainwater harvesting", "sort_order": 2},
                  ],
                  "sort_order": 1,
              },
          ],
      },
  )

  dataset = response.json()
  print(f"Created dataset: {dataset['id']} with {len(dataset['kpis'])} KPIs")
  ```

  ```javascript JavaScript theme={"theme":{"light":"github-light","dark":"github-dark"}}
  const axios = require('axios');

  const headers = {
    'x-api-key': process.env.DCYCLE_API_KEY,
    'x-organization-id': process.env.DCYCLE_ORG_ID,
    'Content-Type': 'application/json',
  };

  axios.post('https://api.dcycle.io/v1/custom-kpi-datasets', {
    name: 'Water Usage Survey',
    description: 'Monthly water consumption across facilities',
    kpis: [
      { name: 'Total water consumed', unit: 'm³', value_type: 'number', required: true, sort_order: 0 },
      {
        name: 'Water source',
        value_type: 'select',
        options: [
          { label: 'Municipal supply', sort_order: 0 },
          { label: 'Well water', sort_order: 1 },
          { label: 'Rainwater harvesting', sort_order: 2 },
        ],
        sort_order: 1,
      },
    ],
  }, { headers })
  .then(response => console.log(`Created: ${response.data.id}`));
  ```
</CodeGroup>

### Successful Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "organization_id": "a8315ef3-dd50-43f8-b7ce-d839e68d51fa",
  "name": "Water Usage Survey",
  "description": "Monthly water consumption across facilities",
  "created_by": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "updated_by": null,
  "created_at": "2025-01-15T10:30:00Z",
  "updated_at": null,
  "kpis": [
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Total water consumed",
      "description": null,
      "unit": "m³",
      "value_type": "number",
      "required": true,
      "sort_order": 0,
      "options": [],
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": null
    },
    {
      "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
      "dataset_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Water source",
      "description": null,
      "unit": null,
      "value_type": "select",
      "required": true,
      "sort_order": 1,
      "options": [
        {"id": "e5f6a7b8-c9d0-1234-efab-345678901234", "label": "Municipal supply", "sort_order": 0},
        {"id": "f6a7b8c9-d0e1-2345-fabc-456789012345", "label": "Well water", "sort_order": 1},
        {"id": "a7b8c9d0-e1f2-3456-abcd-567890123456", "label": "Rainwater harvesting", "sort_order": 2}
      ],
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": null
    }
  ]
}
```

## Common Errors

### 401 Unauthorized

**Cause:** Missing or invalid API key

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Invalid API key for organization", "code": "INVALID_API_KEY"}
```

### 403 Forbidden

**Cause:** The authenticated user is not a member of the organization

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{"detail": "Logged User is not Member of Organization", "code": "LOGGED_USER_NOT_MEMBER"}
```

### 422 Validation Error

**Cause:** Select KPI missing options

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "detail": [
    {
      "loc": ["body", "kpis", 0, "__root__"],
      "msg": "A select KPI must define options.",
      "type": "value_error"
    }
  ]
}
```

**Cause:** Duplicate option labels (case-insensitive)

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "detail": [
    {
      "loc": ["body", "kpis", 0, "__root__"],
      "msg": "Option labels must be unique (case-insensitive) within a KPI.",
      "type": "value_error"
    }
  ]
}
```

## Related Endpoints

<CardGroup cols={2}>
  <Card title="List Datasets" icon="list" href="/api-reference/custom-kpi/list-datasets">
    View all datasets
  </Card>

  <Card title="Get Dataset" icon="magnifying-glass" href="/api-reference/custom-kpi/get-dataset">
    View a single dataset with KPIs
  </Card>
</CardGroup>