diff --git a/config/_default/menus/api.en.yaml b/config/_default/menus/api.en.yaml index 3ff3dc8fb1b..0a6f91d5d09 100644 --- a/config/_default/menus/api.en.yaml +++ b/config/_default/menus/api.en.yaml @@ -6555,6 +6555,102 @@ menu: url: /api/latest/app-builder/ identifier: app-builder generated: true + - name: List App Versions + url: '#list-app-versions' + identifier: app-builder-list-app-versions + parent: app-builder + generated: true + params: + versions: + - v2 + operationids: + - ListAppVersions + unstable: [] + order: 13 + - name: Name App Version + url: '#name-app-version' + identifier: app-builder-name-app-version + parent: app-builder + generated: true + params: + versions: + - v2 + operationids: + - UpdateAppVersionName + unstable: [] + order: 14 + - name: Update App Tags + url: '#update-app-tags' + identifier: app-builder-update-app-tags + parent: app-builder + generated: true + params: + versions: + - v2 + operationids: + - UpdateAppTags + unstable: [] + order: 12 + - name: Update App Self-Service Status + url: '#update-app-self-service-status' + identifier: app-builder-update-app-self-service-status + parent: app-builder + generated: true + params: + versions: + - v2 + operationids: + - UpdateAppSelfService + unstable: [] + order: 11 + - name: Revert App + url: '#revert-app' + identifier: app-builder-revert-app + parent: app-builder + generated: true + params: + versions: + - v2 + operationids: + - RevertApp + unstable: [] + order: 16 + - name: Create Publish Request + url: '#create-publish-request' + identifier: app-builder-create-publish-request + parent: app-builder + generated: true + params: + versions: + - v2 + operationids: + - CreatePublishRequest + unstable: [] + order: 15 + - name: Update App Protection Level + url: '#update-app-protection-level' + identifier: app-builder-update-app-protection-level + parent: app-builder + generated: true + params: + versions: + - v2 + operationids: + - UpdateProtectionLevel + unstable: [] + order: 10 + - name: Update App Favorite Status + url: '#update-app-favorite-status' + identifier: app-builder-update-app-favorite-status + parent: app-builder + generated: true + params: + versions: + - v2 + operationids: + - UpdateAppFavorite + unstable: [] + order: 9 - name: Publish App url: '#publish-app' identifier: app-builder-publish-app @@ -8171,6 +8267,110 @@ menu: - ListCustomCostsFiles unstable: [] order: 29 + - name: Get commitments utilization (timeseries) + url: '#get-commitments-utilization-timeseries' + identifier: cloud-cost-management-get-commitments-utilization-timeseries + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - GetCommitmentsUtilizationTimeseries + unstable: + - v2 + order: 53 + - name: Get commitments utilization (scalar) + url: '#get-commitments-utilization-scalar' + identifier: cloud-cost-management-get-commitments-utilization-scalar + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - GetCommitmentsUtilizationScalar + unstable: + - v2 + order: 48 + - name: Get commitments savings (timeseries) + url: '#get-commitments-savings-timeseries' + identifier: cloud-cost-management-get-commitments-savings-timeseries + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - GetCommitmentsSavingsTimeseries + unstable: + - v2 + order: 52 + - name: Get commitments savings (scalar) + url: '#get-commitments-savings-scalar' + identifier: cloud-cost-management-get-commitments-savings-scalar + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - GetCommitmentsSavingsScalar + unstable: + - v2 + order: 51 + - name: Get commitments on-demand hot spots (scalar) + url: '#get-commitments-on-demand-hot-spots-scalar' + identifier: cloud-cost-management-get-commitments-on-demand-hot-spots-scalar + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - GetCommitmentsOnDemandHotspotsScalar + unstable: + - v2 + order: 50 + - name: Get commitments coverage (timeseries) + url: '#get-commitments-coverage-timeseries' + identifier: cloud-cost-management-get-commitments-coverage-timeseries + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - GetCommitmentsCoverageTimeseries + unstable: + - v2 + order: 54 + - name: Get commitments coverage (scalar) + url: '#get-commitments-coverage-scalar' + identifier: cloud-cost-management-get-commitments-coverage-scalar + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - GetCommitmentsCoverageScalar + unstable: + - v2 + order: 49 + - name: Get commitments list + url: '#get-commitments-list' + identifier: cloud-cost-management-get-commitments-list + parent: cloud-cost-management + generated: true + params: + versions: + - v2 + operationids: + - GetCommitmentsCommitmentList + unstable: + - v2 + order: 55 - name: List budgets url: '#list-budgets' identifier: cloud-cost-management-list-budgets @@ -13984,6 +14184,54 @@ menu: - ListSCIMUsers unstable: [] order: 1 + - name: Get schema + url: '#get-schema' + identifier: scim-get-schema + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - GetSCIMSchema + unstable: [] + order: 16 + - name: List schemas + url: '#list-schemas' + identifier: scim-list-schemas + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - ListSCIMSchemas + unstable: [] + order: 15 + - name: Get resource type + url: '#get-resource-type' + identifier: scim-get-resource-type + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - GetSCIMResourceType + unstable: [] + order: 14 + - name: List resource types + url: '#list-resource-types' + identifier: scim-list-resource-types + parent: scim + generated: true + params: + versions: + - v2 + operationids: + - ListSCIMResourceTypes + unstable: [] + order: 13 - name: Update group url: '#update-group' identifier: scim-update-group diff --git a/config/_default/menus/main.en.yaml b/config/_default/menus/main.en.yaml index 7a4a4f7866c..51029807c85 100644 --- a/config/_default/menus/main.en.yaml +++ b/config/_default/menus/main.en.yaml @@ -7550,11 +7550,16 @@ menu: url: /security/code_security/secret_scanning/generic_ci_providers/ parent: sec_secret_scanning weight: 2 + - name: Rule Configuration + identifier: sec_secret_scanning_configuration + url: /security/code_security/secret_scanning/configuration/ + parent: sec_secret_scanning + weight: 3 - name: Secret Validation identifier: sec_secret_scanning_secret_validation url: /security/code_security/secret_scanning/secret_validation/ parent: sec_secret_scanning - weight: 3 + weight: 4 - name: Runtime Code Analysis (IAST) identifier: sec_iast url: /security/code_security/iast/ diff --git a/content/en/account_management/guide/manage-your-support-tickets.md b/content/en/account_management/guide/manage-your-support-tickets.md index a96933b8f59..c6d64ca36d9 100644 --- a/content/en/account_management/guide/manage-your-support-tickets.md +++ b/content/en/account_management/guide/manage-your-support-tickets.md @@ -81,6 +81,11 @@ further_reading:
If your browser has ad-blockers, turn them off to see if this allows you to sign in. Some ad-blockers have their own list of exceptions. In this case, add datadog.zendesk.com to the allow list.
+Datadog deletes closed tickets, including their attachments, 15 months after their last update.
+ +If you need help with a related issue, you can open a new ticket or search the Datadog documentation.
+errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for updating an app's favorite status.
attributes
\nobject
Attributes for updating an app's favorite status.
favorite [required]
\nboolean
Whether the app should be marked as a favorite for the current user.
type
\nenum
The favorite resource type. \nAllowed enum values: favorites
default: favorites
data
\nobject
The data object containing the updated app definition.
attributes [required]
\nobject
The updated app definition attributes, such as name, description, and components.
components
\n[object]
The UI components that make up the app.
events
\n[object]
Events to listen for on the grid component.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id
\nstring
The ID of the grid component. This property is deprecated; use name to identify individual components instead.
name [required]
\nstring
A unique identifier for this grid component. This name is also visible in the app editor.
properties [required]
\nobject
Properties of a grid component.
backgroundColor
\nstring
The background color of the grid.
default: default
children
\n[object]
The child components of the grid.
events
\n[object]
Events to listen for on the UI component.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id
\nstring
The ID of the UI component. This property is deprecated; use name to identify individual components instead.
name [required]
\nstring
A unique identifier for this UI component. This name is also visible in the app editor.
properties [required]
\nobject
Properties of a UI component. Different component types can have their own additional unique properties. See the components documentation for more detail on each component type and its properties.
children
\n[object]
The child components of the UI component.
isVisible
\n<oneOf>
Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
type [required]
\nenum
The UI component type. \nAllowed enum values: table,textInput,textArea,button,text,select,modal,schemaForm,checkbox,tabsShow 10 more
,vegaChart,radioButtons,numberInput,fileInput,jsonInput,gridCell,dateRangePicker,search,container,calloutValue
isVisible
\n<oneOf>
Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean.
Option 1
\nstring
Option 2
\nboolean
default: true
type [required]
\nenum
The grid component type. \nAllowed enum values: grid
default: grid
description
\nstring
The human-readable description for the app.
favorite
\nboolean
Whether the app is marked as a favorite by the current user.
name
\nstring
The name of the app.
queries
\n[ <oneOf>]
An array of queries, such as external actions and state variables, that the app uses.
Option 1
\nobject
An action query. This query type is used to trigger an action, such as sending a HTTP request.
events
\n[object]
Events to listen for downstream of the action query.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id [required]
\nuuid
The ID of the action query.
name [required]
\nstring
A unique identifier for this action query. This name is also used to access the query's result throughout the app.
properties [required]
\nobject
The properties of the action query.
condition
\n<oneOf>
Whether to run this query. If specified, the query will only run if this condition evaluates to true in JavaScript and all other conditions are also met.
Option 1
\nboolean
Option 2
\nstring
debounceInMs
\n<oneOf>
The minimum time in milliseconds that must pass before the query can be triggered again. This is useful for preventing accidental double-clicks from triggering the query multiple times.
Option 1
\ndouble
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a number.
mockedOutputs
\n<oneOf>
The mocked outputs of the action query. This is useful for testing the app without actually running the action.
Option 1
\nstring
Option 2
\nobject
The mocked outputs of the action query.
enabled [required]
\n<oneOf>
Whether to enable the mocked outputs for testing.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
outputs
\nstring
The mocked outputs of the action query, serialized as JSON.
onlyTriggerManually
\n<oneOf>
Determines when this query is executed. If set to false, the query will run when the app loads and whenever any query arguments change. If set to true, the query will only run when manually triggered from elsewhere in the app.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
outputs
\nstring
The post-query transformation function, which is a JavaScript function that changes the query's .outputs property after the query's execution.
pollingIntervalInMs
\n<oneOf>
If specified, the app will poll the query at the specified interval in milliseconds. The minimum polling interval is 15 seconds. The query will only poll when the app's browser tab is active.
Option 1
\ndouble
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a number.
requiresConfirmation
\n<oneOf>
Whether to prompt the user to confirm this query before it runs.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
showToastOnError
\n<oneOf>
Whether to display a toast to the user when the query returns an error.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
spec [required]
\n<oneOf>
The definition of the action query.
Option 1
\nstring
Option 2
\nobject
The action query spec object.
connectionGroup
\nobject
The connection group to use for an action query.
id
\nuuid
The ID of the connection group.
tags
\n[string]
The tags of the connection group.
connectionId
\nstring
The ID of the custom connection to use for this action query.
fqn [required]
\nstring
The fully qualified name of the action type.
inputs
\n<oneOf>
The inputs to the action query. These are the values that are passed to the action when it is triggered.
Option 1
\nstring
Option 2
\nobject
The inputs to the action query. See the Actions Catalog for more detail on each action and its inputs.
type [required]
\nenum
The action query type. \nAllowed enum values: action
default: action
Option 2
\nobject
A data transformer, which is custom JavaScript code that executes and transforms data when its inputs change.
id [required]
\nuuid
The ID of the data transformer.
name [required]
\nstring
A unique identifier for this data transformer. This name is also used to access the transformer's result throughout the app.
properties [required]
\nobject
The properties of the data transformer.
outputs
\nstring
A JavaScript function that returns the transformed data.
type [required]
\nenum
The data transform type. \nAllowed enum values: dataTransform
default: dataTransform
Option 3
\nobject
A variable, which can be set and read by other components in the app.
id [required]
\nuuid
The ID of the state variable.
name [required]
\nstring
A unique identifier for this state variable. This name is also used to access the variable's value throughout the app.
properties [required]
\nobject
The properties of the state variable.
defaultValue
\nThe default value of the state variable.
type [required]
\nenum
The state variable type. \nAllowed enum values: stateVariable
default: stateVariable
rootInstanceName
\nstring
The name of the root component of the app. This must be a grid component that contains all other components.
tags
\n[string]
A list of tags for the app, which can be used to filter apps.
id [required]
\nuuid
The ID of the updated app.
type [required]
\nenum
The app definition type. \nAllowed enum values: appDefinitions
default: appDefinitions
included
\n[object]
Data on the version of the app that was published.
attributes
\nobject
The attributes object containing the version ID of the published app.
app_version_id
\nuuid
The version ID of the app that was published. For an unpublished app, this is always the nil UUID (00000000-0000-0000-0000-000000000000).
id
\nuuid
The deployment ID.
meta
\nobject
Metadata object containing the publication creation information.
created_at
\ndate-time
Timestamp of when the app was published.
user_id
\nint64
The ID of the user who published the app.
user_name
\nstring
The name (or email address) of the user who published the app.
user_uuid
\nuuid
The UUID of the user who published the app.
type
\nenum
The deployment type. \nAllowed enum values: deployment
default: deployment
meta
\nobject
Metadata of an app.
created_at
\ndate-time
Timestamp of when the app was created.
deleted_at
\ndate-time
Timestamp of when the app was deleted.
org_id
\nint64
The Datadog organization ID that owns the app.
updated_at
\ndate-time
Timestamp of when the app was last updated.
updated_since_deployment
\nboolean
Whether the app was updated since it was last published. Published apps are pinned to a specific version and do not automatically update when the app is updated.
user_id
\nint64
The ID of the user who created the app.
user_name
\nstring
The name (or email address) of the user who created the app.
user_uuid
\nuuid
The UUID of the user who created the app.
version
\nint64
The version number of the app. This starts at 1 and increments with each update.
relationship
\nobject
The app's publication relationship and custom connections.
connections
\n[object]
Array of custom connections used by the app.
attributes
\nobject
The custom connection attributes.
name
\nstring
The name of the custom connection.
onPremRunner
\nobject
Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner.
id
\nstring
The Private Action Runner ID.
url
\nstring
The URL of the Private Action Runner.
id
\nuuid
The ID of the custom connection.
type
\nenum
The custom connection type. \nAllowed enum values: custom_connections
default: custom_connections
deployment
\nobject
Information pointing to the app's publication status.
data
\nobject
Data object containing the deployment ID.
id
\nuuid
The deployment ID.
type
\nenum
The deployment type. \nAllowed enum values: deployment
default: deployment
meta
\nobject
Metadata object containing the publication creation information.
created_at
\ndate-time
Timestamp of when the app was published.
user_id
\nint64
The ID of the user who published the app.
user_name
\nstring
The name (or email address) of the user who published the app.
user_uuid
\nuuid
The UUID of the user who published the app.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for updating an app's publication protection level.
attributes
\nobject
Attributes for updating an app's publication protection level.
protectionLevel [required]
\nenum
The publication protection level of the app. approval_required means changes must go through an approval workflow before being published. \nAllowed enum values: direct_publish,approval_required
type
\nenum
The protection-level resource type. \nAllowed enum values: protectionLevel
default: protectionLevel
data
\nobject
The version of the app that was published.
attributes
\nobject
The attributes object containing the version ID of the published app.
app_version_id
\nuuid
The version ID of the app that was published. For an unpublished app, this is always the nil UUID (00000000-0000-0000-0000-000000000000).
id
\nuuid
The deployment ID.
meta
\nobject
Metadata object containing the publication creation information.
created_at
\ndate-time
Timestamp of when the app was published.
user_id
\nint64
The ID of the user who published the app.
user_name
\nstring
The name (or email address) of the user who published the app.
user_uuid
\nuuid
The UUID of the user who published the app.
type
\nenum
The deployment type. \nAllowed enum values: deployment
default: deployment
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for creating a publish request.
attributes
\nobject
Attributes for creating a publish request.
description
\nstring
An optional description of the changes in this publish request.
title [required]
\nstring
A short title for the publish request.
type
\nenum
The publish-request resource type. \nAllowed enum values: publishRequest
default: publishRequest
data
\nobject
The data object containing the updated app definition.
attributes [required]
\nobject
The updated app definition attributes, such as name, description, and components.
components
\n[object]
The UI components that make up the app.
events
\n[object]
Events to listen for on the grid component.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id
\nstring
The ID of the grid component. This property is deprecated; use name to identify individual components instead.
name [required]
\nstring
A unique identifier for this grid component. This name is also visible in the app editor.
properties [required]
\nobject
Properties of a grid component.
backgroundColor
\nstring
The background color of the grid.
default: default
children
\n[object]
The child components of the grid.
events
\n[object]
Events to listen for on the UI component.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id
\nstring
The ID of the UI component. This property is deprecated; use name to identify individual components instead.
name [required]
\nstring
A unique identifier for this UI component. This name is also visible in the app editor.
properties [required]
\nobject
Properties of a UI component. Different component types can have their own additional unique properties. See the components documentation for more detail on each component type and its properties.
children
\n[object]
The child components of the UI component.
isVisible
\n<oneOf>
Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
type [required]
\nenum
The UI component type. \nAllowed enum values: table,textInput,textArea,button,text,select,modal,schemaForm,checkbox,tabsShow 10 more
,vegaChart,radioButtons,numberInput,fileInput,jsonInput,gridCell,dateRangePicker,search,container,calloutValue
isVisible
\n<oneOf>
Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean.
Option 1
\nstring
Option 2
\nboolean
default: true
type [required]
\nenum
The grid component type. \nAllowed enum values: grid
default: grid
description
\nstring
The human-readable description for the app.
favorite
\nboolean
Whether the app is marked as a favorite by the current user.
name
\nstring
The name of the app.
queries
\n[ <oneOf>]
An array of queries, such as external actions and state variables, that the app uses.
Option 1
\nobject
An action query. This query type is used to trigger an action, such as sending a HTTP request.
events
\n[object]
Events to listen for downstream of the action query.
name
\nenum
The triggering action for the event. \nAllowed enum values: pageChange,tableRowClick,_tableRowButtonClick,change,submit,click,toggleOpen,close,open,executionFinished
type
\nenum
The response to the event. \nAllowed enum values: custom,setComponentState,triggerQuery,openModal,closeModal,openUrl,downloadFile,setStateVariableValue
id [required]
\nuuid
The ID of the action query.
name [required]
\nstring
A unique identifier for this action query. This name is also used to access the query's result throughout the app.
properties [required]
\nobject
The properties of the action query.
condition
\n<oneOf>
Whether to run this query. If specified, the query will only run if this condition evaluates to true in JavaScript and all other conditions are also met.
Option 1
\nboolean
Option 2
\nstring
debounceInMs
\n<oneOf>
The minimum time in milliseconds that must pass before the query can be triggered again. This is useful for preventing accidental double-clicks from triggering the query multiple times.
Option 1
\ndouble
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a number.
mockedOutputs
\n<oneOf>
The mocked outputs of the action query. This is useful for testing the app without actually running the action.
Option 1
\nstring
Option 2
\nobject
The mocked outputs of the action query.
enabled [required]
\n<oneOf>
Whether to enable the mocked outputs for testing.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
outputs
\nstring
The mocked outputs of the action query, serialized as JSON.
onlyTriggerManually
\n<oneOf>
Determines when this query is executed. If set to false, the query will run when the app loads and whenever any query arguments change. If set to true, the query will only run when manually triggered from elsewhere in the app.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
outputs
\nstring
The post-query transformation function, which is a JavaScript function that changes the query's .outputs property after the query's execution.
pollingIntervalInMs
\n<oneOf>
If specified, the app will poll the query at the specified interval in milliseconds. The minimum polling interval is 15 seconds. The query will only poll when the app's browser tab is active.
Option 1
\ndouble
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a number.
requiresConfirmation
\n<oneOf>
Whether to prompt the user to confirm this query before it runs.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
showToastOnError
\n<oneOf>
Whether to display a toast to the user when the query returns an error.
Option 1
\nboolean
Option 2
\nstring
If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
spec [required]
\n<oneOf>
The definition of the action query.
Option 1
\nstring
Option 2
\nobject
The action query spec object.
connectionGroup
\nobject
The connection group to use for an action query.
id
\nuuid
The ID of the connection group.
tags
\n[string]
The tags of the connection group.
connectionId
\nstring
The ID of the custom connection to use for this action query.
fqn [required]
\nstring
The fully qualified name of the action type.
inputs
\n<oneOf>
The inputs to the action query. These are the values that are passed to the action when it is triggered.
Option 1
\nstring
Option 2
\nobject
The inputs to the action query. See the Actions Catalog for more detail on each action and its inputs.
type [required]
\nenum
The action query type. \nAllowed enum values: action
default: action
Option 2
\nobject
A data transformer, which is custom JavaScript code that executes and transforms data when its inputs change.
id [required]
\nuuid
The ID of the data transformer.
name [required]
\nstring
A unique identifier for this data transformer. This name is also used to access the transformer's result throughout the app.
properties [required]
\nobject
The properties of the data transformer.
outputs
\nstring
A JavaScript function that returns the transformed data.
type [required]
\nenum
The data transform type. \nAllowed enum values: dataTransform
default: dataTransform
Option 3
\nobject
A variable, which can be set and read by other components in the app.
id [required]
\nuuid
The ID of the state variable.
name [required]
\nstring
A unique identifier for this state variable. This name is also used to access the variable's value throughout the app.
properties [required]
\nobject
The properties of the state variable.
defaultValue
\nThe default value of the state variable.
type [required]
\nenum
The state variable type. \nAllowed enum values: stateVariable
default: stateVariable
rootInstanceName
\nstring
The name of the root component of the app. This must be a grid component that contains all other components.
tags
\n[string]
A list of tags for the app, which can be used to filter apps.
id [required]
\nuuid
The ID of the updated app.
type [required]
\nenum
The app definition type. \nAllowed enum values: appDefinitions
default: appDefinitions
included
\n[object]
Data on the version of the app that was published.
attributes
\nobject
The attributes object containing the version ID of the published app.
app_version_id
\nuuid
The version ID of the app that was published. For an unpublished app, this is always the nil UUID (00000000-0000-0000-0000-000000000000).
id
\nuuid
The deployment ID.
meta
\nobject
Metadata object containing the publication creation information.
created_at
\ndate-time
Timestamp of when the app was published.
user_id
\nint64
The ID of the user who published the app.
user_name
\nstring
The name (or email address) of the user who published the app.
user_uuid
\nuuid
The UUID of the user who published the app.
type
\nenum
The deployment type. \nAllowed enum values: deployment
default: deployment
meta
\nobject
Metadata of an app.
created_at
\ndate-time
Timestamp of when the app was created.
deleted_at
\ndate-time
Timestamp of when the app was deleted.
org_id
\nint64
The Datadog organization ID that owns the app.
updated_at
\ndate-time
Timestamp of when the app was last updated.
updated_since_deployment
\nboolean
Whether the app was updated since it was last published. Published apps are pinned to a specific version and do not automatically update when the app is updated.
user_id
\nint64
The ID of the user who created the app.
user_name
\nstring
The name (or email address) of the user who created the app.
user_uuid
\nuuid
The UUID of the user who created the app.
version
\nint64
The version number of the app. This starts at 1 and increments with each update.
relationship
\nobject
The app's publication relationship and custom connections.
connections
\n[object]
Array of custom connections used by the app.
attributes
\nobject
The custom connection attributes.
name
\nstring
The name of the custom connection.
onPremRunner
\nobject
Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner.
id
\nstring
The Private Action Runner ID.
url
\nstring
The URL of the Private Action Runner.
id
\nuuid
The ID of the custom connection.
type
\nenum
The custom connection type. \nAllowed enum values: custom_connections
default: custom_connections
deployment
\nobject
Information pointing to the app's publication status.
data
\nobject
Data object containing the deployment ID.
id
\nuuid
The deployment ID.
type
\nenum
The deployment type. \nAllowed enum values: deployment
default: deployment
meta
\nobject
Metadata object containing the publication creation information.
created_at
\ndate-time
Timestamp of when the app was published.
user_id
\nint64
The ID of the user who published the app.
user_name
\nstring
The name (or email address) of the user who published the app.
user_uuid
\nuuid
The UUID of the user who published the app.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for updating an app's self-service status.
attributes
\nobject
Attributes for updating an app's self-service status.
selfService [required]
\nboolean
Whether the app is enabled for self-service.
type
\nenum
The self-service resource type. \nAllowed enum values: selfService
default: selfService
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for replacing an app's tags.
attributes
\nobject
Attributes for replacing an app's tags.
tags [required]
\n[string]
The full list of tags that should be set on the app. Existing tags not present in this list are removed.
type
\nenum
The tags resource type. \nAllowed enum values: tags
default: tags
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data
\nobject
Data for naming a specific app version.
attributes
\nobject
Attributes for naming a specific app version.
name [required]
\nstring
The name to assign to the app version.
type
\nenum
The version-name resource type. \nAllowed enum values: versionNames
default: versionNames
data
\n[object]
The list of app versions.
attributes
\nobject
Attributes describing an app version.
app_id
\nuuid
The ID of the app this version belongs to.
created_at
\ndate-time
Timestamp of when the version was created.
has_ever_been_published
\nboolean
Whether this version has ever been published.
name
\nstring
The optional human-readable name of the version.
updated_at
\ndate-time
Timestamp of when the version was last updated.
user_id
\nint64
The ID of the user who created the version.
user_name
\nstring
The name (or email) of the user who created the version.
user_uuid
\nuuid
The UUID of the user who created the version.
version
\nint64
The version number of the app, starting at 1.
id
\nuuid
The ID of the app version.
type
\nenum
The app-version resource type. \nAllowed enum values: appVersions
default: appVersions
meta
\nobject
Pagination metadata.
page
\nobject
Information on the total number of apps, to be used for pagination.
totalCount
\nint64
The total number of apps under the Datadog organization, disregarding any filters applied.
totalFilteredCount
\nint64
The total number of apps that match the specified filters.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
commitments [required]
\n[ <oneOf>]
Array of commitment items.
Option 1
\nobject
AWS EC2 Reserved Instance commitment details.
availability_zone
\nstring
The availability zone of the reservation.
commitment_id [required]
\nstring
The unique identifier of the Reserved Instance.
expiration_date
\nstring
The expiration date of the commitment.
instance_type [required]
\nstring
The EC2 instance type.
number_of_nfus
\ndouble
The number of Normalized Capacity Units.
number_of_reservations
\ndouble
The number of reserved instances.
offering_class [required]
\nstring
The offering class of the Reserved Instance.
operating_system [required]
\nstring
The operating system of the Reserved Instance.
purchase_option [required]
\nstring
The payment option for the Reserved Instance.
region [required]
\nstring
The AWS region of the Reserved Instance.
start_date
\nstring
The start date of the commitment.
term_length
\ndouble
The term length in years.
utilization
\ndouble
The utilization percentage of the commitment.
Option 2
\nobject
AWS RDS Reserved Instance commitment details.
commitment_id [required]
\nstring
The unique identifier of the Reserved Instance.
database_engine [required]
\nstring
The database engine of the Reserved Instance.
expiration_date
\nstring
The expiration date of the commitment.
instance_type [required]
\nstring
The RDS instance type.
is_multi_az
\nboolean
Whether the Reserved Instance is Multi-AZ.
number_of_nfus
\ndouble
The number of Normalized Capacity Units.
number_of_reservations
\ndouble
The number of reserved instances.
purchase_option [required]
\nstring
The payment option for the Reserved Instance.
region [required]
\nstring
The AWS region of the Reserved Instance.
start_date
\nstring
The start date of the commitment.
term_length
\ndouble
The term length in years.
utilization
\ndouble
The utilization percentage of the commitment.
Option 3
\nobject
AWS ElastiCache Reserved Instance commitment details.
cache_engine [required]
\nstring
The cache engine type of the Reserved Instance.
commitment_id [required]
\nstring
The unique identifier of the Reserved Instance.
expiration_date
\nstring
The expiration date of the commitment.
instance_type [required]
\nstring
The ElastiCache instance type.
number_of_nfus
\ndouble
The number of Normalized Capacity Units.
number_of_reservations
\ndouble
The number of reserved instances.
purchase_option [required]
\nstring
The payment option for the Reserved Instance.
region [required]
\nstring
The AWS region of the Reserved Instance.
start_date
\nstring
The start date of the commitment.
term_length
\ndouble
The term length in years.
utilization
\ndouble
The utilization percentage of the commitment.
Option 4
\nobject
AWS Savings Plan commitment details.
commitment_id [required]
\nstring
The unique identifier of the Savings Plan.
committed_spend_per_hour
\ndouble
The hourly committed spend for the Savings Plan.
expiration_date
\nstring
The expiration date of the commitment.
purchase_option [required]
\nstring
The payment option for the Savings Plan.
savings_plan_type [required]
\nstring
The Savings Plan type.
start_date
\nstring
The start date of the commitment.
term_length
\ndouble
The term length in years.
utilization
\ndouble
The utilization percentage of the commitment.
Option 5
\nobject
Azure Virtual Machine Reserved Instance commitment details.
benefit_name [required]
\nstring
The display name of the Azure reservation.
commitment_id [required]
\nstring
The unique identifier of the Reserved Instance.
expiration_date
\nstring
The expiration date of the commitment.
instance_type [required]
\nstring
The Azure VM instance type.
meter_sub_category [required]
\nstring
The Azure meter sub-category for the reservation.
region [required]
\nstring
The Azure region of the Reserved Instance.
start_date
\nstring
The start date of the commitment.
status [required]
\nenum
Status of an Azure VM Reserved Instance. \nAllowed enum values: running,expired,cancelled
term_length
\ndouble
The term length in years.
utilization
\ndouble
The utilization percentage of the commitment.
Option 6
\nobject
Azure Compute Savings Plan commitment details.
benefit_name [required]
\nstring
The display name of the Azure Savings Plan.
commitment_id [required]
\nstring
The unique identifier of the Savings Plan.
committed_spend_per_hour
\ndouble
The hourly committed spend for the Savings Plan.
expiration_date
\nstring
The expiration date of the commitment.
start_date
\nstring
The start date of the commitment.
term_length
\ndouble
The term length in years.
utilization
\ndouble
The utilization percentage of the commitment.
meta
\nobject
Metadata for a commitments list response.
committed_spend_unit
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
columns [required]
\n[object]
Array of scalar columns in the response.
meta
\nobject
Metadata for a scalar column, including unit information.
unit [required]
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
name [required]
\nstring
The column name.
type [required]
\nenum
The column type. "group" for dimension columns, "number" for metric columns. \nAllowed enum values: group,number
values [required]
\n[]
Values for a scalar column. Arrays of strings for group columns, numbers for value columns.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
cost [required]
\nobject
A timeseries metric containing timestamps, series values, and optional unit metadata.
series [required]
\nobject
Timeseries data as a map of series names to their corresponding value arrays.
<any-key>
\n[number]
A series of numeric values for a timeseries metric.
times [required]
\n[integer]
Unix timestamps in seconds for the timeseries data points.
unit
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
hours [required]
\nobject
A timeseries metric containing timestamps, series values, and optional unit metadata.
series [required]
\nobject
Timeseries data as a map of series names to their corresponding value arrays.
<any-key>
\n[number]
A series of numeric values for a timeseries metric.
times [required]
\n[integer]
Unix timestamps in seconds for the timeseries data points.
unit
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
columns [required]
\n[object]
Array of scalar columns in the response.
meta
\nobject
Metadata for a scalar column, including unit information.
unit [required]
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
name [required]
\nstring
The column name.
type [required]
\nenum
The column type. "group" for dimension columns, "number" for metric columns. \nAllowed enum values: group,number
values [required]
\n[]
Values for a scalar column. Arrays of strings for group columns, numbers for value columns.
meta
\nobject
Metadata for the on-demand hot-spots scalar response.
on_demand_filters [required]
\nstring
Active on-demand filters applied to the response.
total [required]
\n[object]
Array of scalar columns in the response.
meta
\nobject
Metadata for a scalar column, including unit information.
unit [required]
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
name [required]
\nstring
The column name.
type [required]
\nenum
The column type. "group" for dimension columns, "number" for metric columns. \nAllowed enum values: group,number
values [required]
\n[]
Values for a scalar column. Arrays of strings for group columns, numbers for value columns.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
columns [required]
\n[object]
Array of scalar columns in the response.
meta
\nobject
Metadata for a scalar column, including unit information.
unit [required]
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
name [required]
\nstring
The column name.
type [required]
\nenum
The column type. "group" for dimension columns, "number" for metric columns. \nAllowed enum values: group,number
values [required]
\n[]
Values for a scalar column. Arrays of strings for group columns, numbers for value columns.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
actual_cost [required]
\nobject
A timeseries metric containing timestamps, series values, and optional unit metadata.
series [required]
\nobject
Timeseries data as a map of series names to their corresponding value arrays.
<any-key>
\n[number]
A series of numeric values for a timeseries metric.
times [required]
\n[integer]
Unix timestamps in seconds for the timeseries data points.
unit
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
effective_savings_rate [required]
\nobject
A timeseries metric containing timestamps, series values, and optional unit metadata.
series [required]
\nobject
Timeseries data as a map of series names to their corresponding value arrays.
<any-key>
\n[number]
A series of numeric values for a timeseries metric.
times [required]
\n[integer]
Unix timestamps in seconds for the timeseries data points.
unit
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
on_demand_equivalent_cost [required]
\nobject
A timeseries metric containing timestamps, series values, and optional unit metadata.
series [required]
\nobject
Timeseries data as a map of series names to their corresponding value arrays.
<any-key>
\n[number]
A series of numeric values for a timeseries metric.
times [required]
\n[integer]
Unix timestamps in seconds for the timeseries data points.
unit
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
realized_savings [required]
\nobject
A timeseries metric containing timestamps, series values, and optional unit metadata.
series [required]
\nobject
Timeseries data as a map of series names to their corresponding value arrays.
<any-key>
\n[number]
A series of numeric values for a timeseries metric.
times [required]
\n[integer]
Unix timestamps in seconds for the timeseries data points.
unit
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
columns [required]
\n[object]
Array of scalar columns in the response.
meta
\nobject
Metadata for a scalar column, including unit information.
unit [required]
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
name [required]
\nstring
The column name.
type [required]
\nenum
The column type. "group" for dimension columns, "number" for metric columns. \nAllowed enum values: group,number
values [required]
\n[]
Values for a scalar column. Arrays of strings for group columns, numbers for value columns.
product_breakdown
\n[object]
Array of per-product utilization breakdown entries.
product [required]
\nstring
The cloud product name.
utilization [required]
\ndouble
The utilization percentage for the product.
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
series [required]
\nobject
Timeseries data as a map of series names to their corresponding value arrays.
<any-key>
\n[number]
A series of numeric values for a timeseries metric.
times [required]
\n[integer]
Unix timestamps in seconds for the timeseries data points.
unit
\nobject
Unit metadata for a numeric metric.
family [required]
\nstring
The unit family (for example, percentage or money).
id [required]
\nint64
The unit identifier.
name [required]
\nstring
The unit name (for example, percent or dollar).
plural [required]
\nstring
The plural form of the unit name.
scale_factor [required]
\ndouble
The scale factor for the unit.
short_name [required]
\nstring
The abbreviated unit name (for example, % or $).
errors [required]
\n[object]
A list of errors.
detail
\nstring
A human-readable explanation specific to this occurrence of the error.
meta
\nobject
Non-standard meta-information about the error
source
\nobject
References to the source of the error.
header
\nstring
A string indicating the name of a single request header which caused the error.
parameter
\nstring
A string indicating which URI query parameter caused the error.
pointer
\nstring
A JSON pointer to the value in the request document that caused the error.
status
\nstring
Status code of the response.
title
\nstring
Short human-readable summary of the error.
errors [required]
\n[string]
A list of errors.
data [required]
\nobject
Data object for annotated interactions.
attributes [required]
\nobject
Attributes containing the list of annotated interactions.
annotated_interactions [required]
\n[object]
List of interactions with their annotations.
annotations [required]
\n[object]
List of annotations for this interaction.
created_at [required]
\ndate-time
Timestamp when the annotation was created.
created_by [required]
\nstring
Identifier of the user who created the annotation.
id [required]
\nstring
Unique identifier of the annotation.
interaction_id [required]
\nstring
Identifier of the interaction this annotation belongs to.
label_values [required]
\nobject
The label values for this annotation.
modified_at [required]
\ndate-time
Timestamp when the annotation was last modified.
modified_by [required]
\nstring
Identifier of the user who last modified the annotation.
content_id [required]
\nstring
Identifier of the content (trace ID or session ID) for this interaction.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type of interaction in an annotation queue. \nAllowed enum values: trace,experiment_trace,session
id [required]
\nstring
The queue ID.
type [required]
\nenum
Resource type for annotated interactions. \nAllowed enum values: annotated_interactions
data [required]
\nobject
Data object for annotated interactions.
attributes [required]
\nobject
Attributes containing the list of annotated interactions.
annotated_interactions [required]
\n[ <oneOf>]
List of interactions with their annotations.
Option 1
\nobject
A trace, experiment trace, or session interaction with its associated annotations.
annotations [required]
\n[object]
List of annotations for this interaction.
created_at [required]
\ndate-time
Timestamp when the annotation was created.
created_by [required]
\nstring
Identifier of the user who created the annotation.
id [required]
\nstring
Unique identifier of the annotation.
interaction_id [required]
\nstring
Identifier of the interaction this annotation belongs to.
label_values [required]
\nobject
The label values for this annotation.
modified_at [required]
\ndate-time
Timestamp when the annotation was last modified.
modified_by [required]
\nstring
Identifier of the user who last modified the annotation.
content_id [required]
\nstring
Upstream entity identifier supplied by the caller.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type of an upstream-entity interaction. \nAllowed enum values: trace,experiment_trace,session
Option 2
\nobject
A display_block interaction with its associated annotations.
annotations [required]
\n[object]
List of annotations for this interaction.
created_at [required]
\ndate-time
Timestamp when the annotation was created.
created_by [required]
\nstring
Identifier of the user who created the annotation.
id [required]
\nstring
Unique identifier of the annotation.
interaction_id [required]
\nstring
Identifier of the interaction this annotation belongs to.
label_values [required]
\nobject
The label values for this annotation.
modified_at [required]
\ndate-time
Timestamp when the annotation was last modified.
modified_by [required]
\nstring
Identifier of the user who last modified the annotation.
content_id [required]
\nstring
Server-generated deterministic identifier derived from the block list.
display_block [required]
\n[object]
List of content blocks that make up a display_block interaction.\nMust contain at least one block.
alt
\nstring
Alternative text for an image block.
content
\nBlock payload. A string for markdown, header, and text; an\narbitrary JSON value (object, array, or scalar) for json. Omitted\nfor image, widget, and llmobs_trace.
height
\nint64
Optional rendered height. Must be positive when set.
interactionType
\nenum
Upstream interaction type referenced by an llmobs_trace block.\nRestricted to trace or experiment_trace. \nAllowed enum values: trace,experiment_trace
label
\nstring
Optional label rendered alongside the block.
level
\nenum
Visual size for a header block. \nAllowed enum values: sm,md,lg,xl
tileDef
\nTile definition for a widget block. Required for widget. The\nschema is owned by the frontend renderer.
timeFrame
\nobject
Unix-millis time range used by chart blocks.
end [required]
\nint64
End of the range, in Unix milliseconds.
start [required]
\nint64
Start of the range, in Unix milliseconds.
traceId
\nstring
Trace identifier. Required for llmobs_trace blocks.
type [required]
\nenum
Discriminator for a single display_block content block. Adding a\nvariant requires coordinated changes in the frontend renderer. \nAllowed enum values: markdown,header,text,json,image,widget,llmobs_trace
url
\nstring
URL of the image. Required for image blocks.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type discriminator for a display_block interaction. \nAllowed enum values: display_block
id [required]
\nstring
The queue ID.
type [required]
\nenum
Resource type for annotated interactions. \nAllowed enum values: annotated_interactions
data [required]
\nobject
Data object for the interaction addition response.
attributes [required]
\nobject
Attributes of the interaction addition response.
interactions [required]
\n[object]
List of interactions that were processed.
already_existed [required]
\nboolean
Whether this interaction already existed in the queue.
content_id [required]
\nstring
Identifier of the content (trace ID or session ID) for this interaction.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type of interaction in an annotation queue. \nAllowed enum values: trace,experiment_trace,session
id [required]
\nstring
The queue ID the interactions were added to.
type [required]
\nenum
Resource type for annotation queue interactions. \nAllowed enum values: interactions
data [required]
\nobject
Data object for the interaction addition response.
attributes [required]
\nobject
Attributes of the interaction addition response.
interactions [required]
\n[ <oneOf>]
List of interactions that were processed.
Option 1
\nobject
A trace, experiment trace, or session interaction result.
already_existed [required]
\nboolean
Whether this interaction already existed in the queue.
content_id [required]
\nstring
Upstream entity identifier supplied by the caller.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type of an upstream-entity interaction. \nAllowed enum values: trace,experiment_trace,session
Option 2
\nobject
A display_block interaction result.
already_existed [required]
\nboolean
Whether this interaction already existed in the queue.
content_id [required]
\nstring
Server-generated deterministic identifier derived from the block list.
display_block [required]
\n[object]
List of content blocks that make up a display_block interaction.\nMust contain at least one block.
alt
\nstring
Alternative text for an image block.
content
\nBlock payload. A string for markdown, header, and text; an\narbitrary JSON value (object, array, or scalar) for json. Omitted\nfor image, widget, and llmobs_trace.
height
\nint64
Optional rendered height. Must be positive when set.
interactionType
\nenum
Upstream interaction type referenced by an llmobs_trace block.\nRestricted to trace or experiment_trace. \nAllowed enum values: trace,experiment_trace
label
\nstring
Optional label rendered alongside the block.
level
\nenum
Visual size for a header block. \nAllowed enum values: sm,md,lg,xl
tileDef
\nTile definition for a widget block. Required for widget. The\nschema is owned by the frontend renderer.
timeFrame
\nobject
Unix-millis time range used by chart blocks.
end [required]
\nint64
End of the range, in Unix milliseconds.
start [required]
\nint64
Start of the range, in Unix milliseconds.
traceId
\nstring
Trace identifier. Required for llmobs_trace blocks.
type [required]
\nenum
Discriminator for a single display_block content block. Adding a\nvariant requires coordinated changes in the frontend renderer. \nAllowed enum values: markdown,header,text,json,image,widget,llmobs_trace
url
\nstring
URL of the image. Required for image blocks.
id [required]
\nstring
Unique identifier of the interaction.
type [required]
\nenum
Type discriminator for a display_block interaction. \nAllowed enum values: display_block
id [required]
\nstring
The queue ID the interactions were added to.
type [required]
\nenum
Resource type for annotation queue interactions. \nAllowed enum values: interactions
data [required]
\nobject
Data object for adding interactions to an annotation queue.
attributes [required]
\nobject
Attributes for adding interactions to an annotation queue.
interactions [required]
\n[object]
List of interactions to add to the queue. Must contain at least one item.
content_id [required]
\nstring
Identifier of the content (trace ID or session ID) for this interaction.
type [required]
\nenum
Type of interaction in an annotation queue. \nAllowed enum values: trace,experiment_trace,session
type [required]
\nenum
Resource type for annotation queue interactions. \nAllowed enum values: interactions
data [required]
\nobject
Data object for adding interactions to an annotation queue.
attributes [required]
\nobject
Attributes for adding interactions to an annotation queue.
interactions [required]
\n[ <oneOf>]
List of interactions to add to the queue. Must contain at least one item.
Option 1
\nobject
An interaction that references an upstream trace, experiment trace, or session.
content_id [required]
\nstring
Upstream entity identifier (trace, experiment trace, or session ID).
type [required]
\nenum
Type of an upstream-entity interaction. \nAllowed enum values: trace,experiment_trace,session
Option 2
\nobject
An interaction whose rendered content is supplied directly as a list\nof display blocks. The server generates content_id deterministically\nfrom the block list.
display_block [required]
\n[object]
List of content blocks that make up a display_block interaction.\nMust contain at least one block.
alt
\nstring
Alternative text for an image block.
content
\nBlock payload. A string for markdown, header, and text; an\narbitrary JSON value (object, array, or scalar) for json. Omitted\nfor image, widget, and llmobs_trace.
height
\nint64
Optional rendered height. Must be positive when set.
interactionType
\nenum
Upstream interaction type referenced by an llmobs_trace block.\nRestricted to trace or experiment_trace. \nAllowed enum values: trace,experiment_trace
label
\nstring
Optional label rendered alongside the block.
level
\nenum
Visual size for a header block. \nAllowed enum values: sm,md,lg,xl
tileDef
\nTile definition for a widget block. Required for widget. The\nschema is owned by the frontend renderer.
timeFrame
\nobject
Unix-millis time range used by chart blocks.
end [required]
\nint64
End of the range, in Unix milliseconds.
start [required]
\nint64
Start of the range, in Unix milliseconds.
traceId
\nstring
Trace identifier. Required for llmobs_trace blocks.
type [required]
\nenum
Discriminator for a single display_block content block. Adding a\nvariant requires coordinated changes in the frontend renderer. \nAllowed enum values: markdown,header,text,json,image,widget,llmobs_trace
url
\nstring
URL of the image. Required for image blocks.
type [required]
\nenum
Type discriminator for a display_block interaction. \nAllowed enum values: display_block
type [required]
\nenum
Resource type for annotation queue interactions. \nAllowed enum values: interactions
displayName
\nstring
A human-readable name for the group.
externalId
\nstring
An identifier for the resource as defined by the provisioning client.
id
\nstring
The identifier of the resource. Not required when creating a group.
members
\n[object]
Members of the group.
$ref
\nstring
The URI corresponding to a SCIM resource that is a member of this group.
display
\nstring
A human-readable name for the group member.
type
\nstring
A label indicating the type of resource.
value
\nstring
The identifier of the member of this group.
meta
\nobject
Metadata associated with a group.
created
\ndate-time
The date and time the group was created.
lastModified
\ndate-time
The date and time the group was last changed.
location
\nstring
URL identifying the resource.
resourceType
\nstring
Type of resource.
schemas
\n[string]
Input JSON Schemas.
Resources
\n[object]
List of resource types supported by this SCIM service provider.
description
\nstring
Human-readable description of the resource type.
endpoint
\nstring
HTTP-addressable endpoint relative to the base URL where the resource is located.
id
\nstring
The resource type's server unique id.
meta
\nobject
Metadata associated with a resource type.
location
\nstring
URL identifying the resource type.
resourceType
\nstring
Type of resource.
name
\nstring
The resource type name.
schema
\nstring
The resource type's primary or base SCIM schema URI.
schemas
\n[string]
A list of SCIM schema URI identifying the protocol or schema used in this object.
itemsPerPage
\nint64
Number of resource types returned per page.
schemas
\n[string]
List response JSON Schemas.
startIndex
\nint64
Starting index of the resource types for this page (1-indexed).
totalResults
\nint64
Total number of resource types.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
description
\nstring
Human-readable description of the resource type.
endpoint
\nstring
HTTP-addressable endpoint relative to the base URL where the resource is located.
id
\nstring
The resource type's server unique id.
meta
\nobject
Metadata associated with a resource type.
location
\nstring
URL identifying the resource type.
resourceType
\nstring
Type of resource.
name
\nstring
The resource type name.
schema
\nstring
The resource type's primary or base SCIM schema URI.
schemas
\n[string]
A list of SCIM schema URI identifying the protocol or schema used in this object.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
Resources
\n[object]
List of schemas supported by this SCIM service provider.
attributes
\n[object]
A list of attributes that make up the schema.
canonicalValues
\n[string]
A collection of canonical values.
caseExact
\nboolean
A Boolean value that specifies whether or not a string attribute is case sensitive.
description
\nstring
The attribute's human-readable description.
multiValued
\nboolean
A Boolean value indicating an attribute's plurality.
mutability
\nstring
A single keyword indicating the circumstances under which the value of\nthe attribute can be (re)defined.
name
\nstring
The attribute's name.
referenceTypes
\n[string]
A list of resource types or external resources the reference may refer to.
required
\nboolean
A Boolean value that specifies whether or not the attribute is required.
returned
\nstring
A single keyword that indicates when an attribute and associated values\nare returned in response to a GET request or in response to a PUT, POST,\nor PATCH request.
subAttributes
\n[object]
A list of sub-attributes for complex attributes.
canonicalValues
\n[string]
A collection of canonical values.
caseExact
\nboolean
A Boolean value that specifies whether or not a string attribute is case sensitive.
description
\nstring
The attribute's human-readable description.
multiValued
\nboolean
A Boolean value indicating an attribute's plurality.
mutability
\nstring
A single keyword indicating the circumstances under which the value of\nthe attribute can be (re)defined.
name
\nstring
The sub-attribute's name.
referenceTypes
\n[string]
A list of resource types or external resources the reference may refer to.
required
\nboolean
A Boolean value that specifies whether or not the attribute is required.
returned
\nstring
A single keyword that indicates when an attribute and associated values\nare returned in response to a GET request or in response to a PUT, POST,\nor PATCH request.
type
\nstring
The data type of the attribute.
uniqueness
\nstring
A single keyword value that specifies how the service provider enforces\nuniqueness of attribute values.
type
\nstring
The data type of the attribute.
uniqueness
\nstring
A single keyword value that specifies how the service provider enforces\nuniqueness of attribute values.
description
\nstring
Human-readable description of the schema.
id
\nstring
The unique URI of the schema.
meta
\nobject
Metadata associated with a SCIM schema.
location
\nstring
URL identifying the schema.
resourceType
\nstring
Type of resource.
name
\nstring
The human-readable name of the schema.
itemsPerPage
\nint64
Number of schemas returned per page.
schemas
\n[string]
List response JSON Schemas.
startIndex
\nint64
Starting index of the schemas for this page (1-indexed).
totalResults
\nint64
Total number of schemas.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
attributes
\n[object]
A list of attributes that make up the schema.
canonicalValues
\n[string]
A collection of canonical values.
caseExact
\nboolean
A Boolean value that specifies whether or not a string attribute is case sensitive.
description
\nstring
The attribute's human-readable description.
multiValued
\nboolean
A Boolean value indicating an attribute's plurality.
mutability
\nstring
A single keyword indicating the circumstances under which the value of\nthe attribute can be (re)defined.
name
\nstring
The attribute's name.
referenceTypes
\n[string]
A list of resource types or external resources the reference may refer to.
required
\nboolean
A Boolean value that specifies whether or not the attribute is required.
returned
\nstring
A single keyword that indicates when an attribute and associated values\nare returned in response to a GET request or in response to a PUT, POST,\nor PATCH request.
subAttributes
\n[object]
A list of sub-attributes for complex attributes.
canonicalValues
\n[string]
A collection of canonical values.
caseExact
\nboolean
A Boolean value that specifies whether or not a string attribute is case sensitive.
description
\nstring
The attribute's human-readable description.
multiValued
\nboolean
A Boolean value indicating an attribute's plurality.
mutability
\nstring
A single keyword indicating the circumstances under which the value of\nthe attribute can be (re)defined.
name
\nstring
The sub-attribute's name.
referenceTypes
\n[string]
A list of resource types or external resources the reference may refer to.
required
\nboolean
A Boolean value that specifies whether or not the attribute is required.
returned
\nstring
A single keyword that indicates when an attribute and associated values\nare returned in response to a GET request or in response to a PUT, POST,\nor PATCH request.
type
\nstring
The data type of the attribute.
uniqueness
\nstring
A single keyword value that specifies how the service provider enforces\nuniqueness of attribute values.
type
\nstring
The data type of the attribute.
uniqueness
\nstring
A single keyword value that specifies how the service provider enforces\nuniqueness of attribute values.
description
\nstring
Human-readable description of the schema.
id
\nstring
The unique URI of the schema.
meta
\nobject
Metadata associated with a SCIM schema.
location
\nstring
URL identifying the schema.
resourceType
\nstring
Type of resource.
name
\nstring
The human-readable name of the schema.
errors [required]
\n[string]
A list of errors.
errors [required]
\n[string]
A list of errors.
OTEL_SERVICE_NAME environment variable takes precedence over the service.name attribute in the OTEL_RESOURCE_ATTRIBUTES environment variable.{"enabled":true}) but with an empty CIDR blocks list ({"enabled":true, "cidr_blocks":[]}) is not considered publicly accessible, as it blocks all external access to the control plane.source:runtime-security-agent) and Cloud Security Misconfigurations (source:compliance-agent) are not billed as analyzed logs regardless of filter configuration.version attribute. version is optional: if you omit it, the API updates the latest version of the filter. Include version when you want the request to succeed only against a specific known version (for example, to avoid overwriting concurrent changes).secretBackend.type. Usa variables de entorno. secretBackend.type. Usa variables de entorno en override.nodeAgent.env. encoding de un archivo que el Agente está ya realizando seguimiento de las últimas líneas, puede producir caracteres distorsionados (mojibake). El Agente reanuda desde el desplazamiento de byte anterior, que puede no alinearse con los límites de caracteres después de un cambio de codificación. Para solucionar esto, rote el archivo de registro, reemplácelo o reinicie el seguimiento desde el principio de un archivo que utilice la nueva codificación. Estas acciones ayudan al Agente a comenzar con la codificación correcta.--set targetSystem=windows to the helm install command.
+ Para Windows, agregue --set targetSystem=windows al helm install comando.
<CLUSTER_NAME> allows you to scope hosts and Cluster Checks. This unique name must be dot-separated tokens and abide by the following restrictions:
+<CLUSTER_NAME> Le permite definir el contexto de los hosts y de Cluster Checks. Este nombre único debe estar compuesto por tokens separados por puntos y cumplir con las siguientes restricciones:
DatadogAgent desplegados utilizan configDataMap, cada CRD escribe en un ConfigMap compartido llamado nodeagent-extra-confd. Esto puede provocar que las configuraciones se anulen entre sí. DatadogAgent Los CRDs utilizan configDataMap, cada CRD escribe en un ConfigMap compartido llamado nodeagent-extra-confd. Esto puede causar que las configuraciones se anulen entre sí. check_tag_cardinality la anotación solo afecta a las métricas recopiladas por las verificaciones de integración. No afecta a las métricas enviadas a través de DogStatsD. Para configurar la cardinalidad de etiquetas de DogStatsD, utiliza el parámetro de configuración global dogstatsd_tag_cardinality o la variable de entorno. DD_DOGSTATSD_TAG_CARDINALITY variable de entorno.context_info para la instrumentación, el rastreador de APM lo sobrescribe.context_info para instrumentación, el SDK de Datadog lo sobrescribe.SELECT en esas tablas al usuario Datadog. Ejemplo: grant SELECT on <TABLE_NAME> to datadog;. Para obtener más información, consulta Recopilación de métricas personalizadas de PostgreSQL. SELECT permiso en esas tablas para el datadog usuario. Ejemplo: grant SELECT on <TABLE_NAME> to datadog;. Consulte la recopilación de métricas personalizadas de PostgreSQL para más información. --set targetSystem=windows to the helm install command.
+Para Windows, agrega --set targetSystem=windows al helm install comando.
SELECT en esas tablas al usuario Datadog. Ejemplo: grant SELECT on <TABLE_NAME> to datadog;. Para obtener más información, consulta Recopilación de métricas personalizadas de PostgreSQL. SELECT permiso sobre esas tablas para el datadog usuario. Ejemplo: grant SELECT on <TABLE_NAME> to datadog;. Consulte la recopilación de métricas personalizadas de PostgreSQL para más información. auto_explain produce líneas de registro que pueden contener información sensible de su aplicación, similar a los valores en bruto que aparecen en SQL no ofuscado. Puede usar el dbm_parameterized_queries_readel permiso para controlar quién puede ver los planes resultantes, pero las líneas de registro son visibles para todos los usuarios dentro de su organización de Datadog. Usar RBAC para Logs ayuda a asegurar que estos registros solo sean visibles para los usuarios adecuados.
+
dd.logs( - filter => varchar, - columns => array < varchar >, - indexes => array < varchar >, - from_timestamp => timestamp, - to_timestamp => timestamp + columnas => array < varchar >, + filtro ? => varchar, + índices ? => array < varchar >, + storage ? => varchar, + from_timestamp ? => timestamp, + to_timestamp ? => timestamp ) AS (column_name type [, ...]) |
- Devuelve los datos de logs en forma de tabla. El parámetro de columna especifica qué campos de log extraer, y la cláusula AS define el esquema de la tabla devuelta. Opcional: Filtrado por índice o rango temporal. Si no se especifica la hora, se utilizará por defecto la última hora de los datos. | +Devuelve datos de registro como una tabla. El parámetro de columnas especifica qué campos de registro extraer. Los campos anidados se acceden utilizando notación de punto, y los campos no centrales deben ser precedidos por @. La cláusula AS define el esquema de la tabla devuelta. Opcional: filtrado por índice o rango de tiempo. Cuando no se especifica el tiempo, DDSQL utiliza la configuración de tiempo global, que en DDSQL Editor está configurada para la última hora. Opcional: especificar el almacenamiento a utilizar (por ejemplo, hot, flex_tier). Cuando no se especifica, el valor predeterminado es almacenamiento caliente. |
{{< code-block lang="sql" >}} -SELECT timestamp, host, service, message +SELECT timestamp, host, service, message, asset_id FROM dd.logs( - filter => 'source (fuente):java', - columns => ARRAY['timestamp','host', 'service','message'] + filter => 'source:java', + columns => ARRAY['timestamp','host','service','message','@asset.id'] ) AS ( timestamp TIMESTAMP, - host VARCHAR, - service VARCHAR, - message VARCHAR + host VARCHAR, + service VARCHAR, + message VARCHAR, + asset_id VARCHAR ){{< /code-block >}} |
-dd.metric_scalar(
- query varchar
+dd.metrics_scalar(
+ consulta varchar,
reducer varchar [, from_timestamp timestamp, to_timestamp timestamp]
)
|
- Devuelve datos de métricas como un valor escalar. La función acepta una consulta de métricas (con agrupación opcional), un reductor para determinar cómo se agregan los valores (medio, máx, etc.) y parámetros opcionales de fecha y hora (por defecto 1 hora) para definir el intervalo de tiempo. | +Devuelve datos métricos como un valor escalar. La función acepta una consulta de métricas (con agrupamiento opcional), un reducer para determinar cómo se agregan los valores (avg, max, etc.), y parámetros de marca de tiempo opcionales (por defecto 1 hora) para definir el rango de tiempo. | {{< code-block lang="sql" >}} SELECT * -FROM dd.metric_scalar( +FROM dd.metrics_scalar( 'avg:system.cpu.user{*} by {service}', 'avg', TIMESTAMP '2025-07-10 00:00:00.000-04:00', @@ -805,16 +1020,146 @@ FROM dd.metric_scalar( ORDER BY value DESC;{{< /code-block >}} |
+ +dd.metrics_timeseries( + query varchar [, from_timestamp timestamp, to_timestamp timestamp] +)+ |
+ Devuelve los datos de métricas como series temporales. La función acepta una consulta de métricas (con agrupamiento opcional) y parámetros de marca de tiempo opcionales (por defecto 1 hora) para definir el rango de tiempo. Devuelve puntos de datos a lo largo del tiempo en lugar de un solo valor agregado. | ++ {{< code-block lang="sql" >}} +SELECT * +FROM dd.metrics_timeseries( + 'avg:system.cpu.user{*} by {service}', + TIMESTAMP '2025-07-10 00:00:00.000-04:00', + TIMESTAMP '2025-07-17 00:00:00.000-04:00' +) +ORDER BY timestamp, service;{{< /code-block >}} + | +|
+ +dd.cloud_cost_scalar( + query varchar, + reducer varchar + [, from_timestamp timestamp, + to_timestamp timestamp] +)+ |
+ Devuelve datos de Cloud Cost Management como un valor escalar. La función acepta una consulta de Cloud Cost (con agrupamiento opcional), un reductor de agregación (usa sum para datos de costos; otros reductores como avg, min, y max son aceptados pero rara vez aplicables a consultas de costos), y parámetros de marca de tiempo opcionales (por defecto 1 hora) para definir el rango de tiempo. Nota: Los datos de Cloud Cost suelen tener un retraso de 24 a 48 horas, por lo que las marcas de tiempo recientes pueden no devolver resultados. |
+ + {{< code-block lang="sql" >}} +SELECT * +FROM dd.cloud_cost_scalar( + 'sum:all.cost{*} by {service}', + 'sum', + TIMESTAMP '2025-07-10 00:00:00.000-04:00', + TIMESTAMP '2025-07-17 00:00:00.000-04:00' +) +ORDER BY value DESC;{{< /code-block >}} + | +|
+ +dd.cloud_cost_timeseries( + query varchar + [, from_timestamp timestamp, + to_timestamp timestamp] +)+ |
+ Devuelve datos de Cloud Cost Management como series temporales. La función acepta una consulta de Cloud Cost (con agrupamiento opcional) y parámetros de marca de tiempo opcionales (por defecto 1 hora) para definir el rango de tiempo. Devuelve puntos de datos de costos a lo largo del tiempo en lugar de un solo valor agregado. Nota: Los datos de costos en la nube suelen tener un retraso de 24 a 48 horas, por lo que las marcas de tiempo recientes pueden no devolver resultados. | ++ {{< code-block lang="sql" >}} +SELECT * +FROM dd.cloud_cost_timeseries( + 'sum:all.cost{*} by {service}', + TIMESTAMP '2025-07-10 00:00:00.000-04:00', + TIMESTAMP '2025-07-17 00:00:00.000-04:00' +) +ORDER BY timestamp, service;{{< /code-block >}} + | +