The identity and technical contract details declared by the specification.
CIAppGroupByTotal
A resulting object to put the given computes in over all the matching records.
LogsAggregateRequestPage
object
Paging settings
1 property
CIAppAggregateBucketValueSingleString
string
A single string value.
RUMResponseStatus
string
The status of the response.
LogsAggregateBucketValueSingleString
string
A single string value
CIAppPipelinesAggregationBucketsResponse
object
The query results.
1 property
CIAppComputeType
string
The type of compute.
SpansAggregateData
object
The object containing the query content.
2 properties
SpansAggregateSortType
string
The type of sorting algorithm.
SpansGroupByHistogram
object
Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
3 properties
3 required
SpansAggregateResponse
object
The response object for the spans aggregate API endpoint.
2 properties
RUMAggregateRequest
object
The object sent with the request to retrieve aggregation buckets of RUM events from your organization.
5 properties
RUMGroupByTotalBoolean
boolean
If set to true, creates an additional bucket labeled "$facettotal".
SpansGroupByTotalString
string
A string to use as the key value for the total bucket.
CIAppGroupByMissing
The value to use for logs that don't have the facet used to group-by.
SpansGroupByTotalBoolean
boolean
If set to true, creates an additional bucket labeled "$facettotal".
CIAppCompute
object
A compute rule to compute metrics or timeseries.
4 properties
1 required
RUMAggregateBucketValueTimeseries
array
A timeseries array.
RUMGroupByTotalNumber
number
A number to use as the key value for the total bucket.
SpansGroupByTotalNumber
number
A number to use as the key value for the total bucket.
CIAppTestsQueryFilter
object
The search and filter query settings.
3 properties
LogsStorageTier
string
Specifies storage type as indexes, online-archives or flex
RUMResponseMetadata
object
The metadata associated with a request.
5 properties
CIAppTestsAggregateRequest
object
The object sent with the request to retrieve aggregation buckets of test events from your organization.
4 properties
SpansGroupBy
object
A group by rule.
6 properties
1 required
LogsGroupByTotalBoolean
boolean
If set to true, creates an additional bucket labeled "$facettotal"
SpansAggregateBucketAttributes
object
A bucket values.
3 properties
RUMAggregateBucketValueSingleString
string
A single string value.
SpansAggregationFunction
string
An aggregation function.
LogsAggregateBucketValueTimeseriesPoint
object
A timeseries point
2 properties
RUMGroupByTotal
A resulting object to put the given computes in over all the matching records.
CIAppGroupByTotalNumber
number
A number to use as the key value for the total bucket.
CIAppAggregateBucketValueSingleNumber
number
A single number value.
CIAppWarning
object
A warning message indicating something that went wrong with the query.
3 properties
LogsGroupByMissingNumber
number
The missing value to use if there is a number valued facet.
RUMQueryFilter
object
The search and filter query settings.
3 properties
SpansAggregateSort
object
A sort rule.
4 properties
CIAppAggregateSort
object
A sort rule. The aggregation field is required when type is measure.
4 properties
LogsAggregateSort
object
A sort rule
4 properties
SpansWarning
object
A warning message indicating something that went wrong with the query.
3 properties
CIAppComputes
object
A map of the metric name to value for regular compute, or a list of values for a timeseries.
SpansAggregateBucketValueSingleNumber
number
A single number value.
CIAppPipelinesGroupBy
object
A group-by rule.
6 properties
1 required
RUMQueryPageOptions
object
Paging attributes for listing events.
2 properties
LogsAggregateResponse
object
The response object for the logs aggregate API endpoint
2 properties
SpansAggregateRequestType
string
The type of resource. The value should always be aggregaterequest.
CIAppTestsGroupBy
object
A group-by rule.
6 properties
1 required
LogsGroupByTotalString
string
A string to use as the key value for the total bucket
SpansAggregateBucketType
string
The spans aggregate bucket type.
RUMAnalyticsAggregateResponse
object
The response object for the RUM events aggregate API endpoint.
3 properties
CIAppGroupByMissingNumber
number
The missing value to use if there is a number valued facet.
CIAppResponseStatus
string
The status of the response.
LogsResponseMetadataPage
object
Paging attributes.
1 property
SpansSortOrder
string
The order to use, ascending or descending.
RUMAggregateBucketValue
A bucket value, can be either a timeseries or a single value.
CIAppPipelinesBucketResponse
object
Bucket values.
2 properties
RUMQueryOptions
object
Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.
2 properties
SpansAggregateBucketValueTimeseriesPoint
object
A timeseries point.
2 properties
CIAppPipelinesQueryFilter
object
The search and filter query settings.
3 properties
RUMGroupByTotalString
string
A string to use as the key value for the total bucket.
CIAppAggregateSortType
string
The type of sorting algorithm.
RUMAggregationBucketsResponse
object
The query results.
1 property
SpansGroupByTotal
A resulting object to put the given computes in over all the matching records.
RUMAggregateSort
object
A sort rule.
4 properties
CIAppGroupByMissingString
string
The missing value to use if there is a string valued facet.
SpansAggregateBucketValueTimeseries
array
A timeseries array.
SpansAggregateRequestAttributes
object
The object containing all the query parameters.
4 properties
LogsGroupByHistogram
object
Used to perform a histogram computation (only for measure facets). Note: at most 100 buckets are allowed, the number of buckets is (max - min)/interval.
3 properties
3 required
LogsGroupByMissingString
string
The missing value to use if there is string valued facet.
LogsAggregateBucketValueSingleNumber
number
A single number value
CIAppAggregateBucketValueTimeseries
array
A timeseries array.
SpansAggregateRequest
object
The object sent with the request to retrieve a list of aggregated spans from your organization.
1 property
CIAppGroupByTotalString
string
A string to use as the key value for the total bucket.
LogsAggregateResponseStatus
string
The status of the response
CIAppAggregateBucketValue
A bucket value, can either be a timeseries or a single value.
LogsResponseMetadata
object
The metadata associated with a request
5 properties
LogsAggregateBucketValue
A bucket value, can be either a timeseries or a single value
RUMBucketResponse
object
Bucket values.
2 properties
SpansComputeType
string
The type of compute.
CIAppGroupByHistogram
object
Used to perform a histogram computation (only for measure facets). At most, 100 buckets are allowed, the number of buckets is (max - min)/interval.
3 properties
3 required
APIErrorResponse
object
API error response.
1 property
1 required
SpansAggregateBucketValue
A bucket value, can be either a timeseries or a single value.
SpansQueryOptions
object
Global query options that are used during the query. Note: You should only supply timezone or time offset but not both otherwise the query will fail.
2 properties
CIAppTestsBucketResponse
object
Bucket values.
2 properties
RUMGroupByMissingString
string
The missing value to use if there is string valued facet.
CIAppPipelinesAnalyticsAggregateResponse
object
The response object for the pipeline events aggregate API endpoint.
3 properties
CIAppAggregationFunction
string
An aggregation function.
RUMGroupByMissing
The value to use for logs that don't have the facet used to group by.
LogsSortOrder
string
The order to use, ascending or descending
CIAppTestsAnalyticsAggregateResponse
object
The response object for the test events aggregate API endpoint.
3 properties
LogsAggregationFunction
string
An aggregation function
LogsComputeType
string
The type of compute
CIAppAggregateBucketValueTimeseriesPoint
object
A timeseries point.
2 properties
CIAppQueryOptions
object
Global query options that are used during the query. Only supply timezone or time offset, not both. Otherwise, the query fails.
2 properties
SpansAggregateResponseMetadata
object
The metadata associated with a request.
4 properties
SpansAggregateResponseStatus
string
The status of the response.
RUMAggregateSortType
string
The type of sorting algorithm.
RUMGroupBy
object
A group-by rule.
6 properties
1 required
LogsAggregateBucketValueTimeseries
array
A timeseries array
CIAppResponseMetadataWithPagination
object
The metadata associated with a request.
5 properties
LogsGroupByMissing
The value to use for logs that don't have the facet used to group by
SpansGroupByMissingNumber
number
The missing value to use if there is a number valued facet.
SpansGroupByMissingString
string
The missing value to use if there is string valued facet.
LogsAggregateResponseData
object
The query results
1 property
RUMComputeType
string
The type of compute.
RUMSortOrder
string
The order to use, ascending or descending.
LogsQueryOptions
object
Global query options that are used during the query. Note: These fields are currently deprecated and do not affect the query results.
2 properties
LogsQueryFilter
object
The search and filter query settings
5 properties
RUMResponseLinks
object
Links attributes.
1 property
SpansAggregateBucket
object
Spans aggregate.
3 properties
CIAppTestsAggregationBucketsResponse
object
The query results.
1 property
RUMAggregateBucketValueSingleNumber
number
A single number value.
CIAppResponsePage
object
Paging attributes.
1 property
SpansCompute
object
A compute rule to compute metrics or timeseries.
4 properties
1 required
CIAppPipelinesAggregateRequest
object
The object sent with the request to retrieve aggregation buckets of pipeline events from your organization.
4 properties
SpansQueryFilter
object
The search and filter query settings.
3 properties
LogsWarning
object
A warning message indicating something that went wrong with the query
3 properties
RUMAggregateBucketValueTimeseriesPoint
object
A timeseries point.
2 properties
LogsGroupByTotal
A resulting object to put the given computes in over all the matching records.
LogsAggregateRequest
object
The object sent with the request to retrieve a list of logs from your organization.
5 properties
RUMWarning
object
A warning message indicating something that went wrong with the query.
3 properties
LogsCompute
object
A compute rule to compute metrics or timeseries
4 properties
1 required
CIAppResponseLinks
object
Links attributes.
1 property
CIAppSortOrder
string
The order to use, ascending or descending.
CIAppResponseMetadata
object
The metadata associated with a request.
4 properties
CIAppGroupByTotalBoolean
boolean
If set to true, creates an additional bucket labeled "$facettotal".
RUMResponsePage
object
Paging attributes.
1 property
SpansGroupByMissing
The value to use for spans that don't have the facet used to group by.
RUMAggregationFunction
string
An aggregation function.
RUMGroupByHistogram
object
Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
3 properties
3 required
LogsAggregateBucket
object
A bucket values
2 properties
LogsAggregateSortType
string
The type of sorting algorithm
LogsGroupByTotalNumber
number
A number to use as the key value for the total bucket
SpansAggregateBucketValueSingleString
string
A single string value.
RUMGroupByMissingNumber
number
The missing value to use if there is a number valued facet.
LogsGroupBy
object
A group by rule
6 properties
1 required
RUMCompute
object
A compute rule to compute metrics or timeseries.
4 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.
