> ## Documentation Index
> Fetch the complete documentation index at: https://www.marqeta.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Data Dictionary

> Use this endpoint to retrieve the data dictionary of the DiVA API.

export const EndpointCard = ({method = "API", title, children, href, arrow = true}) => {
  const METHOD_STYLES = {
    GET: {
      bg: "mint-bg-green-400/20 dark:mint-bg-green-400/20",
      text: "mint-text-green-700 dark:mint-text-green-400",
      border: "mint-border-green-300 dark:mint-border-green-700"
    },
    POST: {
      bg: "mint-bg-blue-400/20 dark:mint-bg-blue-400/20",
      text: "mint-text-blue-700 dark:mint-text-blue-400"
    },
    PUT: {
      bg: "mint-bg-yellow-400/20 dark:mint-bg-yellow-400/20",
      text: "mint-text-yellow-700 dark:mint-text-yellow-400"
    },
    PATCH: {
      bg: "mint-bg-orange-400/20 dark:mint-bg-orange-400/20",
      text: "mint-text-orange-700 dark:mint-text-orange-400"
    },
    DELETE: {
      bg: "mint-bg-red-400/20 dark:mint-bg-red-400/20",
      text: "mint-text-red-700 dark:mint-text-red-400"
    },
    API: {
      bg: "mint-bg-black",
      text: "mint-text-white"
    }
  };
  const MethodBadge = ({method}) => {
    const style = METHOD_STYLES[method?.toUpperCase()] ?? METHOD_STYLES.GET;
    return <span className={`
          method-pill rounded-lg font-semibold px-1.5 py-0.5 text-xs leading-5 ${style.bg} ${style.text}`}>
        {method?.toUpperCase()}
      </span>;
  };
  const content = <div className="group flex items-center gap-4 border border-gray-200 dark:border-gray-700 rounded-xl p-5 hover:border-gray-400 dark:hover:border-gray-500 hover:shadow-md transition-all cursor-pointer">
      {}
      <div className="shrink-0">
        <MethodBadge method={method} />
      </div>
      {}
      <div className="flex-1 min-w-0">
        <p className="font-semibold text-gray-900 dark:text-white text-sm leading-snug">{title}</p>
        {children && <p className="mt-1 text-sm text-gray-500 dark:text-gray-400 line-clamp-2">{children}</p>}
      </div>
    </div>;
  if (!href) return content;
  return <a href={href} className="block no-underline border-b-0 mb-2">
      {content}
    </a>;
};

Use this endpoint to retrieve the data dictionary of the DiVA API. The data dictionary contains records that specify the data fields available in the API, including the display name and description of each field.

This endpoint supports multiple response formats, query filtering, field filtering, sorting, and pagination. For more information about response options, see [Response Customization](/diva-api/response-customization/).

<h2 id="_retrieve_data_dictionary_json">
  Retrieve data dictionary (JSON)
</h2>

**Action:** `GET`\
**Endpoint:** `/views/datadictionary`

Retrieve the data dictionary. This endpoint returns a JSON object that contains an array of records matching your filter query.

<h3 id="_response_body">
  Response body
</h3>

| Name                     | Type   | Required? | Description                                         |
| ------------------------ | ------ | --------- | --------------------------------------------------- |
| field\_name              | string | Returned  | Name of the field.                                  |
| field\_name\_readable    | string | Returned  | Display name of the field in the Marqeta Dashboard. |
| field\_name\_description | string | Returned  | Description of the field.                           |

<h3 id="_sample_response_body">
  Sample response body
</h3>

The following sample shows a representative response for a `GET` request to the `/views/datadictionary?field_name=card_product_name,acting_card_type,ach_status` endpoint.

```json JSON expandable lines wrap theme={null}
{
  "total": 3,
  "is_more": false,
  "count": 3,
  "info": {},
  "start_date": null,
  "end_date": null,
  "last_run_time": "",
  "schema": [
    {
      "field": "field_name",
      "type": "character varying(128)",
      "display": "Field Name",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    },
    {
      "field": "field_name_readable",
      "type": "character varying(128)",
      "display": "Field Name Readable",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    },
    {
      "field": "field_name_description",
      "type": "character varying(2500)",
      "display": "Field Name Description",
      "units": null,
      "has_total": false,
      "is_filter_only": false
    }
  ],
  "records": [
    {
      "field_name": "card_product_name",
      "field_name_readable": "Card Product Name",
      "field_name_description": "The name of the card product associated with a card."
    },
    {
      "field_name": "ach_status",
      "field_name_readable": "Ach Status",
      "field_name_description": "The status of an ACH load attempt."
    },
    {
      "field_name": "acting_card_type",
      "field_name_readable": "Acting Card Type",
      "field_name_description": "The form factor of the card (virtual or physical)."
    }
  ]
}
```

<h2 id="_retrieve_data_dictionary_file_export">
  Retrieve data dictionary (file export)
</h2>

**Action:** `GET`\
**Endpoint:** `/views/datadictionary/{export_type}`

Retrieve the data dictionary in the specified format. This endpoint asynchronously generates a file in the specified format and returns a job token for retrieving the file when it is completed. The file contains a list of records matching your filter query.

<h3 id="_url_path_parameters">
  URL path parameters
</h3>

| Fields                                       | Description                                                                              |
| -------------------------------------------- | ---------------------------------------------------------------------------------------- |
| export\_type<br /><br />string<br />Required | File format in which to export the data.<br /><br />**Allowable Values:**<br /><br />csv |

<h3 id="_query_parameters">
  Query parameters
</h3>

| Fields                                   | Description                                                                                                                               |
| ---------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| compress<br /><br />string<br />optional | Type of file compression for the exported file.<br /><br />**Allowable Values:**<br /><br />gz, zip<br /><br />**Default value:**<br />gz |

<h3 id="_sample_response_body_2">
  Sample response body
</h3>

The following sample shows a representative response for a `GET` request to the `/views/datadictionary/xlsx?compress=zip` endpoint.

```json JSON lines wrap theme={null}
{
  "token": "d62b19969d66fb8de930036147ddf71b8e2b3e1d.xlsx.zip"
}
```

<h2 id="_retrieve_data_dictionary_schema">
  Retrieve data dictionary schema
</h2>

**Action:** `GET`\
**Endpoint:** `/views/datadictionary/schema`

Retrieve a JSON representation of the data dictionary schema. The schema object contains an array of objects that describe the available columns and the data type of each column.

<h3 id="_sample_response_body_3">
  Sample response body
</h3>

The following sample shows a representative response for a `GET` request to the `/views/datadictionary/schema` endpoint.

```json JSON expandable lines wrap theme={null}
[
  {
    "field": "field_name",
    "type": "character varying(128)",
    "display": "Field Name",
    "units": null,
    "has_total": false,
    "is_filter_only": false
  },
  {
    "field": "field_name_readable",
    "type": "character varying(128)",
    "display": "Field Name Readable",
    "units": null,
    "has_total": false,
    "is_filter_only": false
  },
  {
    "field": "field_name_description",
    "type": "character varying(2500)",
    "display": "Field Name Description",
    "units": null,
    "has_total": false,
    "is_filter_only": false
  }
]
```


## Related topics

- [Reports In-depth](/docs/developer-guides/reports-in-depth.md)
- [Reports in the Marqeta Dashboard](/docs/developer-guides/reports-dashboard.md)
- [Data Caching](/docs/diva-api/data-caching.md)
- [Data Products and Insights](/docs/developer-guides/data-products-and-insights.md)
- [Transaction Data for JIT Funding Decisions](/docs/core-api/transaction-data-for-jit-funding-decisions.md)