> For the complete documentation index, see [llms.txt](https://docs.bdb.ai/data-center-5/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bdb.ai/data-center-5/data-center/data-stores/creating-a-new-data-store/data-store-using-an-api-data-connector.md).

# Data Store using an API Data Connector

This page displays step-by-step process on how to create an API Data Connector based Data Store.

{% hint style="success" %}
*Check out the given walk-through on how to create a Data Store based on an API Data Connector.*
{% endhint %}

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe7P9Uf1O3iaFlsO3hfWI%2Fuploads%2FuVSWqK57Bugf3Ouyx7vY%2FAPI%20Connector%20based%20Data%20Store.mp4?alt=media&token=78551d9d-4c84-4ff0-9a98-72a7e46be040>" %}
***Data Store based on an API Data Connector***
{% endembed %}

* Access the Data Source List page (Click the Data Store option from the New context menu, to access the Data Source List page).
* Choose an API connector type from the filter panel.
* Click on the ***Create Data Store*** icon to create the Data Store.

<figure><img src="https://2396355452-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe7P9Uf1O3iaFlsO3hfWI%2Fuploads%2FCrugdYcZB91DXhfPFT24%2Fimage.png?alt=media&amp;token=8a365dbd-17e8-40a7-b97d-acb9bc154474" alt=""><figcaption></figcaption></figure>

## **Getting Data**  <a href="#getting-data" id="getting-data"></a>

* The ***Getting Data*** tab opens.
* Provide a name for the Data Store.
* The name of the selected Data Connector gets displayed by default.
* Select a data set using the ***Data Set List*** drop-down menu.
* Use a checkmark in the given box to ***Enable Scheduler***
* Click the ***Next*** option.

<figure><img src="https://2396355452-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe7P9Uf1O3iaFlsO3hfWI%2Fuploads%2FVPesN0eVnWedWDJKckKy%2Fimage.png?alt=media&amp;token=5e6884d1-94e7-4964-acff-6963047e324a" alt=""><figcaption><p>Configuring the <em><strong>Getting Data</strong></em> tab</p></figcaption></figure>

## **Data Type Definition** <a href="#data-type-definition" id="data-type-definition"></a>

* The ***Data Type Definition*** tab opens.
* The user can interchange the available Dimensions, Measures, and Time fields to define data.
* Enable dimension fields with a checkmark to get in the LOV of the Filter pane of the Self-service BI Report.
* Click the ***Next*** option to proceed.

<figure><img src="https://2396355452-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe7P9Uf1O3iaFlsO3hfWI%2Fuploads%2FH1cCn13EUGj3098JaMVL%2Fimage.png?alt=media&amp;token=65f42814-300b-4b89-b32f-4a0b9e20bb92" alt=""><figcaption><p>Configuring the <em><strong>Data Type Definition</strong></em></p></figcaption></figure>

## Hierarchy Definition <a href="#hierarchy-definition" id="hierarchy-definition"></a>

* The ***Hierarchy Definition*** tab opens.
* Add a new Drill Def box by clicking the ***Add*** icon.
* Drag and drop Dimension or Time fields to create a hierarchy (The dragged and dropped ***Time*** fields get divided into three level granularities, E.g., Year>Month>Date).
* Click the ***Next*** tab to proceed.

<figure><img src="https://2396355452-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe7P9Uf1O3iaFlsO3hfWI%2Fuploads%2FKTWlSCdD6PpeDsyychIm%2Fimage.png?alt=media&amp;token=b9e745af-70f6-4456-8032-f0f019ed99fd" alt=""><figcaption><p>Configuring the <em><strong>Hierarchy Definition</strong></em> tab</p></figcaption></figure>

## Data Restrictions <a href="#data-restrictions" id="data-restrictions"></a>

* The ***Data Restrictions*** tab opens.
* Click the ***Add*** icon.
* Select a Dimension from the drop-down menu.
* Enter a **User Property** based on the inserted custom fields of a specific user(s) or user group(s).
* Click the ***Next*** option to proceed.

<figure><img src="https://2396355452-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe7P9Uf1O3iaFlsO3hfWI%2Fuploads%2FXhmLNUxPJQ12hwlxIZeF%2Fimage.png?alt=media&amp;token=1cf33ceb-1107-41ce-9c4e-71eb629879dd" alt=""><figcaption><p>The <em><strong>Data Restrictions</strong></em> tab</p></figcaption></figure>

## Schedule Data Refresh <a href="#schedule-data-refresh" id="schedule-data-refresh"></a>

* The ***Schedule Data Refresh*** tab opens.
* The following options are provided to Schedule refresh the data:
  * Hourly&#x20;
  * Daily (default option)
  * Weekly
  * Monthly
  * Yearly
* Select any option from the above-given list and configure the required information to set the data refresh interval.
* Select the ***Refresh Now*** option by enabling the box to refresh the Data Store immediately after creation.
* Enable Email Notification by enabling the option.
  * Provide the Email Address to get notified by mail.
* Click the ***Finish*** option.

<figure><img src="https://2396355452-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe7P9Uf1O3iaFlsO3hfWI%2Fuploads%2FtLFzRb6bPuF5Gpc6VVTj%2Fimage.png?alt=media&amp;token=6fd18dda-5809-43e6-95e8-d5403d487422" alt=""><figcaption><p>Configuring the <em><strong>Schedule Data Refresh</strong></em> tab</p></figcaption></figure>

* A success message appears to inform about the creation of a new data store.
* The newly created Data Store gets added to the Data Stores list.

<figure><img src="https://2396355452-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fe7P9Uf1O3iaFlsO3hfWI%2Fuploads%2F82ldjMP2xouqFbKlJIY8%2Fimage.png?alt=media&amp;token=52934a2e-5944-4f38-b16e-a03db88eb65a" alt=""><figcaption><p>A new Data Store based on an API connector gets added at the top of the Data Stores list</p></figcaption></figure>