Datadog · Schema

LogsGroupBy

A group-by configuration for aggregating log results by facet values

AnalyticsDashboardsMonitoringPlatformT1Visualizations

Properties

Name Type Description
facet string The log attribute or tag to group results by
limit integer The maximum number of unique facet values to return in results
sort object Sort configuration for group-by results
View JSON Schema on GitHub

JSON Schema

datadog-logs-logs-group-by-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/datadog/refs/heads/main/json-schema/datadog-logs-logs-group-by-schema.json",
  "title": "LogsGroupBy",
  "description": "A group-by configuration for aggregating log results by facet values",
  "type": "object",
  "properties": {
    "facet": {
      "type": "string",
      "description": "The log attribute or tag to group results by",
      "example": "example_value"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of unique facet values to return in results",
      "default": 10,
      "example": 42
    },
    "sort": {
      "type": "object",
      "description": "Sort configuration for group-by results",
      "properties": {
        "aggregation": {
          "type": "string",
          "description": "The aggregation metric to sort by",
          "enum": [
            "count",
            "cardinality",
            "pc75",
            "pc90",
            "pc95",
            "pc98",
            "pc99",
            "sum",
            "avg",
            "min",
            "max"
          ]
        },
        "order": {
          "type": "string",
          "description": "The sort direction for group-by results",
          "enum": [
            "asc",
            "desc"
          ]
        }
      }
    }
  },
  "required": [
    "facet"
  ]
}