latestOpenAPI 3.0.12026-08-20112309904.6 KB

466169815b78

Scores - Target

Returns the target score including the overall score and scores for all infotag-groups.

⚠️ DEPRECATED - This endpoint is deprecated and will be removed at the end of December 2026.

Note: Responses include a Sunset HTTP header (RFC 8594) indicating the removal date.


Migration Required

This endpoint has been deprecated in favor of the Enterprise Export API. Please migrate to the new endpoint:

Replacement Endpoint

Old EndpointNew EndpointPurpose
GET /public/v1/target/{systemId}/{targetId}/scoreGET /public/v1/enterprise-export/scoresRetrieve score data

Why Migrate?

The Enterprise Export API (PublicEnterpriseExportController) provides significant improvements:

1. Bulk Operations

  • Retrieve scores for multiple targets in a single request
  • More efficient for large-scale integrations

2. Automated Updates

  • Configure scheduled exports that run automatically
  • No need to poll individual endpoints

3. Better Performance

  • Optimized for large-scale data retrieval
  • Consistent data calculation timestamps

4. Error Handling

  • Detailed error logs for failed calculations
  • Better visibility into data quality issues

Quick Migration Guide

Step 1: Configure Export Job

Use POST /public/v1/enterprise-export/scores/config to set up your export configuration:

{
  "runInterval": "DAILY",
  "enabled": true,
  "collectionIds": [123, 456],
  "targetIds": [102006215, 101641243],
  "perspectiveIds": [1, 2],
  "includeComponents": true
}

Step 2: Retrieve Scores

Use GET /public/v1/enterprise-export/scores to retrieve score data:

GET /public/v1/enterprise-export/scores?page=0&size=20

The response includes all the same information as this endpoint, plus additional metadata:

  • Calculation timestamps
  • Risk levels
  • Edge numbers for target identification

Current Endpoint Behavior

Required Permission: ACCESS_PUBLIC_TARGET_SCORE

Performance impact: Low

Returns the target score including:

  • Overall target score
  • Scores for all infotag groups

Supports filtering by:

  • Perspective ID (optional, defaults to user's perspective)
  • Group ID (optional)
  • Component (optional)
  • Subcomponent (optional)
get/public/v1/target/{systemId}/{targetId}/score

Path parameters

systemIdstring required

The system ID is an identifier to determine from which the targetId might originate from. Supported systemIds are "prewave", "customer", "supplier", "own".

targetIdstring required

The target ID can be the target's prewaveId or an external id (edge number) representing the site in another system.

Query parameters

perspectiveIdinteger

Id of the perspective, that should be used to calculate the target-score.

groupIdinteger

Id of the group that items should be returned

component'PeerScore' | 'AlertScore' | 'SSAScore' | 'ExternalScore' | 'TierNScore'

Score component of the target

Filter by score component

subcomponent'CountryScore' | 'IndustryScore' | 'CommodityScore' | 'PublicAlertScore' | 'CustomerAlertScore' | 'InternalScore' | 'TierNIndustryScore' | 'TierNCommodityScore' | 'TargetScore'

Score subcomponent of the target

Filter by score subcomponent

Response

Target score successfully retrieved