The identity and technical contract details declared by the specification.
RUMApplicationUpdateRequest
object
RUM application update request.
1 property
1 required
UsersType
string
Users resource type.
RUMApplicationUpdate
object
RUM application update.
3 properties
2 required
DataTransformType
string
The data transform type.
RUMApplicationListType
string
RUM application list type.
StateVariableType
string
The state variable type.
RUMApplicationCreateRequest
object
RUM application creation request attributes.
1 property
1 required
RUMApplicationUpdateType
string
RUM application update type.
StateVariable
object
A variable, which can be set and read by other components in the app.
4 properties
4 required
JSONAPIErrorItem
object
API error response body
5 properties
ActionQueryCondition
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.
ActionQuery
object
An action query. This query type is used to trigger an action, such as sending a HTTP request.
5 properties
4 required
ComponentType
string
The UI component type.
LeakedKeyAttributes
object
The definition of LeakedKeyAttributes object.
2 properties
1 required
UsageTimeSeriesObject
object
Usage timeseries data.
2 properties
ActionQueryShowToastOnError
Whether to display a toast to the user when the query returns an error.
ActionQuerySpecInputs
The inputs to the action query. These are the values that are passed to the action when it is triggered.
DataTransform
object
A data transformer, which is custom JavaScript code that executes and transforms data when its inputs change.
4 properties
4 required
UserAttributes
object
Attributes of user object returned by the API.
12 properties
Component
object
[Definition of a UI component in the app](https://docs.datadoghq.com/servicemanagement/appbuilder/components/)
5 properties
3 required
DeploymentAttributes
object
The attributes object containing the version ID of the published app.
1 property
CustomConnectionAttributesOnPremRunner
object
Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner.
2 properties
DeploymentRelationship
object
Information pointing to the app's publication status.
2 properties
PartialApplicationKeyResponse
object
Response for retrieving a partial application key.
2 properties
JSONAPIErrorResponse
object
API error response.
1 property
1 required
ActionQueryPollingIntervalInMs
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…
ListAppsResponse
object
A paginated list of apps matching the specified filters and sorting.
3 properties
GetAppResponseDataAttributes
object
The app definition attributes, such as name, description, and components.
7 properties
ListApplicationKeysResponse
object
Response for a list of application keys.
3 properties
ListAppsResponseDataItems
object
An app definition object. This contains only basic information about the app such as ID, name, and tags.
5 properties
3 required
ActionQueryType
string
The action query type.
RoleAttributes
object
Attributes of the role.
4 properties
FullApplicationKey
object
Datadog application key.
4 properties
ActionQueryMockedOutputsObject
object
The mocked outputs of the action query.
2 properties
1 required
ApplicationKeyUpdateAttributes
object
Attributes used to update an application Key.
2 properties
AppsSortField
string
The field and direction to sort apps by
User
object
User object returned by the API.
4 properties
RUMApplicationCreateAttributes
object
RUM application creation attributes.
2 properties
1 required
RelationshipToUser
object
Relationship to user.
1 property
1 required
UnpublishAppResponse
object
The response object after an app is successfully unpublished.
1 property
ActionQueryOnlyTriggerManually
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 que…
ActionQueryMockedOutputs
The mocked outputs of the action query. This is useful for testing the app without actually running the action.
PublishAppResponse
object
The response object after an app is successfully published.
1 property
ComponentProperties
object
Properties of a UI component. Different component types can have their own additional unique properties. See the [components documentation](https://docs.datado…
2 properties
RelationshipToOrganization
object
Relationship to an organization.
1 property
1 required
RelationshipToPermissionData
object
Relationship to permission object.
2 properties
CreateAppResponseData
object
The data object containing the app ID.
2 properties
2 required
RUMApplicationsResponse
object
RUM applications response.
1 property
ApplicationKeyResponseIncludedItem
An object related to an application key.
CustomConnection
object
A custom connection used by an app.
3 properties
RelationshipToUserData
object
Relationship to user object.
2 properties
2 required
ActionQueryDebounceInMs
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…
AppDefinitionType
string
The app definition type.
Query
A data query used by an app. This can take the form of an external action, a data transformation, or a state variable.
HourlyUsageType
string
Usage type that is being measured.
ComponentGridProperties
object
Properties of a grid component.
3 properties
AppBuilderEventType
string
The response to the event.
ActionQuerySpec
The definition of the action query.
ComponentGridPropertiesIsVisible
Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean.
CustomConnectionAttributes
object
The custom connection attributes.
2 properties
Deployment
object
The version of the app that was published.
4 properties
DeleteAppResponseData
object
The definition of DeleteAppResponseData object.
2 properties
2 required
RUMApplicationResponse
object
RUM application response.
1 property
DeploymentMetadata
object
Metadata object containing the publication creation information.
4 properties
ActionQueryMockedOutputsEnabled
Whether to enable the mocked outputs for testing.
ApplicationKeyResponse
object
Response for retrieving an application key.
2 properties
ListAppsResponseDataItemsAttributes
object
Basic information about the app such as name, description, and tags.
5 properties
AppBuilderEvent
object
An event on a UI component that triggers a response or action in an app.
2 properties
ApplicationKeyCreateData
object
Object used to create an application key.
2 properties
2 required
AppBuilderEventName
string
The triggering action for the event.
JSONAPIErrorItemSource
object
References to the source of the error.
3 properties
FullApplicationKeyAttributes
object
Attributes of a full application key.
5 properties
DeploymentRelationshipData
object
Data object containing the deployment ID.
2 properties
RUMApplicationCreateType
string
RUM application creation type.
CreateAppResponse
object
The response object after a new app is successfully created, with the app ID.
1 property
ComponentGrid
object
A grid component. The grid component is the root canvas for an app and contains all other components.
5 properties
3 required
OrganizationsType
string
Organizations resource type.
RUMApplicationType
string
RUM application response type.
ApplicationKeyRelationships
object
Resources related to the application key.
1 property
UsageTimeSeriesType
string
Type of usage data.
LeakedKey
object
The definition of LeakedKey object.
3 properties
3 required
ApplicationKeysType
string
Application Keys resource type.
DeleteAppsResponse
object
The response object after multiple apps are successfully deleted.
1 property
RUMApplicationList
object
RUM application list.
3 properties
2 required
ApplicationKeyCreateAttributes
object
Attributes used to create an application Key.
2 properties
1 required
UpdateAppResponseData
object
The data object containing the updated app definition.
3 properties
3 required
UpdateAppRequestDataAttributes
object
App definition attributes to be updated, such as name, description, and components.
6 properties
DataTransformProperties
object
The properties of the data transformer.
1 property
APIErrorResponse
object
API error response.
1 property
1 required
UserResponseRelationships
object
Relationships of the user object returned by the API.
4 properties
AppRelationship
object
The app's publication relationship and custom connections.
2 properties
ActionQuerySpecObject
object
The action query spec object.
4 properties
1 required
ApplicationKeyCreateRequest
object
Request used to create an application key.
1 property
1 required
ListAppsResponseMeta
object
Pagination metadata.
1 property
CreateAppRequest
object
A request object for creating a new app.
1 property
ApplicationKeyUpdateRequest
object
Request used to update an application key.
1 property
1 required
ActionQueryRequiresConfirmation
Whether to prompt the user to confirm this query before it runs.
UsageApplicationSecurityMonitoringResponse
object
Application Security Monitoring usage response.
1 property
DeleteAppResponse
object
The response object after an app is successfully deleted.
1 property
RUMApplicationUpdateAttributes
object
RUM application update attributes.
2 properties
RoleResponseRelationships
object
Relationships of the role object returned by the API.
1 property
DeleteAppsRequestDataItems
object
An object containing the ID of an app to delete.
2 properties
2 required
ApplicationKeyResponseMeta
object
Additional information related to the application key response.
2 properties
CreateAppRequestData
object
The data object containing the app definition.
2 properties
1 required
GetAppResponseData
object
The data object containing the app definition.
3 properties
3 required
UsageAttributesObject
object
Usage attributes data.
6 properties
RelationshipToRoleData
object
Relationship to role object.
2 properties
UpdateAppResponse
object
The response object after an app is successfully updated.
4 properties
ApplicationKeyUpdateData
object
Object used to update an application key.
3 properties
3 required
StateVariableProperties
object
The properties of the state variable.
1 property
RelationshipToOrganizationData
object
Relationship to organization object.
2 properties
2 required
PartialApplicationKeyAttributes
object
Attributes of a partial application key.
4 properties
Role
object
Role object returned by the API.
4 properties
1 required
ActionQuerySpecConnectionGroup
object
The connection group to use for an action query.
2 properties
ComponentPropertiesIsVisible
Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
RelationshipToUsers
object
Relationship to users.
1 property
1 required
ActionQuerySpecInput
object
The inputs to the action query. See the [Actions Catalog](https://docs.datadoghq.com/actions/actionscatalog/) for more detail on each action and its inputs.
ListAppsResponseDataItemsRelationships
object
The app's publication information.
1 property
RUMApplication
object
RUM application.
3 properties
3 required
AppMeta
object
Metadata of an app.
9 properties
PermissionsType
string
Permissions resource type.
DeleteAppsRequest
object
A request object for deleting multiple apps by ID.
1 property
ApplicationKeyResponseMetaPage
object
Additional information related to the application key response.
1 property
RUMApplicationAttributes
object
RUM application attributes.
11 properties
9 required
PartialApplicationKey
object
Partial Datadog application key.
4 properties
ListAppsResponseMetaPage
object
Information on the total number of apps, to be used for pagination.
2 properties
ApplicationKeysSort
string
Sorting options
RelationshipToRoles
object
Relationship to roles.
1 property
GetAppResponse
object
The full app definition response object.
4 properties
LeakedKeyType
string
The definition of LeakedKeyType object.
RelationshipToOrganizations
object
Relationship to organizations.
1 property
1 required
RUMApplicationCreate
object
RUM application creation.
2 properties
2 required
ComponentGridType
string
The grid component type.
RUMApplicationListAttributes
object
RUM application list attributes.
10 properties
8 required
UsageDataObject
object
Usage data.
3 properties
CustomConnectionType
string
The custom connection type.
ActionQueryProperties
object
The properties of the action query.
9 properties
1 required
UpdateAppResponseDataAttributes
object
The updated app definition attributes, such as name, description, and components.
7 properties
DeleteAppsResponseDataItems
object
An object containing the ID of a deleted app.
2 properties
2 required
UpdateAppRequest
object
A request object for updating an existing app.
1 property
AppDeploymentType
string
The deployment type.
RolesType
string
Roles type.
UpdateAppRequestData
object
The data object containing the new app definition. Any fields not included in the request remain unchanged.
3 properties
1 required
RelationshipToPermissions
object
Relationship to multiple permissions objects.
1 property
CreateAppRequestDataAttributes
object
App definition attributes such as name, description, and components.
6 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.