The identity and technical contract details declared by the specification.
LogsMetricResponseFilter
object
The log-based metric filter. Logs matching this filter will be aggregated in this metric.
1 property
GitCommitSHA
string
Git Commit SHA.
MetricScalarQuery
object
Request body for querying scalar metric data
1 property
1 required
MetricTimeseriesQuery
object
Request body for querying timeseries metric data
1 property
1 required
MetricMonitorType
string
Monitor resource type.
RumMetricUpdateRequest
object
The new rum-based metric body.
1 property
1 required
MetricDistinctVolume
object
Object for a single metric's distinct volume.
3 properties
JSONAPIErrorItem
object
API error response body
5 properties
SpansMetricComputeIncludePercentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregationtype is distribution.
MetricCustomAggregations
array
Deprecated. You no longer need to configure specific time and space aggregations for Metrics Without Limits.
APIErrorResponse_2
object
Standard API error response returned for failed requests
1 property
1 required
MetricBulkTagConfigDeleteRequest
object
Wrapper object for a single bulk tag deletion request.
1 property
1 required
MetricBulkTagConfigDelete
object
Request object to bulk delete all tag configurations for metrics matching the given prefix.
3 properties
2 required
MetricQueryDefinition
object
A metric query definition referencing a Datadog metrics query expression
3 properties
3 required
MetricScalarResponse
object
Response containing scalar metric values for the requested queries
1 property
MetricMetadata
object
Metadata for the metric.
1 property
MetricVolumes
Possible response objects for a metric's volume.
LogsMetricCreateAttributes
object
The object describing the Datadog log-based metric to create.
3 properties
1 required
LogsMetricResponseAttributes
object
The object describing a Datadog log-based metric.
3 properties
DORADeploymentRequestAttributes
object
Attributes to create a DORA deployment event.
8 properties
3 required
MetricCustomAggregation
object
A time and space aggregation combination for use in query.
2 properties
2 required
DORAGitInfo
object
Git info for DORA Metrics events.
2 properties
2 required
MetricAssetDashboardRelationship
object
An object of type dashboard that can be referenced in the included data.
2 properties
SpansMetricFilter
object
The span-based metric filter. Spans matching this filter will be aggregated in this metric.
1 property
RumMetricUniqueness
object
The rule to count updatable events. Is only set if eventtype is sessions or views.
1 property
1 required
MetricNotebookType
string
Notebook resource type.
MetricTagConfigurationType
string
The metric tag configuration resource type.
MetricResource
object
Metric resource.
2 properties
RumMetricType
string
The type of the resource. The value should always be rummetrics.
JSONAPIErrorResponse
object
API error response.
1 property
1 required
MetricDashboardAsset
object
A dashboard object with title and popularity.
3 properties
2 required
MetricPoint
object
A point object is of the form {POSIXtimestamp, numericvalue}.
2 properties
LogsMetricResponse
object
The log-based metric object.
1 property
DORAIncidentRequest
object
Request to create a DORA incident event.
1 property
1 required
SpansMetricUpdateCompute
object
The compute rule to compute the span-based metric.
1 property
SpansMetricResponseAttributes
object
The object describing a Datadog span-based metric.
3 properties
MetricIngestedIndexedVolume
object
Object for a single metric's ingested and indexed volume.
3 properties
MetricTagConfigurationMetricTypeCategory
string
The metric's type category.
MetricBulkTagConfigResponse
object
Wrapper for a single bulk tag configuration status response.
1 property
LogsMetricCreateRequest
object
The new log-based metric body.
1 property
1 required
RumMetricUpdateData
object
The new rum-based metric properties.
3 properties
2 required
SpansMetricGroupBy
object
A group by rule.
2 properties
1 required
DORAIncidentRequestAttributes
object
Attributes to create a DORA incident event.
10 properties
1 required
RumMetricComputeAggregationType
string
The type of aggregation to use.
MetricCustomSpaceAggregation
string
A space aggregation for use in query.
DORAIncidentResponseData
object
Response after receiving a DORA incident event.
2 properties
1 required
MetricPayload
object
The metrics' payload.
1 property
1 required
MetricIngestedIndexedVolumeType
string
The metric ingested and indexed volume type.
LogsMetricResponseGroupBy
object
A group by rule.
2 properties
MetricTagConfigurationMetricTypes
string
The metric's type.
SpansMetricUpdateRequest
object
The new span-based metric body.
1 property
1 required
MetricBulkTagConfigCreate
object
Request object to bulk configure tags for metrics matching the given prefix.
3 properties
2 required
SpansMetricCreateAttributes
object
The object describing the Datadog span-based metric to create.
3 properties
1 required
QueryFormula
object
A formula expression that combines one or more query results
3 properties
1 required
MetricMetaPage
object
Paging attributes. Only present if pagination query parameters were provided.
4 properties
MetricsListResponseLinks
object
Pagination links. Only present if pagination query parameters were provided.
5 properties
MetricAssetSLORelationship
object
An object of type slos that can be referenced in the included data.
2 properties
MetricBulkTagConfigNamePrefix
string
A text prefix to match against metric names.
LogsMetricUpdateCompute
object
The compute rule to compute the log-based metric.
1 property
MetricAssetDashboardRelationships
object
An object containing the list of dashboards that can be referenced in the included data.
1 property
MetricSLOAsset
object
A SLO object with title.
3 properties
2 required
MetricAssetAttributes
object
Assets related to the object, including title and url.
2 properties
MetricBulkTagConfigStatus
object
The status of a request to bulk configure metric tags. It contains the fields from the original request for reference.
3 properties
2 required
DORADeploymentType
string
JSON:API type for DORA deployment events.
MetricAssetResponseRelationships
object
Relationships to assets related to the metric.
4 properties
SpansMetricResponseCompute
object
The compute rule to compute the span-based metric.
3 properties
MetricTagConfigurationAttributes
object
Object containing the definition of a metric tag configuration attributes.
7 properties
LogsMetricsResponse
object
All the available log-based metric objects.
1 property
LogsMetricUpdateAttributes
object
The log-based metric properties that will be updated.
3 properties
JSONAPIErrorItemSource
object
References to the source of the error.
3 properties
MetricsAndMetricTagConfigurationsResponse
object
Response object that includes metrics and metric tag configurations.
3 properties
DORADeploymentRequest
object
Request to create a DORA deployment event.
1 property
1 required
MetricBulkTagConfigDeleteAttributes
object
Optional parameters for bulk deleting metric tag configurations.
1 property
MetricAssetNotebookRelationships
object
An object containing the list of notebooks that can be referenced in the included data.
1 property
MetricDistinctVolumeAttributes
object
Object containing the definition of a metric's distinct volume.
1 property
MetricBulkTagConfigTagNameList
array
A list of tag names to apply to the configuration.
MetricType
string
The metric resource type.
MetricNotebookAsset
object
A notebook object with title.
3 properties
2 required
MetricAssetNotebookRelationship
object
An object of type notebook that can be referenced in the included data.
2 properties
RumMetricID
string
The name of the rum-based metric.
MetricIngestedIndexedVolumeAttributes
object
Object containing the definition of a metric's ingested and indexed volume.
2 properties
DORAIncidentType
string
JSON:API type for DORA incident events.
RumMetricResponseGroupBy
object
A group by rule.
2 properties
TimeseriesResult
object
A single timeseries result for a query formula
4 properties
MetricAllTags
object
Object for a single metric's indexed tags.
3 properties
MetricBulkTagConfigStatusAttributes
object
Optional attributes for the status of a bulk tag configuration request.
4 properties
RumMetricComputeIncludePercentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics. Only present when aggregationtype is distribution.
SpansMetricUpdateData
object
The new span-based metric properties.
2 properties
2 required
SpansMetricUpdateAttributes
object
The span-based metric properties that will be updated.
3 properties
DORADeploymentResponse
object
Response after receiving a DORA deployment event.
1 property
1 required
LogsMetricUpdateRequest
object
The new log-based metric body.
1 property
1 required
MetricsAndMetricTagConfigurations
Object for a metrics and metric tag configurations.
MetricAssetSLORelationships
object
An object containing a list of SLOs that can be referenced in the included data.
1 property
SpansMetricCreateRequest
object
The new span-based metric body.
1 property
1 required
APIErrorResponse
object
API error response.
1 property
1 required
LogsMetricID
string
The name of the log-based metric.
RumMetricResponseUniqueness
object
The rule to count updatable events. Is only set if eventtype is session or view.
1 property
MetricOrigin
object
Metric origin information.
3 properties
MetricSeries
object
A metric to submit to Datadog. See [Datadog metrics](https://docs.datadoghq.com/developers/metrics/custom-metrics-properties).
9 properties
2 required
SpansMetricResponseFilter
object
The span-based metric filter. Spans matching this filter will be aggregated in this metric.
1 property
MetricBulkConfigureTagsType
string
The metric bulk configure tags resource.
RumMetricResponseAttributes
object
The object describing a Datadog rum-based metric.
5 properties
RumMetricGroupBy
object
A group by rule.
2 properties
1 required
MetricMetaPageType
string
Type of metric pagination.
MetricAllTagsResponse
object
Response object that includes a single metric's indexed tags.
1 property
RumMetricEventType
string
The type of RUM events to filter on.
MetricDashboardID
string
The related dashboard's ID.
LogsMetricGroupBy
object
A group by rule.
2 properties
1 required
DORAIncidentRequestData
object
The JSON:API data.
1 property
1 required
SpansMetricCreateData
object
The new span-based metric properties.
3 properties
3 required
MetricAllTagsAttributes
object
Object containing the definition of a metric's tags.
1 property
MetricAssetMonitorRelationship
object
An object of type monitor that can be referenced in the included data.
2 properties
MetricMonitorID
string
The related monitor's ID.
RumMetricUniquenessWhen
string
When to count updatable events. match when the event is first seen, or end when the event is complete.
LogsMetricResponseCompute
object
The compute rule to compute the log-based metric.
3 properties
RumMetricCreateAttributes
object
The object describing the Datadog rum-based metric to create.
5 properties
2 required
SpansMetricResponseGroupBy
object
A group by rule.
2 properties
SpansMetricID
string
The name of the span-based metric.
IntakePayloadAccepted
object
The payload accepted for intake.
1 property
MetricBulkTagConfigEmailList
array
A list of account emails to notify when the configuration is applied.
RumMetricResponseCompute
object
The compute rule to compute the rum-based metric.
3 properties
MetricSLOID
string
The SLO ID.
SpansMetricsResponse
object
All the available span-based metric objects.
1 property
MetricTimeseriesResponse
object
Response containing timeseries metric data for the requested queries
1 property
DORADeploymentResponseData
object
The JSON:API data.
2 properties
1 required
MetricDashboardType
string
Dashboard resource type.
LogsMetricCompute
object
The compute rule to compute the log-based metric.
3 properties
1 required
GitRepositoryURL
string
Git Repository URL
MetricBulkTagConfigCreateRequest
object
Wrapper object for a single bulk tag configuration request.
1 property
1 required
RumMetricResponseData
object
The rum-based metric properties.
3 properties
LogsMetricComputeAggregationType
string
The type of aggregation to use.
Metric
object
Object for a single metric tag configuration.
2 properties
MetricIntakeType
integer
The type of metric. The available types are 0 (unspecified), 1 (count), 2 (rate), and 3 (gauge).
RumMetricResponse
object
The rum-based metric object.
1 property
MetricBulkTagConfigCreateAttributes
object
Optional parameters for bulk creating metric tag configurations.
5 properties
SpansMetricResponseData
object
The span-based metric properties.
3 properties
MetricName
string
The metric name for this resource.
RumMetricCompute
object
The compute rule to compute the rum-based metric.
3 properties
1 required
LogsMetricResponseComputeAggregationType
string
The type of aggregation to use.
MetricPaginationMeta
object
Response metadata object.
1 property
MetricDashboardAttributes
object
Attributes related to the dashboard, including title, popularity, and url.
3 properties
MetricMonitorAsset
object
A monitor object with title.
3 properties
2 required
LogsMetricCreateData
object
The new log-based metric properties.
3 properties
3 required
MetricTagConfiguration
object
Object for a single metric tag configuration.
3 properties
RumMetricsResponse
object
All the available rum-based metric objects.
1 property
MetricNotebookID
string
The related notebook's ID.
RumMetricUpdateAttributes
object
The rum-based metric properties that will be updated.
3 properties
MetricAssetResponseData
object
Metric assets response data.
3 properties
2 required
RumMetricResponseFilter
object
The rum-based metric filter. RUM events matching this filter will be aggregated in this metric.
1 property
LogsMetricFilter
object
The log-based metric filter. Logs matching this filter will be aggregated in this metric.
1 property
RumMetricFilter
object
The rum-based metric filter. Events matching this filter will be aggregated in this metric.
1 property
1 required
DORAIncidentResponse
object
Response after receiving a DORA incident event.
1 property
1 required
LogsMetricResponseData
object
The log-based metric properties.
3 properties
DORADeploymentRequestData
object
The JSON:API data.
1 property
1 required
RumMetricCreateData
object
The new rum-based metric properties.
3 properties
3 required
MetricAssetMonitorRelationships
object
A object containing the list of monitors that can be referenced in the included data.
1 property
MetricDistinctVolumeType
string
The metric distinct volume type.
MetricAssetsResponse
object
Response object that includes related dashboards, monitors, notebooks, and SLOs.
2 properties
SpansMetricType
string
The type of resource. The value should always be spansmetrics.
MetricVolumesResponse
object
Response object which includes a single metric's volume.
1 property
MetricContentEncoding
string
HTTP header used to compress the media-type.
ScalarColumn
object
A single column of scalar results from a query formula
3 properties
RumMetricUpdateCompute
object
The compute rule to compute the rum-based metric.
1 property
LogsMetricComputeIncludePercentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics. Only present when the aggregationtype is distribution.
SpansMetricResponse
object
The span-based metric object.
1 property
SpansMetricCompute
object
The compute rule to compute the span-based metric.
3 properties
1 required
LogsMetricUpdateData
object
The new log-based metric properties.
2 properties
2 required
MetricAssetResponseIncluded
List of included assets with full set of attributes.
MetricSLOType
string
SLO resource type.
LogsMetricType
string
The type of the resource. The value should always be logsmetrics.
MetricCustomTimeAggregation
string
A time aggregation for use in query.
RumMetricCreateRequest
object
The new rum-based metric body.
1 property
1 required
SpansMetricComputeAggregationType
string
The type of aggregation to use.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.