PRprewave
Collections - Tier-N

Get tier-n collection settings

Changed on

Overview

Retrieve tier-n configuration for a collection. These settings are used as defaults when calling GET .../tier-n/data and can be overridden via query parameters there.

Related Operations

  • Data: GET /public/v1/collections/{collectionId}/tier-n/data
  • Update: PUT /public/v1/collections/{collectionId}/tier-n/settings

Required Permission

access_public_supplier_graph, access_collection, and read on the collection.

get/public/v1/collections/{collectionId}/tier-n/settings

Request

Path parameters

collectionIdinteger required

Unique identifier of the tier-n collection. Same as the id from GET /public/v1/collections. The collection must have tiersEnabled=true.

Response

Successfully retrieved tier-n collection settings.

collectionIdinteger required

Unique identifier of the collection. Use this ID in API requests to reference this specific collection.

collectionNamestring required

Human-readable name of the collection. Useful for display purposes and identifying the collection in logs.

maxTierinteger required

Maximum tier level configured for analysis. Range: 1-9. Higher values allow deeper supply chain analysis but may increase response time.

targetIdsinteger[] required

List of target IDs included in this collection. These are the starting points for tier-n analysis.

scopePrivateboolean required

Whether to include private targets in the analysis scope. Private targets typically represent internal company data.

scopeSharedboolean required

Whether to include shared targets in the analysis scope. Shared targets typically represent partner/team data.

scopePublicboolean required

Whether to include public targets in the analysis scope. Public targets typically represent open/public data.

sourceCustomerboolean required

Whether to include customer data sources in the analysis. Customer data comes from customer-provided information.

sourceCustomsboolean required

Whether to include customs data sources in the analysis. Customs data is typically the most reliable source based on shipment records.

sourceMediaboolean required

Whether to include media data sources in the analysis. Media data comes from news reports and may be less reliable.

sourcePrewavePredictionboolean required

Whether to include Prewave prediction data sources in the analysis. These are AI-predicted relationships with confidence scores.

minShipmentsinteger nullable

Minimum number of shipments required for a relationship to be included. Higher values filter out less established relationships. Null means no minimum.

probabilityinteger nullable

Minimum probability threshold for predicted relationships (0-100). Higher values return only high-confidence predictions. Null means no threshold.

shipmentsPeriodFromstring date nullable

Start date for shipment period analysis. Only relationships with shipments in this period are considered. Format: YYYY-MM-DD. Null means no start date limit.

shipmentsPeriodTostring date nullable

End date for shipment period analysis. Only relationships with shipments in this period are considered. Format: YYYY-MM-DD. Null means no end date limit.

suspectedSuppliersboolean required

Deprecated. Whether suspected suppliers are included. Always false when the new commodity filter is enabled for your organization, which will become the default for all organizations.

logisticsProviderboolean required

Whether to include logistics providers in the analysis. Logistics providers are companies that provide logistics services rather than direct suppliers.

commodityFilterTargetIdsinteger[] required

List of target IDs used for commodity-based filtering. These targets help focus the analysis on specific commodity categories.

Example response

{
  "collectionId": 123,
  "collectionName": "My Tier-N Collection",
  "maxTier": 3,
  "targetIds": [
    101,
    102,
    103
  ],
  "scopePrivate": true,
  "scopeShared": true,
  "sourceCustomer": true,
  "sourceCustoms": true,
  "sourcePrewavePrediction": true,
  "minShipments": 5,
  "probability": 75,
  "shipmentsPeriodFrom": "2024-01-01",
  "shipmentsPeriodTo": "2024-12-31",
  "commodityFilterTargetIds": [
    201,
    202
  ]
}

Changes