diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index c9b015eda13..b2318bca8f2 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -12266,6 +12266,23 @@ menu: - ListGoogleChatOrganizations unstable: [] order: 7 + - name: Governance Insights + url: /api/latest/governance-insights/ + identifier: governance-insights + generated: true + - name: List governance insights + url: /api/latest/governance-insights/list-governance-insights/ + identifier: governance-insights-list-governance-insights + parent: governance-insights + generated: true + params: + versions: + - v2 + operationids: + - ListGovernanceInsights + unstable: + - v2 + order: 1 - name: High Availability MultiRegion url: /api/latest/high-availability-multiregion/ identifier: high-availability-multiregion diff --git a/content/en/api/latest/governance-insights/_index.md b/content/en/api/latest/governance-insights/_index.md new file mode 100644 index 00000000000..ebd3d8c0506 --- /dev/null +++ b/content/en/api/latest/governance-insights/_index.md @@ -0,0 +1,3 @@ +--- +title: Governance Insights +--- diff --git a/content/en/api/latest/governance-insights/list-governance-insights/index.md b/content/en/api/latest/governance-insights/list-governance-insights/index.md new file mode 100644 index 00000000000..55dc8dbc95c --- /dev/null +++ b/content/en/api/latest/governance-insights/list-governance-insights/index.md @@ -0,0 +1,3 @@ +--- +title: List governance insights +--- diff --git a/content/en/api/v2/governance-insights/_index.md b/content/en/api/v2/governance-insights/_index.md new file mode 100644 index 00000000000..59254ea9917 --- /dev/null +++ b/content/en/api/v2/governance-insights/_index.md @@ -0,0 +1,4 @@ +--- +title: Governance Insights +headless: true +--- diff --git a/content/en/api/v2/governance-insights/examples.json b/content/en/api/v2/governance-insights/examples.json new file mode 100644 index 00000000000..6d29d850ca3 --- /dev/null +++ b/content/en/api/v2/governance-insights/examples.json @@ -0,0 +1,149 @@ +{ + "ListGovernanceInsights": { + "responses": { + "200": { + "json": { + "data": [ + { + "attributes": { + "audit_query": { + "compute": { + "aggregation": "cardinality", + "interval": 86400000, + "metric": "@usr.id", + "rollup": "" + }, + "indexes": [ + "main" + ], + "query": "@evt.name:Dashboard", + "source": "audit" + }, + "best_practice": "", + "deep_link": "", + "description": "Number of users who have used the Dashboard in the last 30 days", + "display_name": "Active Dashboards", + "event_query": { + "compute": { + "aggregation": "count", + "interval": 86400000 + }, + "indexes": [ + "main" + ], + "query": "source:cloudtrail" + }, + "metric_query": { + "query": "avg:system.cpu.user{*}", + "reducer": "avg", + "source": "metrics" + }, + "old_value": 3274, + "percentage_query": { + "denominator_query": { + "query": "avg:system.cpu.user{*}", + "reducer": "avg", + "source": "metrics" + }, + "numerator_query": { + "query": "avg:system.cpu.user{*}", + "reducer": "avg", + "source": "metrics" + } + }, + "product": "Usage", + "query_config": { + "chart_type": "line", + "comparison_shift": "month", + "default_value": 0, + "directionality": "neutral", + "effective_time_window_days": 30 + }, + "sort_order": 1, + "state": "critical", + "sub_product": "Indexes", + "time_range": "month", + "unit_name": "active dashboards", + "usage_query": { + "query": "logs_indexed_events", + "reducer": "sum" + }, + "value": 3601 + }, + "id": "498ee21f-8037-48b8-a961-a488692902f4", + "type": "insight" + } + ] + }, + "html": "
\n
\n
\n
\n

data [required]

\n
\n

[object]

\n

An array of governance insight resources.

\n
\n
\n
\n
\n
\n

attributes [required]

\n
\n

object

\n

The attributes of a governance insight.

\n
\n
\n
\n
\n
\n

audit_query [required]

\n
\n

object

\n

An audit log query used to compute an insight value.

\n
\n
\n
\n
\n
\n

compute [required]

\n
\n

object

\n

The aggregation applied to an audit log query.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

string

\n

The aggregation function to apply.

\n
\n \n
\n
\n
\n
\n
\n

interval [required]

\n
\n

int64

\n

The aggregation time window, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n

metric [required]

\n
\n

string

\n

The metric or attribute to aggregate.

\n
\n \n
\n
\n
\n
\n
\n

rollup

\n
\n

string

\n

An optional secondary aggregation applied to the audit query result.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

indexes [required]

\n
\n

[string]

\n

The audit log indexes the query runs against.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The audit log search query string.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

string

\n

The data source the query runs against.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

best_practice [required]

\n
\n

string

\n

The identifier of the best practice this insight is associated with, if any.

\n
\n \n
\n
\n
\n
\n
\n

deep_link [required]

\n
\n

string

\n

A relative link to the product surface where the insight can be acted upon.

\n
\n \n
\n
\n
\n
\n
\n

description [required]

\n
\n

string

\n

A human-readable description of what the insight measures.

\n
\n \n
\n
\n
\n
\n
\n

display_name [required]

\n
\n

string

\n

Human-readable name of the insight.

\n
\n \n
\n
\n
\n
\n
\n

event_query [required]

\n
\n

object

\n

An event query used to compute an insight value.

\n
\n
\n
\n
\n
\n

compute

\n
\n

object

\n

The aggregation applied to an event query.

\n
\n
\n
\n
\n
\n

aggregation [required]

\n
\n

string

\n

The aggregation function to apply.

\n
\n \n
\n
\n
\n
\n
\n

interval [required]

\n
\n

int64

\n

The aggregation time window, in milliseconds.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

indexes [required]

\n
\n

[string]

\n

The event indexes the query runs against.

\n
\n \n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The event search query string.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

metric_query [required]

\n
\n

object

\n

A metric query used to compute an insight value.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The query string.

\n
\n \n
\n
\n
\n
\n
\n

reducer [required]

\n
\n

string

\n

How the query result series is reduced to a single value.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

string

\n

The data source the query runs against.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

old_value [required]

\n
\n

double

\n

The value of the insight over the previous comparison window. null when values were\nnot requested or could not be computed.

\n
\n \n
\n
\n
\n
\n
\n

percentage_query [required]

\n
\n

object

\n

A percentage query that computes an insight value as a ratio of two metric queries.

\n
\n
\n
\n
\n
\n

denominator_query [required]

\n
\n

object

\n

A metric query used to compute an insight value.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The query string.

\n
\n \n
\n
\n
\n
\n
\n

reducer [required]

\n
\n

string

\n

How the query result series is reduced to a single value.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

string

\n

The data source the query runs against.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

numerator_query [required]

\n
\n

object

\n

A metric query used to compute an insight value.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The query string.

\n
\n \n
\n
\n
\n
\n
\n

reducer [required]

\n
\n

string

\n

How the query result series is reduced to a single value.

\n
\n \n
\n
\n
\n
\n
\n

source [required]

\n
\n

string

\n

The data source the query runs against.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n

product [required]

\n
\n

string

\n

The product the insight belongs to.

\n
\n \n
\n
\n
\n
\n
\n

query_config

\n
\n

object

\n

Query execution context that allows the frontend to execute insight queries directly.

\n
\n
\n
\n
\n
\n

chart_type

\n
\n

string

\n

The chart type the frontend should use to render the insight.

\n
\n \n
\n
\n
\n
\n
\n

comparison_shift [required]

\n
\n

string

\n

The window used for the previous value comparison, for example week or month.

\n
\n \n
\n
\n
\n
\n
\n

default_value

\n
\n

int64

\n

The default value to display when no data is available.

\n
\n \n
\n
\n
\n
\n
\n

directionality

\n
\n

string

\n

Whether an increase in the value is good, bad, or neutral. One of neutral,\nincrease_better, or decrease_better.

\n
\n \n
\n
\n
\n
\n
\n

effective_time_window_days [required]

\n
\n

int64

\n

The number of days the insight value is computed over.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

sort_order

\n
\n

int64

\n

The relative order in which the insight should be displayed.

\n
\n \n
\n
\n
\n
\n
\n

state [required]

\n
\n

string

\n

The state of the insight. A critical insight receives extra UI treatment to draw\nattention to it.

\n
\n \n
\n
\n
\n
\n
\n

sub_product [required]

\n
\n

string

\n

The sub-product the insight belongs to, if any.

\n
\n \n
\n
\n
\n
\n
\n

time_range [required]

\n
\n

string

\n

The time range the insight value is computed over, if applicable.

\n
\n \n
\n
\n
\n
\n
\n

unit_name [required]

\n
\n

string

\n

The unit that the insight's value is measured in.

\n
\n \n
\n
\n
\n
\n
\n

usage_query [required]

\n
\n

object

\n

A usage query used to compute an insight value.

\n
\n
\n
\n
\n
\n

query [required]

\n
\n

string

\n

The usage query string.

\n
\n \n
\n
\n
\n
\n
\n

reducer [required]

\n
\n

string

\n

How the query result series is reduced to a single value.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

value [required]

\n
\n

double

\n

The current value of the insight. null when values were not requested or could not be computed.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

id [required]

\n
\n

string

\n

The unique identifier of the insight.

\n
\n \n
\n
\n
\n
\n
\n

type [required]

\n
\n

enum

\n

JSON:API resource type for a governance insight. \nAllowed enum values: insight

\n
\n \n
\n
\n
\n
" + }, + "400": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "401": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "403": { + "json": { + "errors": [ + { + "detail": "Missing required attribute in body", + "meta": {}, + "source": { + "header": "Authorization", + "parameter": "limit", + "pointer": "/data/attributes/title" + }, + "status": "400", + "title": "Bad Request" + } + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[object]

\n

A list of errors.

\n
\n
\n
\n
\n
\n

detail

\n
\n

string

\n

A human-readable explanation specific to this occurrence of the error.

\n
\n \n
\n
\n
\n
\n
\n

meta

\n
\n

object

\n

Non-standard meta-information about the error

\n
\n \n
\n
\n
\n
\n
\n

source

\n
\n

object

\n

References to the source of the error.

\n
\n
\n
\n
\n
\n

header

\n
\n

string

\n

A string indicating the name of a single request header which caused the error.

\n
\n \n
\n
\n
\n
\n
\n

parameter

\n
\n

string

\n

A string indicating which URI query parameter caused the error.

\n
\n \n
\n
\n
\n
\n
\n

pointer

\n
\n

string

\n

A JSON pointer to the value in the request document that caused the error.

\n
\n \n
\n
\n
\n
\n
\n
\n
\n

status

\n
\n

string

\n

Status code of the response.

\n
\n \n
\n
\n
\n
\n
\n

title

\n
\n

string

\n

Short human-readable summary of the error.

\n
\n \n
\n
\n
\n
" + }, + "429": { + "json": { + "errors": [ + "Bad Request" + ] + }, + "html": "
\n
\n
\n
\n

errors [required]

\n
\n

[string]

\n

A list of errors.

\n
\n \n
\n
" + } + }, + "request": { + "json_curl": {}, + "json": {}, + "html": "" + } + } +} \ No newline at end of file diff --git a/data/api/v2/full_spec.yaml b/data/api/v2/full_spec.yaml index e718c686a0e..d9e2432243c 100644 --- a/data/api/v2/full_spec.yaml +++ b/data/api/v2/full_spec.yaml @@ -40863,6 +40863,306 @@ components: - id - type type: object + GovernanceInsightAttributes: + description: The attributes of a governance insight. + properties: + audit_query: + $ref: "#/components/schemas/GovernanceInsightAuditQuery" + nullable: true + best_practice: + description: The identifier of the best practice this insight is associated with, if any. + example: "" + type: string + deep_link: + description: A relative link to the product surface where the insight can be acted upon. + example: "" + type: string + description: + description: A human-readable description of what the insight measures. + example: "Number of users who have used the Dashboard in the last 30 days" + type: string + display_name: + description: Human-readable name of the insight. + example: "Active Dashboards" + type: string + event_query: + $ref: "#/components/schemas/GovernanceInsightEventQuery" + nullable: true + metric_query: + $ref: "#/components/schemas/GovernanceInsightMetricQuery" + nullable: true + old_value: + description: |- + The value of the insight over the previous comparison window. `null` when values were + not requested or could not be computed. + example: 3274 + format: double + nullable: true + type: number + percentage_query: + $ref: "#/components/schemas/GovernanceInsightPercentageQuery" + nullable: true + product: + description: The product the insight belongs to. + example: "Usage" + type: string + query_config: + $ref: "#/components/schemas/GovernanceInsightQueryConfig" + nullable: true + sort_order: + description: The relative order in which the insight should be displayed. + example: 1 + format: int64 + type: integer + state: + description: |- + The state of the insight. A `critical` insight receives extra UI treatment to draw + attention to it. + example: "critical" + type: string + sub_product: + description: The sub-product the insight belongs to, if any. + example: "Indexes" + type: string + time_range: + description: The time range the insight value is computed over, if applicable. + example: "month" + type: string + unit_name: + description: The unit that the insight's value is measured in. + example: "active dashboards" + type: string + usage_query: + $ref: "#/components/schemas/GovernanceInsightUsageQuery" + nullable: true + value: + description: The current value of the insight. `null` when values were not requested or could not be computed. + example: 3601 + format: double + nullable: true + type: number + required: + - display_name + - product + - best_practice + - sub_product + - unit_name + - description + - time_range + - state + - deep_link + - value + - old_value + - metric_query + - event_query + - usage_query + - audit_query + - percentage_query + type: object + GovernanceInsightAuditCompute: + description: The aggregation applied to an audit log query. + properties: + aggregation: + description: The aggregation function to apply. + example: "cardinality" + type: string + interval: + description: The aggregation time window, in milliseconds. + example: 86400000 + format: int64 + type: integer + metric: + description: The metric or attribute to aggregate. + example: "@usr.id" + type: string + rollup: + description: An optional secondary aggregation applied to the audit query result. + example: "" + type: string + required: + - aggregation + - metric + - interval + type: object + GovernanceInsightAuditQuery: + description: An audit log query used to compute an insight value. + properties: + compute: + $ref: "#/components/schemas/GovernanceInsightAuditCompute" + indexes: + description: The audit log indexes the query runs against. + example: + - "main" + items: + description: An audit log index name. + type: string + type: array + query: + description: The audit log search query string. + example: "@evt.name:Dashboard" + type: string + source: + description: The data source the query runs against. + example: "audit" + type: string + required: + - source + - query + - indexes + - compute + type: object + GovernanceInsightData: + description: A governance insight resource. + properties: + attributes: + $ref: "#/components/schemas/GovernanceInsightAttributes" + id: + description: The unique identifier of the insight. + example: "498ee21f-8037-48b8-a961-a488692902f4" + type: string + type: + $ref: "#/components/schemas/GovernanceInsightResourceType" + required: + - id + - type + - attributes + type: object + GovernanceInsightEventCompute: + description: The aggregation applied to an event query. + properties: + aggregation: + description: The aggregation function to apply. + example: "count" + type: string + interval: + description: The aggregation time window, in milliseconds. + example: 86400000 + format: int64 + type: integer + required: + - aggregation + - interval + type: object + GovernanceInsightEventQuery: + description: An event query used to compute an insight value. + properties: + compute: + $ref: "#/components/schemas/GovernanceInsightEventCompute" + nullable: true + indexes: + description: The event indexes the query runs against. + example: + - "main" + items: + description: An event index name. + type: string + type: array + query: + description: The event search query string. + example: "source:cloudtrail" + type: string + required: + - query + - indexes + type: object + GovernanceInsightMetricQuery: + description: A metric query used to compute an insight value. + properties: + query: + description: The query string. + example: "avg:system.cpu.user{*}" + type: string + reducer: + description: How the query result series is reduced to a single value. + example: "avg" + type: string + source: + description: The data source the query runs against. + example: "metrics" + type: string + required: + - source + - query + - reducer + type: object + GovernanceInsightPercentageQuery: + description: A percentage query that computes an insight value as a ratio of two metric queries. + properties: + denominator_query: + $ref: "#/components/schemas/GovernanceInsightMetricQuery" + numerator_query: + $ref: "#/components/schemas/GovernanceInsightMetricQuery" + required: + - numerator_query + - denominator_query + type: object + GovernanceInsightQueryConfig: + description: Query execution context that allows the frontend to execute insight queries directly. + properties: + chart_type: + description: The chart type the frontend should use to render the insight. + example: "line" + type: string + comparison_shift: + description: The window used for the previous value comparison, for example `week` or `month`. + example: "month" + type: string + default_value: + description: The default value to display when no data is available. + example: 0 + format: int64 + type: integer + directionality: + description: |- + Whether an increase in the value is good, bad, or neutral. One of `neutral`, + `increase_better`, or `decrease_better`. + example: "neutral" + type: string + effective_time_window_days: + description: The number of days the insight value is computed over. + example: 30 + format: int64 + type: integer + required: + - effective_time_window_days + - comparison_shift + type: object + GovernanceInsightResourceType: + description: JSON:API resource type for a governance insight. + enum: + - insight + example: "insight" + type: string + x-enum-varnames: + - INSIGHT + GovernanceInsightUsageQuery: + description: A usage query used to compute an insight value. + properties: + query: + description: The usage query string. + example: "logs_indexed_events" + type: string + reducer: + description: How the query result series is reduced to a single value. + example: "sum" + type: string + required: + - query + - reducer + type: object + GovernanceInsightsDataArray: + description: An array of governance insight resources. + items: + $ref: "#/components/schemas/GovernanceInsightData" + type: array + GovernanceInsightsResponse: + description: A list of governance insights. + properties: + data: + $ref: "#/components/schemas/GovernanceInsightsDataArray" + required: + - data + type: object GreyNoiseAPIKey: description: The definition of the `GreyNoiseAPIKey` object. properties: @@ -132530,6 +132830,122 @@ paths: operator: OR permissions: - user_access_read + /api/v2/governance/insights: + get: + description: |- + Retrieve the list of governance insights available to the organization. By default, only + insight metadata is returned; pass `withValues=true` to also compute and include each + insight's current and previous values. Insights can be filtered by product. + operationId: ListGovernanceInsights + parameters: + - description: |- + Whether to compute and include the current and previous value of each insight. + Defaults to `false`, in which case only insight metadata is returned. + example: true + in: query + name: withValues + required: false + schema: + type: boolean + - description: |- + The UUID of the organization to compute insights for. Defaults to the organization of + the authenticated user. Used to retrieve insights for a child organization from a + parent organization. + example: "11111111-2222-3333-4444-555555555555" + in: query + name: orgUuid + required: false + schema: + type: string + - description: |- + Restrict the results to insights belonging to the given products. May be repeated to + filter by multiple products. Matching is case-insensitive. + example: + - "Usage" + - "Logs Settings" + in: query + name: filter[product] + required: false + schema: + items: + type: string + type: array + responses: + "200": + content: + application/json: + examples: + default: + value: + data: + - attributes: + audit_query: + best_practice: "" + deep_link: "" + description: "" + display_name: "Active Dashboards" + event_query: + metric_query: + old_value: 3274 + percentage_query: + product: "Usage" + state: "" + sub_product: "" + time_range: "" + unit_name: "active dashboards" + usage_query: + value: 3601 + id: "498ee21f-8037-48b8-a961-a488692902f4" + type: "insight" + - attributes: + audit_query: + best_practice: "" + deep_link: "" + description: "Number of users who have used the Dashboard in the last 30 days" + display_name: "Active Users" + event_query: + metric_query: + old_value: 1173 + percentage_query: + product: "Usage" + state: "" + sub_product: "" + time_range: "month" + unit_name: "active users" + usage_query: + value: 1291 + id: "a3248d1b-5578-4345-a34e-fe9657300f22" + type: "insight" + schema: + $ref: "#/components/schemas/GovernanceInsightsResponse" + description: OK + "400": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Bad Request + "401": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Unauthorized + "403": + content: + application/json: + schema: + $ref: "#/components/schemas/JSONAPIErrorResponse" + description: Forbidden + "429": + $ref: "#/components/responses/TooManyRequestsResponse" + summary: List governance insights + tags: + - Governance Insights + x-menu-order: 1 + x-unstable: |- + **Note**: This endpoint is in preview and is subject to change. + If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/). /api/v2/hamr: get: description: |- @@ -192356,6 +192772,12 @@ tags: description: For more information about the Datadog Google Chat integration, see the integration page. url: https://docs.datadoghq.com/integrations/google-hangouts-chat/ name: Google Chat Integration + - description: |- + Governance Insights surface key usage, configuration, and best-practice signals for an + organization within the Governance Console. Each insight reports a current value (and, + optionally, a previous value for comparison) along with the query used to compute it, so + that the Console can render trends and highlight areas that need attention. + name: Governance Insights - description: |- Configure High Availability Multi-Region (HAMR) connections between Datadog organizations. HAMR provides disaster recovery capabilities by maintaining synchronized data between primary diff --git a/data/api/v2/translate_actions.json b/data/api/v2/translate_actions.json index d5cc774f12f..4b9811bcdfc 100644 --- a/data/api/v2/translate_actions.json +++ b/data/api/v2/translate_actions.json @@ -1932,6 +1932,10 @@ "description": "Returns organizations across regions for the authenticated user. The `user_handle` query parameter must match the authenticated user's handle.", "summary": "List global orgs" }, + "ListGovernanceInsights": { + "description": "Retrieve the list of governance insights available to the organization. By default, only\ninsight metadata is returned; pass `withValues=true` to also compute and include each\ninsight's current and previous values. Insights can be filtered by product.", + "summary": "List governance insights" + }, "GetHamrOrgConnection": { "description": "Retrieve the High Availability Multi-Region (HAMR) organization connection details for the authenticated organization.\nThis endpoint returns information about the HAMR connection configuration, including the target organization,\ndatacenter, status, and whether this is the primary or secondary organization in the HAMR relationship.", "summary": "Get HAMR organization connection" diff --git a/data/api/v2/translate_tags.json b/data/api/v2/translate_tags.json index b3868a62e1b..1c256dbf033 100644 --- a/data/api/v2/translate_tags.json +++ b/data/api/v2/translate_tags.json @@ -223,6 +223,10 @@ "name": "Google Chat Integration", "description": "Configure your [Datadog Google Chat integration](https://docs.datadoghq.com/integrations/google-hangouts-chat/)\ndirectly through the Datadog API." }, + "governance-insights": { + "name": "Governance Insights", + "description": "Governance Insights surface key usage, configuration, and best-practice signals for an\norganization within the Governance Console. Each insight reports a current value (and,\noptionally, a previous value for comparison) along with the query used to compute it, so\nthat the Console can render trends and highlight areas that need attention." + }, "high-availability-multiregion": { "name": "High Availability MultiRegion", "description": "Configure High Availability Multi-Region (HAMR) connections between Datadog organizations.\nHAMR provides disaster recovery capabilities by maintaining synchronized data between primary\nand secondary organizations across different datacenters."