# Data products reference

Copy as Markdown[View as Markdown](/docs/development/guides/resources/data-products/reference.md)

***

This page lists the fields, paths, and routes supported by data products.

## Paths[​](#paths "Direct link to Paths")

Data products can be created in any `data-products` folder:

```
/data-products/{Data Product Name}/index.mdx
/domains/{Domain Name}/data-products/{Data Product Name}/index.mdx
```

Versioned data products use:

```
/data-products/{Data Product Name}/versioned/{version}/index.mdx
```

## Routes[​](#routes "Direct link to Routes")

| Route                                                   | Description                      |
| ------------------------------------------------------- | -------------------------------- |
| `/docs/data-products/{data-product-id}/{version}`       | Data product documentation page. |
| `/visualiser/data-products/{data-product-id}/{version}` | Data product resource diagram.   |

## Required fields[​](#required-fields "Direct link to Required fields")

### `id`[​](#id "Direct link to id")

* Type: `string`

Unique id of the data product. EventCatalog uses this for URLs and resource references.

Example

```
---
id: customer-analytics
---
```

### `name`[​](#name "Direct link to name")

* Type: `string`

Display name of the data product.

Example

```
---
name: Customer Analytics
---
```

### `version`[​](#version "Direct link to version")

* Type: `string`

Version of the data product documentation.

Example

```
---
version: 1.0.0
---
```

## Optional fields[​](#optional-fields "Direct link to Optional fields")

### `summary`[​](#summary "Direct link to summary")

* Type: `string`

Short description of the data product.

Example

```
---
summary: Curated customer analytics dataset for reporting and segmentation.
---
```

### `owners`[​](#owners "Direct link to owners")

* Type: `array`

An array of team or user ids that own the data product.

Example

```
---
owners:
  - data-platform
---
```

### `inputs`[​](#inputs "Direct link to inputs")

* Type: `array`

Resources used as inputs to the data product.

Example

```
---
inputs:
  - id: customer-database
    type: container
---
```

### `outputs`[​](#outputs "Direct link to outputs")

* Type: `array`

Outputs produced by the data product.

Example

```
---
outputs:
  - id: customer-analytics
    contract:
      path: contracts/customer-analytics.avro
      name: Customer analytics contract
      type: avro
---
```

### `badges`[​](#badges "Direct link to badges")

* Type: `array`

Badges rendered on the data product page.

Example

```
---
badges:
  - content: Certified
    backgroundColor: green
    textColor: green
---
```

### `repository`[​](#repository "Direct link to repository")

* Type: `object`

Repository metadata for the data product.

Example

```
---
repository:
  language: SQL
  url: https://github.com/acme/customer-analytics
---
```

### `diagrams`[​](#diagrams "Direct link to diagrams")

* Type: `array`

Diagrams associated with the data product.

Example

```
---
diagrams:
  - id: customer-analytics-lineage
    version: 1.0.0
---
```

### `attachments`[​](#attachments "Direct link to attachments")

* Type: `array`

External links or supporting documents attached to the data product.

Example

```
---
attachments:
  - title: Data contract review
    url: https://docs.example.com/customer-analytics
    type: document
---
```

## Output contracts[​](#output-contracts "Direct link to Output contracts")

Outputs can include a contract that describes the data product output.

```
---
outputs:
  - id: customer-analytics
    contract:
      path: contracts/customer-analytics.avro
      name: Customer analytics contract
      type: avro
---
```