Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves a scorecard by its unique identifier (ID).

Parameters

ParameterDescription
Component IDThe unique internal component’s ID. Can be retrieved using “List Components”.
Scorecard IDThe unique internal scorecard’s ID. Can be retrieved using “List Component Scorecards”.

Example Output

{
	"data": {
		"compass": {
			"scorecard": {
				"id": "<string>",
				"name": "<string>",
				"description": "<string>",
				"componentTypeIds": [
					"<string>",
					"<string>"
				],
				"importance": "<string>",
				"componentLabels": [],
				"scorecardScore": {
					"totalScore": 16,
					"maxTotalScore": 170
				},
				"criterias": [
					{
						"id": "<string>",
						"weight": 40,
						"scorecardCriteriaScore": {
							"score": 1,
							"maxScore": 25
						},
						"comparatorValue": 110,
						"comparator": "<string>",
						"metricDefinition": {
							"id": "<string>",
							"type": "<string>",
							"name": "<string>",
							"format": {
								"suffix": "<string>"
							}
						}
					},
					{
						"id": "<string>",
						"weight": 57,
						"scorecardCriteriaScore": {
							"score": 1,
							"maxScore": 35
						},
						"comparatorValue": 22,
						"comparator": "<string>",
						"metricDefinition": {
							"id": "<string>",
							"type": "<string>",
							"name": "<string>",
							"format": {
								"suffix": "<string>"
							}
						}
					}
				],
				"appliedToComponents": {
					"totalCount": 1
				},
				"owner": {
					"name": "<string>",
					"picture": "<string>"
				}
			}
		}
	},
	"extensions": {
		"gateway": {
			"request_id": "<string>",
			"crossRegion": false,
			"edgeCrossRegion": false
		}
	}
}

Workflow Library Example

Get Component Scorecard with Compass and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop