How-to create a Data Store using an API Data Connector

Create a Data Store backed by an API Data Connector using the guided wizard. This flow covers Getting Data, Data Type Definition, Hierarchy Definition, Data Restrictions, and (optionally) Schedule Data Refresh.

Prerequisites:

  • An API Data Connector is already created and authenticated.

  • (Recommended) One or more Data Sets are available for the selected API connector.

Access the Data Source List

  1. Open Data Center.

  2. Click New → Data Store to open the Data Source list page.

  3. In the filter panel, choose API as the connector type.

  4. Click Create Data Store (icon) on the desired API connector.

1) Getting Data

  • Data Store Name: Provide a name.

  • Data Connector: Auto-displayed based on your selection.

  • Data Set List: Select a Data Set from the drop-down.

  • Enable Scheduler: (Optional) Check this box to configure Schedule Data Refresh later.

  • Click Next.

Tip: Ensure the chosen Data Set returns the fields you intend to model as Dimensions/Measures/Time.

2) Data Type Definition

Interchange fields among Dimensions, Measures, and Time.

  • Drag fields or use the category icons to move a field to Dimensions, Measures, or Time.

  • Enable (check) the Dimension fields you want exposed as LOV (List of Values) in the filter pane of the Self-service BI Report.

  • Click Next.

3) Hierarchy Definition

Create drill paths for analysis.

  1. Click Add to create a Drill Def box.

  2. Drag and drop Dimension or Time fields into the Drill Def.

    • Time splits into three levels by default (e.g., Year > Month > Date).

  3. Add multiple Drill Def boxes as needed for different drill paths.

  4. Click Next.

4) Data Restrictions

Restrict row-level visibility using user/group properties.

  1. Click Add to insert a restriction box.

  2. Select a Dimension (drop-down).

  3. Enter a User Property that maps to a custom field configured for specific user(s) or user group(s).

  4. Click Next.

Example: If a user’s custom field is Country=India, restricting on Country shows only India data to that user.

5) Schedule Data Refresh (shown only if Enable Scheduler was checked)

Set how the Data Store refreshes data from the API.

  • Frequency: Hourly, Daily (default), Weekly, Monthly, Yearly.

  • Refresh Now: Check to refresh immediately after creation.

  • Email Notification: Check to enable notifications; provide a valid Email Address.

  • Click Finish.

Completion & Result

  • A success message confirms the Data Store was created.

  • The new Data Store appears in the Data Stores list and is ready for use in Self-service BI.

Tips

  • Dimensions as LOV: Enable only those you expect to use for filtering to keep the filter pane lean.

  • Time field: Include at least one Time field to leverage timeline and drill capabilities.

  • Governance: Use Data Restrictions early for secure, role-appropriate access.

  • Scheduling: For APIs with rate limits or long-running calls, schedule refreshes during off-peak windows and enable email alerts.

Troubleshooting

  • No Data Sets in the drop-down: Verify the API connector has published Data Sets or that you have access to them.

  • Unexpected fields at design time: Reopen the underlying Data Set and validate the schema/fields.

  • Scheduler tab not visible: Ensure Enable Scheduler was checked on the Getting Data step.

  • Filters not showing expected LOVs: Confirm you enabled those Dimensions in Data Type Definition.

PreviousHow-to create a Data Store Using an RDBMS ConnectorNextData Pipeline

Last updated