Skip to main content
Version: 1.1.4

Bulk Data API Overview

Overview of the API​

The Bulk Data API allows for efficient generation of large supply chain maps in CSV format. With a company name (matched to a Versed AI identifier), our platform will create a complete sub tier map, retrieving up to 10's of thousands of the connected sub suppliers and their tiers from our knowledge graph. Bulk API requests generate a link to the dataset which can then be downloaded at a time in the future.

When to use it​

The Supply Chain API endpoints are effective when querying and filtering for customers and suppliers of individual companies but requires some programming to query in an iterative way to generate supply maps which uncover multipler sub tiers. The Bulk Data API solves this by automatically iterating to extract relationships makes the suppliers and relationships available in a large CSV file for download.

Features​

As of v1.1.2, the API provides two new features, which both need to be used to create a bulk data set:

  • Tier View Job Runner: The tier view job endpoint starts a long running query on the Versed AI platform which produces a CSV dataset of sub tier suppliers. Since the volume of data produced via the bulk API can be high, the results can not be returned immediately. Instead, a run identifer is returned which can be used to query the status of the process.

  • Job Status: After starting the tier view query, calling the Job Status endpoint with the run identifier will retrieve the status of the process. Once the process is complete, the status will also return a link to download the CSV data set. Expect runs to take in the order of 5 to 10 minutes.

Considerations​

As of v1.1.2, the Bulk API:

  • has limits on the number of concurrent runs. If the limits are reach, the job status will show a skipped run. The best course of action is to wait and submit another tier view job. Runs submitted when limits are reached will not be queued for future processing.
  • has limits on the number of root companies to map. To map multiple companies, multiple job calls are needed.