latestOpenAPI 3.0.12026-08-20112309904.6 KB

466169815b78

Scores - Target

The current score for a target split up into the scoring components, depending on the defined perspective.

⚠️ 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}/score-componentsGET /public/v1/enterprise-export/scoresRetrieve score components

Why Migrate?

The Enterprise Export API (PublicEnterpriseExportController) provides:

  • Score components and subcomponents when includeComponents: true is set in the configuration
  • Bulk retrieval for multiple targets
  • Automated scheduled exports
  • Better performance for large-scale operations

Quick Migration Guide

Step 1: Configure Export Job with Components

Configure your export job to include components:

{
  "runInterval": "DAILY",
  "enabled": true,
  "targetIds": [102006215],
  "perspectiveIds": [1],
  "includeComponents": true
}

Step 2: Retrieve Score Components

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

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

The response includes components and subComponents arrays when includeComponents is enabled.


Current Endpoint Behavior

Required Permission: ACCESS_PUBLIC_TARGET_SCORE

Performance impact: Low

Returns the current score for a target split up into scoring components, including:

  • Component type
  • Component score
  • List of subcomponents with their scores

Supports filtering by:

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

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

Response

Target score components successfully retrieved

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

Score component of the target