Import Setup
How to set up data import from the Stream API into the Productsup platform.
You don't need any special platform knowledge to set up an import with the Stream API. But if you need help, take the following steps.
Prerequisites
To set up the import with Stream API, you need to have:
- User access to the Productsup platform
- A site in the Productsup platform ready for data import
- The Stream ID and Stream name(s).
If you don't have any of the listed components, contact your Client Success Manager.
Set up an import
To create Stream API Data Sources via our API, use the Site Stream Data Source endpoint.
- Open your site in the platform and go to Data Sources in the main menu.
- Select Add Data Source.
- In the search field, enter Stream API and find Stream API Data Source.
- Select Add to add the data source.
- Give your data source a custom name, as desired, to identify it among multiple data sources.
- Select Next and get to Data Source Configuration page.
- Select the Stream you want to import from. You can use the label Stream to find it later.
- Change the description, as needed.
- Select Save and get back to the Data Sources page.
- If your Stream already contains data, select Import in the upper-right corner to import the data.
- View your imported data in Data View.
Empty data sources
By default, the platform doesn't perform the import if a data source is empty, as it leads to a failure. But certain API scenarios may need to import an empty data source. For example, you may need to purge all data. To import an empty data source, take the following steps:
- Open your site in the platform and go to Data Sources in the main menu.
- Edit the Stream API data source.
- Go to the tab Advanced Settings.
- Go to Options.
- Check the checkbox Allow this datasource to have no products.
- Select Save Options.
To inactivate the import of an empty data source, repeat the steps above and, in Step 6, uncheck the checkbox Allow this datasource to have no products.
Platform recommendations
Don't activate the option Allow this datasource to have no products without a necessity and agreement with the API Team, as we don't anticipate to have an empty data source.
We recommend setting up the error event Number of imported items decreased in Monitor of in the main menu of our platform. Set a threshold in percentage within which your product numbers can decrease. If the product number is less than the threshold, the platform takes an action. For example, the platform stops the import and sends you a notification via email or Slack.
How is this guide?