Platform setup
How to access data in the Export API, set up a sandbox environment, and configure the Export API Destination.
This page explains how to set up the Export API Destination in the platform and get data flowing to the Export API infrastructure.
How to access data in the Export API
The Export API data resides on a separate infrastructure. The Export API behaves like any other Destination: once you set up the Destination for a specific channel, trigger an export. The export executes the Export API Destination and pushes data to the Export API infrastructure. From that point on, the data is available for querying.
How to set up a sandbox environment for the Export API
This section requires a sandbox project in the platform. If you don't have one, contact your Client Success Manager.
- Log in to the Platform.
- Go to your sandbox project.
- Ensure you have a site with data available — an existing or new sandbox site works. The following prerequisites must be satisfied:
- The site must have a data source to import data from.
- Mapping of columns in the data view must be set up.
- A channel must be created for the Export API (any channel works).
- Validate, using the data view, that you have data available in your channel.
The Export API Destination must be unlocked by Productsup. See Onboarding requirements for more details.
- Contact Productsup to have your Export API Destination set up — your Client Success Manager or our Tech Support team can help.
- Once the Export API Destination is added, it appears in the Destinations list of your channel.
- Retrieve the URL and Token by editing the Export API Destination. See Destination settings.
- Verify that the Export API Destination is active; if not, set it to active.
- Run an export of the current channel to populate the Export API.
- Follow up with:
- How to integrate the Export API — authentication and API URL details.
- Filtering — how to filter and query data.
How to set up the Export API Destination
The Export API Destination must be unlocked by Productsup. See Onboarding requirements for more details.
- Log in to the Platform.
- Set up a channel and go to the Channel settings page.
- Select Add Destination.
- Select the Destination called Export API.
- Select Save. The page reloads and shows the Destination settings page.
- The Destination is now set up and ready to test.
- Go back to the Channel settings page and select Export this export to trigger the export for this channel and execute the Destination.
- Verify that the data is available in the Export API.
Destination settings
The Destination settings page shows two read-only properties containing the information you need to access your data via the Export API.
- Export API URL — The full URL to access the product set exported by this Destination.
- Export API Token — The authentication token required to make requests to the Export API.
The URL and Token are unique to each Destination. If you have multiple channels, each with its own Export API Destination, each has its own URL and Token.
Two toggles on this page control additional filtering options for the export.
- Exclude Skipped Products — When enabled, products skipped by ruleboxes are not visible in the export.
- Exclude Internal Attributes — When enabled, internal attributes (prefixed by
___) are not visible in the export.
These toggles let you fine-tune the exported dataset for cleaner and more relevant output.
How is this guide?