Konnect Service Catalog

VulnerabilityCountMetricEvent

object

Payload containing the aggregated vulnerability count metric data and associated dimensions included in the query.

servicestring(uuid)
severitystring

Allowed values:lowmediumhighcritical

Example:low

statestring

Allowed values:openfixeddismissed

Example:dismissed

typestringread-only

Allowed values:container_imagelibrary

Example:container_image

sourcestring

Example:trivy

environmentstring

Example:prod

regionstring

Example:us-east-1

vulnerability_countnumber(int32)required
Example

VulnerabilityMetricsAbsoluteTimeRange

object

A duration representing an exact start and end time.

* Additional properties are NOT allowed.
tzstring

Time zone in IANA Time Zone Database format (e.g., ‘America/New_York’, ‘Europe/London’, ‘Etc/UTC’).
Optional, defaults to UTC when unspecified.

Default:Etc/UTC

Example:America/Chicago

typestringrequired

Allowed values:absolute

startstring(date-time)required

Start of the query time range in RFC-3339 format.

Example:2025-03-30T07:20:50Z

endstring(date-time)required

Start of the query time range in RFC-3339 format.

Example:2025-06-30T08:20:50Z

Example

VulnerabilityMetricsRelativeTimeRange

object

A duration representing a relative-to-now span of time.
The start time is floored to the requested granularity.
The exact start and end timestamps are returned in the result query in the meta.start and meta.end fields.
Example:
7d from now, with 1day granularity initiated at 2024-01-08T17:11:00+05:00 will query for the time range from 2024-01-01T00:00:00+05:00 to 2024-01-08T17:11:00+05:00.

* Additional properties are NOT allowed.
tzstring

Time zone in IANA Time Zone Database format (e.g., ‘America/New_York’, ‘Europe/London’, ‘Etc/UTC’).
Optional, defaults to UTC when unspecified.

Default:Etc/UTC

Example:America/Chicago

typestringrequired

Allowed values:relative

time_rangeOne Of
required
RelativeDayTimeRangestring

Match pattern:^([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-9]{2}|3[0-5][0-9]|36[0-5])d$

Default:30d

Example

VulnerabilitiesMetricsResponseMetadata

object

Metadata about the query response. This includes:

  • The start and end times of the query
  • The granularity of the result
  • Whether the result was truncated
  • The limit of the result
  • The query_id
startstring(date-time)required

Start of the query time range in RFC-3339 format.

Example:2025-03-30T07:20:50Z

start_msnumberrequired

Start of the query time range in epoch format with millisecond precision.

Example:1743319250000

endstring(date-time)required

End of the query time range in RFC-3339 format.

Example:2025-03-30T08:20:50Z

end_msnumberrequired

End of the query time range in epoch format with millisecond precision.

Example:1743322850000

metric_namesarray[string]required

List of vulnerability metric names included in the result.

Allowed values:vulnerability_count

metric_unitsobjectrequired

A mapping of metric names to their associated human-friendly display unit.
The keys are the metric names, and the values are the units.

Show Child Parameters
granularity_msnumberrequired

The number of milliseconds per interval in a time series.

truncatedbooleanrequired

Set to `true`` when the limit of cardinarlity is hit.
For queries with 2 dimensions, the limit truncates the first dimension, and then groups all other groupings for the second dimension.

Example: limit of 2 for service and region would return 2 services maximum, and 2 regions + OTHER.
The _OTHER is representative of all other regions.

limitnumberrequired

The applied cardinality limit.

query_idstringrequired

An ID that can be used to reference the query.

Example:e2a6c0ce-3a90-4b6b-b9bf-cf6428d30ffe

displayobjectrequired

Instructs how to interpret identifiers in the query result.
The structure consists of: dimension -> ID -> entity metadata.
Since entity names within Konnect may overlap, ids are returned and used for exact grouping.
This blob may be used to join and display results in a more human-friendly manner.
Since IDs represent entities in the system at all points in time, historical data will still exist even if an entity is deleted.
These such entities are marked with the deleted: true value.
Another special case is the ____OTHER____ entity.
When the limit of cardinality is reached for a second dimension, the system will group all other entities into the OTHER grouping.
This prevents returning an overwhelming number of long tail entities.

Example:{"service":{"3a564a6a-1952-4181-89f0-a1cadc70123d":{"id":"3a564a6a-1952-4181-89f0-a1cadc70123d","name":"Pricing Svc","deleted":false},"58620e4e-27f4-42eb-9776-402ec319c665":{"id":"58620e4e-27f4-42eb-9776-402ec319c665","name":"Billing Svc","deleted":true}},"state":{"open":{"id":"open","name":"Open","deleted":false},"fixed":{"id":"fixed","name":"Fixed","deleted":false},"dismissed":{"id":"dismissed","name":"Dismissed","deleted":false}}}

Show Child Parameters
Example

StringValueMetricsFilter

object
operatorstringrequired

The type of filter to apply.

  • in filters will limit results to only the specified values
  • not_in filters will exclude the specified values

Allowed values:innot_in

valuearray[string]required
Example