Get Score Trend

Returns score trend over a time range, bucketed by the requested granularity.

GET /api/data-readiness/metrics/trend

Get Score Trend

cURL

curl --request GET \
  --url https://api.example.com/api/data-readiness/metrics/trend \
  --header 'Authorization: Bearer <token>'

200

{
  "scope": "<string>",
  "entity": {
    "service": "production_db",
    "database_name": "analytics",
    "schema_name": "public",
    "table_name": "customers"
  },
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "granularity": "<string>",
  "data_points": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "overall_score": "0.82",
      "dimensions": [
        {
          "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "score": "0.85",
          "weight": "<string>"
        }
      ]
    }
  ]
}

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.

Query Parameters

start_date · string<date-time> · required

Start of the time range (ISO 8601)

end_date · string<date-time> · required

End of the time range (ISO 8601)

granularity · enum<string> · default: day

Time bucket granularity

Available options: day, week, month

asset_fqn · string | null

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

assessment_type · string | null

Filter by assessment type

weight_overrides · string | null

JSON object mapping dimension UUIDs to weights, e.g. {"": 0.5}

Response

200

application/json

Successful Response

Score trend over a time range.

scope · string · required

Scope level of the trend

Example:

"service"

entity · EntityIdentifier · object · required

Entity identifier for the scope

Show child attributes

start_date · string<date-time> · required

Start of the time range (ISO 8601)

Example:

"2024-01-01T00:00:00Z"

end_date · string<date-time> · required

End of the time range (ISO 8601)

Example:

"2024-01-31T23:59:59Z"

granularity · string · required

Time bucket granularity

Examples:

"day"

"week"

"month"

data_points · TrendDataPoint · object[] · required

Trend data points

Show child attributes