API ReferenceProject Entity

Project Entity Supply Chain Summary

Beta

Execute a traversal of the upstream trade network (supply chain) for all matched entities of a project entity, returning a summary of countries, risks, and components.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

project_idstringRequired
The project Identifier
project_entity_idstringRequired
The project entity Identifier

Query parameters

productlist of stringsOptional

Product root edge filter. Filters results to include only trade relationships where the associated component is part of the specified product’s blueprint or is a sub-component of that product.

-productlist of stringsOptional

Product root edge filter. Filters results to exclude any trade relationships where the associated component is part of the specified product’s blueprint or is a sub-component of that product.

risk_factorslist of enumsOptional

Risk leaf node filter. Only return supply chains that end with a supplier that has 1+ of the specified risk factors.

-risk_factorslist of enumsOptional
Risk leaf node filter. Only return supply chains that end with a supplier that has none of the specified risk factors.
countrieslist of enumsOptional

Country leaf node filter. Only return supply chains that end with a supplier in 1+ of the specified countries.

-countrieslist of enumsOptional
Country leaf node filter. Only return supply chains that end with a supplier in none of the specified countries.
componentlist of stringsOptional

Component edge filter. Only return supply chains that contain at least one edge with 1+ of the specified HS codes.

-componentlist of stringsOptional
Component edge filter. Only return supply chains that contain no edges with any of the specified HS codes.
min_datestringOptional

Minimum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are greater than or equal to this date.

max_datestringOptional

Maximum date edge filter in <YYYY-MM-DD> format. Only return supply chains with edge dates that are less than or equal to this date.

max_depthintegerOptional
The maximum depth of the traversal, from 1 to 4 inclusive. Default is 4. Reduce if query is timing out.
limitintegerOptional
The maximum number of results to return. Default is no limit.

Response

This endpoint returns an object.
filtersobject
dataobject

Errors