Skip to main content
POST
/
api
/
data-readiness
/
metrics
/
scorecard
Get Aggregated Scorecard
curl --request POST \
  --url https://api.example.com/api/data-readiness/metrics/scorecard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "asset_fqn": "<string>",
  "as_of": "2023-11-07T05:31:56Z",
  "workflow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "weight_overrides": {}
}
'
{
  "overall_score": "0.82",
  "scope": "<string>",
  "entity": {
    "service": "production_db",
    "database_name": "analytics",
    "schema_name": "public",
    "table_name": "customers"
  },
  "dimensions": [
    {
      "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "fqn": "<string>",
      "assessment_type": "<string>",
      "weight": "<string>",
      "numerator": 123,
      "denominator": 123,
      "score": "0.85",
      "metrics": [
        {
          "metric_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "fqn": "<string>",
          "numerator": 123,
          "denominator": 123,
          "score": "0.85",
          "asset_count": 123,
          "display_name": "Has Description",
          "unit": "percent",
          "purpose": "<string>",
          "description": "<string>"
        }
      ],
      "display_name": "Completeness",
      "purpose": "<string>",
      "description": "<string>"
    }
  ],
  "as_of": "2024-01-15T10:30:00Z",
  "workflow_run_id": "550e8400-e29b-41d4-a716-446655440023"
}

Documentation Index

Fetch the complete documentation index at: https://docs.emergence.ai/llms.txt

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

Authorizations

​
Authorization
string
header
required

JWT Bearer token authentication. Include the token in the Authorization header as: Authorization: Bearer <token>. The JWT must contain valid client_id, and project_id claims for tenant isolation and SDK routing.

Body

application/json

Request body for the scorecard endpoint.

​
asset_fqn
string | null

Fully qualified name to scope the scorecard (e.g. service.database.schema.table)

​
assessment_type
enum<string> | null

Filter by assessment type

Available options:
metadata,
data_quality
​
as_of
string<date-time> | null

Point-in-time snapshot cutoff (ISO 8601)

​
workflow_run_id
string<uuid> | null

Filter to a specific workflow run

​
weight_overrides
Weight Overrides · object

Mapping of dimension UUIDs to custom weights

Response

Successful Response

Aggregated scores at the requested scope.

​
overall_score
string | null
required

Weighted overall score across all dimensions

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Example:

"0.82"

​
scope
string
required

Scope level of the scorecard

Examples:

"service"

"database"

"schema"

"table"

​
entity
EntityIdentifier · object
required

Entity identifier for the scope

​
dimensions
DimensionScore · object[]
required

Scores for each dimension

​
as_of
string<date-time> | null

Point-in-time snapshot cutoff (ISO 8601)

Example:

"2024-01-15T10:30:00Z"

​
workflow_run_id
string<uuid> | null

Workflow run ID if filtering to a specific run

Example:

"550e8400-e29b-41d4-a716-446655440023"