Datadog Queries API is one of 290 APIs that Datadog publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 4 JSON Schema definitions.
Tagged areas include Query. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an API reference, and 4 JSON Schemas.
This API exposes
12 operations
across 7 paths,
and defines 73 schemas.
It is described by OpenAPI 3.0.0, at version 1.0.
Requests are made against 3 base URLs: https://{subdomain}.{site}, {protocol}://{name}, https://{subdomain}.{site}.
The identity and technical contract details declared by the specification.
RestrictionQueryWithoutRelationships
object
Restriction query object returned by the API.
3 properties
Unit
object
Object containing the metric unit family, scale factor, name, and short name.
5 properties
ScalarMeta
object
Metadata for the resulting numerical values.
1 property
RestrictionQueryRole
object
Partial role object.
3 properties
RestrictionQueryAttributes
object
Attributes of the restriction query.
3 properties
ScalarFormulaRequestType
string
The type of the resource. The value should always be scalarrequest.
EventsQueryGroupBys
array
The list of facets on which to split results.
RestrictionQueryResponseIncludedItem
An object related to a restriction query.
RestrictionQueryWithRelationshipsResponse
object
Response containing information about a single restriction query.
2 properties
ScalarColumnTypeNumber
string
The type of column present for numbers.
TimeseriesFormulaQueryRequest
object
A request wrapper around a single timeseries query to be executed.
1 property
1 required
EventsCompute
object
The instructions for what to compute for this query.
3 properties
1 required
TimeseriesFormulaResponseType
string
The type of the resource. The value should always be timeseriesresponse.
EventsGroupBySort
object
The dimension by which to sort a query's results.
4 properties
1 required
ScalarColumnTypeGroup
string
The type of column present for groups.
GroupScalarColumn
object
A column containing the tag keys and values in a group.
3 properties
MetricsAggregator
string
The type of aggregation that can be performed on metrics-based queries.
MetricsScalarQuery
object
An individual scalar metrics query.
4 properties
3 required
TimeseriesFormulaRequestAttributes
object
The object describing a timeseries formula request.
5 properties
3 required
EventsAggregation
string
The type of aggregation that can be performed on events-based queries.
RestrictionQueryCreateData
object
Data related to the creation of a restriction query.
2 properties
QueryFormula
object
A formula for calculation based on one or more queries.
2 properties
1 required
TimeseriesResponseSeriesList
array
Array of response series. The index here corresponds to the index in the formulas or queries array from the request.
EventsSortType
string
The type of sort to use on the calculated value.
ScalarFormulaRequest
object
A single scalar query to be executed.
2 properties
2 required
RestrictionQueryCreatePayload
object
Create a restriction query.
1 property
ScalarFormulaQueryRequest
object
A wrapper request around one scalar query to be executed.
1 property
1 required
RelationshipToRole
object
Relationship to role.
1 property
EventsDataSource
string
A data source that is powered by the Events Platform.
ScalarResponse
object
A message containing the response to a scalar query.
2 properties
TimeseriesQuery
An individual timeseries query to one of the basic Datadog data sources.
TimeseriesResponseValuesList
array
Array of value-arrays. The index here corresponds to the index in the formulas or queries array from the request.
ScalarFormulaResponseAtrributes
object
The object describing a scalar response.
1 property
RestrictionQueryWithRelationships
object
Restriction query object returned by the API.
4 properties
ScalarFormulaRequestQueries
array
List of queries to be run and used as inputs to the formulas.
RestrictionQueryUpdateData
object
Data related to the update of a restriction query.
2 properties
RestrictionQueryUpdateAttributes
object
Attributes of the edited restriction query.
1 property
MetricsDataSource
string
A data source that is powered by the Metrics platform.
EventsTimeseriesQuery
object
An individual timeseries events query.
6 properties
2 required
QuerySortOrder
string
Direction of sort.
LogsRestrictionQueriesType
string
Restriction query resource type.
ScalarQuery
An individual scalar query to one of the basic Datadog data sources.
ScalarFormulaResponseType
string
The type of the resource. The value should always be scalarresponse.
RestrictionQueryUpdatePayload
object
Update a restriction query.
1 property
EventsSearch
object
Configuration of the search/filter for an events query.
1 property
GroupTags
array
List of tags that apply to a single response value.
RestrictionQueryRoleAttribute
object
Attributes of the role for a restriction query.
1 property
APIErrorResponse
object
API error response.
1 property
1 required
RestrictionQueryCreateAttributes
object
Attributes of the created restriction query.
1 property
TimeseriesFormulaRequest
object
A single timeseries query to be executed.
2 properties
2 required
TimeseriesFormulaRequestQueries
array
List of queries to be run and used as inputs to the formulas.
TimeseriesResponseValues
array
Array of values for an individual formula or query.
ScalarFormulaRequestAttributes
object
The object describing a scalar formula request.
4 properties
3 required
TimeseriesResponseSeries
object
3 properties
RelationshipToRoleData
object
Relationship to role object.
2 properties
EventsScalarQuery
object
An individual scalar events query.
6 properties
2 required
TimeseriesResponseAttributes
object
The object describing a timeseries response.
3 properties
EventsGroupBy
object
A dimension on which to split a query's results.
3 properties
1 required
TimeseriesResponse
object
A message containing the response to a timeseries query.
2 properties
TimeseriesResponseTimes
array
Array of times, 1-1 match with individual values arrays.
RestrictionQueryWithoutRelationshipsResponse
object
Response containing information about a single restriction query.
1 property
TimeseriesFormulaQueryResponse
object
A message containing one response to a timeseries query made with timeseries formula query request.
2 properties
RelationshipToRoles
object
Relationship to roles.
1 property
MetricsTimeseriesQuery
object
An individual timeseries metrics query.
3 properties
2 required
RestrictionQueryListResponse
object
Response containing information about multiple restriction queries.
1 property
RestrictionQueryRolesResponse
object
Response containing information about roles attached to a restriction query.
1 property
ScalarFormulaQueryResponse
object
A message containing one or more responses to scalar queries.
2 properties
RestrictionQueryRelationships
object
Relationships of the restriction query object.
1 property
ScalarColumn
A single column in a scalar query response.
DataScalarColumn
object
A column containing the numerical results for a formula or query.
4 properties
TimeseriesFormulaRequestType
string
The type of the resource. The value should always be timeseriesrequest.
RolesType
string
Roles type.
FormulaLimit
object
Message for specifying limits to the number of values returned by a query. This limit is only for scalar queries and has no effect on timeseries queries.
2 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Datadog publishes across the network.
