mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Axiom Docs",
  "logo": {
    "dark": "/doc-assets/logo/dark.svg",
    "light": "/doc-assets/logo/light.svg"
  },
  "favicon": "/doc-assets/logo/favicon.svg",
  "colors": {
    "primary": "#104DEB",
    "light": "#98A0B1",
    "dark": "#104DEB",
    "background": {
      "light": "#FCFCFC",
      "dark": "#0B0B0B"
    }
  },
  "analytics": {
    "fathom": {
      "siteId": "BGVZPGXQ"
    }
  },
  "topbarLinks": [
    {
      "name": "Blog",
      "url": "https://axiom.co/blog"
    },
    {
      "name": "Support",
      "url": "https://axiom.co/support"
    }
  ],
  "topbarCtaButton": {
    "name": "Launch Axiom",
    "url": "https://app.axiom.co/login"
  },
  "tabs": [
    {
      "name": "Apps and integrations",
      "url": "apps"
    },
    {
      "name": "Query reference",
      "url": "apl"
    },
    {
      "name": "API reference",
      "url": "restapi"
    }
  ],
  "primaryTab": {
    "name": "Documentation"
  },
  "anchors": [
    {
      "name": "Axiom Playground",
      "icon": "play",
      "url": "https://axiom.co/play"
    },
    {
      "name": "Changelog",
      "icon": "laptop-code",
      "url": "https://axiom.co/changelog"
    },
    {
      "name": "Book a demo",
      "icon": "calendar",
      "url": "https://axiom.co/demo"
    }
  ],
  "navigation": [
    {
      "group": "Axiom 101",
      "pages": [
        "introduction",
        "getting-started-guide/getting-started",
        {
          "group": "Learn about Axiom",
          "icon": "book-font",
          "pages": [
            "getting-started-guide/event-data",
            "getting-started-guide/observability"
          ]
        },
        "get-help/faq"
      ]
    },
    {
      "group": "Send data to Axiom",
      "pages": [
        "send-data/ingest",
        {
          "group": "Collectors",
          "icon": "arrows-to-circle",
          "pages": [
            "send-data/convex",
            "send-data/cribl",
            "send-data/elastic-beats",
            "send-data/elasticsearch-bulk-api",
            "send-data/fluent-bit",
            "send-data/fluentd",
            "send-data/logstash",
            "send-data/vector",
            "send-data/tremor"
          ]
        },
        {
          "group": "Technologies",
          "icon": "microchip",
          "pages": [
            "send-data/datadog",
            "send-data/heroku-log-drains",
            "endpoints/honeycomb",
            "send-data/kubernetes",
            "endpoints/loki",
            "send-data/loki-multiplexer",
            "send-data/opentelemetry",
            "send-data/render",
            "send-data/serverless",
            "endpoints/splunk",
            "send-data/syslog-proxy"
          ]
        },
        {
          "group": "Languages",
          "icon": "language",
          "pages": [
            "guides/send-logs-from-dotnet",
            "guides/opentelemetry-dotnet",
            "guides/send-logs-from-apache-log4j",
            "guides/apex",
            "guides/opentelemetry-cloudflare-workers",
            "guides/opentelemetry-django",
            "guides/go",
            "guides/logrus",
            "guides/opentelemetry-go",
            "guides/opentelemetry-java",
            "guides/javascript",
            "guides/send-logs-from-laravel",
            "send-data/nextjs",
            "guides/opentelemetry-nextjs",
            "guides/opentelemetry-nodejs",
            "guides/pino",
            "guides/python",
            "guides/opentelemetry-python",
            "guides/send-logs-from-ruby-on-rails",
            "guides/opentelemetry-ruby",
            "guides/rust",
            "guides/winston",
            "guides/zap"
          ]
        },
        {
          "group": "AWS",
          "icon": "aws",
          "pages": [
            "send-data/aws-overview",
            "send-data/cloudwatch",
            "send-data/aws-firehose",
            "send-data/cloudfront",
            "send-data/aws-firelens",
            "send-data/aws-iot-rules",
            "send-data/aws-lambda",
            "send-data/aws-lambda-dot",
            "send-data/aws-s3"
          ]
        }
      ]
    },
    {
      "group": "Understand data",
      "pages": [
        {
          "group": "Query",
          "icon": "server",
          "pages": [
            "query-data/datasets",
            "query-data/stream",
            "query-data/explore",
            "query-data/visualizations",
            "query-data/virtual-fields",
            "query-data/traces"
          ]
        },
        {
          "group": "Dashboards",
          "icon": "chart-column",
          "pages": [
            "dashboards/overview",
            "dashboards/create",
            "dashboards/configure",
            "query-data/annotate-charts"
          ]
        },
        {
          "group": "Dashboard elements",
          "icon": "sparkles",
          "pages": [
            "dashboard-elements/overview",
            "dashboard-elements/create",
            "dashboard-elements/configure",
            {
              "group": "Dashboard element types",
              "pages": [
                "query-data/filters",
                "dashboard-elements/heatmap",
                "dashboard-elements/log-stream",
                "dashboard-elements/monitor-list",
                "dashboard-elements/note",
                "dashboard-elements/pie-chart",
                "dashboard-elements/scatter-plot",
                "dashboard-elements/statistic",
                "dashboard-elements/table",
                "dashboard-elements/time-series"
              ]
            }
          ]
        },
        {
          "group": "Monitors",
          "icon": "desktop",
          "pages": [
            "monitor-data/monitors",
            "monitor-data/configure-monitors",
            "monitor-data/monitor-examples",
            {
              "group": "Monitor types",
              "pages": [
                "monitor-data/anomaly-monitors",
                "monitor-data/match-monitors",
                "monitor-data/threshold-monitors"
              ]
            }
          ]
        },
        {
          "group": "Notifiers",
          "icon": "bell",
          "pages": [
            "monitor-data/notifiers-overview",
            "monitor-data/configure-notifiers",
            {
              "group": "Notifier types",
              "pages": [
                "monitor-data/custom-webhook-notifier",
                "monitor-data/discord-notifier",
                "monitor-data/email-notifier",
                "monitor-data/microsoft-teams-notifier",
                "monitor-data/opsgenie-notifier",
                "monitor-data/pagerduty",
                "monitor-data/slack-notifier"
              ]
            }
          ]
        }
      ]
    },
    {
      "group": "Process data",
      "pages": [
        {
          "group": "Flow",
          "icon": "arrow-progress",
          "pages": [
            "process-data/introduction",
            "process-data/flows",
            "process-data/security"
          ]
        },
        {
          "group": "Destinations",
          "icon": "arrows-turn-to-dots",
          "pages": [
            "process-data/destinations/manage-destinations",
            "process-data/destinations/axiom",
            "process-data/destinations/amazon-s3",
            "process-data/destinations/azure-blob",
            "process-data/destinations/elastic-bulk",
            "process-data/destinations/http",
            "process-data/destinations/opentelemetry",
            "process-data/destinations/splunk",
            "process-data/destinations/s3-compatible"
          ]
        }
      ]
    },
    {
      "group": "Management and billing",
      "pages": [
        {
          "group": "Data management",
          "icon": "database",
          "pages": [
            "reference/introduction",
            "reference/cli",
            "reference/datasets",
            "reference/query-hours"
          ]
        },
        {
          "group": "Organization",
          "icon": "users",
          "pages": [
            "reference/settings",
            "reference/audit-log",
            "reference/field-restrictions",
            "reference/performance",
            "reference/regions",
            "reference/tokens"
          ]
        },
        "reference/security"
      ]
    },
    {
      "group": "",
      "pages": [
        "apps/introduction",
        "apps/lambda",
        "apps/cloudflare-workers",
        "apps/cloudflare-logpush",
        "apps/grafana",
        "apps/netlify",
        "apps/tailscale",
        "apps/terraform",
        "apps/vercel"
      ]
    },
    {
      "group": "Get started",
      "pages": [
        "apl/introduction",
        "apl/tutorial"
      ]
    },
    {
      "group": "Functions",
      "pages": [
        {
          "group": "Scalar functions",
          "icon": "calendar-days",
          "pages": [
            {
              "group": "Array functions",
              "pages": [
                "apl/scalar-functions/array-functions",
                "apl/scalar-functions/array-functions/array-concat",
                "apl/scalar-functions/array-functions/array-iff",
                "apl/scalar-functions/array-functions/array-index-of",
                "apl/scalar-functions/array-functions/array-length",
                "apl/scalar-functions/array-functions/array-reverse",
                "apl/scalar-functions/array-functions/array-rotate-left",
                "apl/scalar-functions/array-functions/array-rotate-right",
                "apl/scalar-functions/array-functions/array-select-dict",
                "apl/scalar-functions/array-functions/array-shift-left",
                "apl/scalar-functions/array-functions/array-shift-right",
                "apl/scalar-functions/array-functions/array-slice",
                "apl/scalar-functions/array-functions/array-split",
                "apl/scalar-functions/array-functions/array-sum",
                "apl/scalar-functions/array-functions/isarray",
                "apl/scalar-functions/array-functions/pack-array",
                "apl/scalar-functions/array-functions/strcat-array"
              ]
            },
            "apl/scalar-functions/conditional-function",
            "apl/scalar-functions/conversion-functions",
            "apl/scalar-functions/datetime-functions",
            "apl/scalar-functions/hash-functions",
            {
              "group": "IP functions",
              "pages": [
                "apl/scalar-functions/ip-functions",
                "apl/scalar-functions/ip-functions/format-ipv4",
                "apl/scalar-functions/ip-functions/geo-info-from-ip-address",
                "apl/scalar-functions/ip-functions/has-any-ipv4",
                "apl/scalar-functions/ip-functions/has-any-ipv4-prefix",
                "apl/scalar-functions/ip-functions/has-ipv4",
                "apl/scalar-functions/ip-functions/has-ipv4-prefix",
                "apl/scalar-functions/ip-functions/ipv4-compare",
                "apl/scalar-functions/ip-functions/ipv4-is-in-range",
                "apl/scalar-functions/ip-functions/ipv4-is-in-any-range",
                "apl/scalar-functions/ip-functions/ipv4-is-match",
                "apl/scalar-functions/ip-functions/ipv4-is-private",
                "apl/scalar-functions/ip-functions/ipv4-netmask-suffix",
                "apl/scalar-functions/ip-functions/parse-ipv4",
                "apl/scalar-functions/ip-functions/parse-ipv4-mask"
              ]
            },
            "apl/scalar-functions/mathematical-functions",
            "apl/scalar-functions/pair-functions",
            "apl/scalar-functions/rounding-functions",
            "apl/scalar-functions/string-functions",
            "apl/scalar-functions/sql-functions"
          ]
        },
        {
          "group": "Aggregation functions",
          "icon": "sigma",
          "pages": [
            "apl/aggregation-function/statistical-functions",
            "apl/aggregation-function/avg",
            "apl/aggregation-function/avgif",
            "apl/aggregation-function/count",
            "apl/aggregation-function/countif",
            "apl/aggregation-function/dcount",
            "apl/aggregation-function/dcountif",
            "apl/aggregation-function/histogram",
            "apl/aggregation-function/make-list",
            "apl/aggregation-function/make-list-if",
            "apl/aggregation-function/make-set",
            "apl/aggregation-function/make-set-if",
            "apl/aggregation-function/max",
            "apl/aggregation-function/maxif",
            "apl/aggregation-function/min",
            "apl/aggregation-function/minif",
            "apl/aggregation-function/percentile",
            "apl/aggregation-function/percentileif",
            "apl/aggregation-function/rate",
            "apl/aggregation-function/stdev",
            "apl/aggregation-function/stdevif",
            "apl/aggregation-function/sum",
            "apl/aggregation-function/sumif",
            "apl/aggregation-function/topk",
            "apl/aggregation-function/variance",
            "apl/aggregation-function/varianceif"
          ]
        }
      ]
    },
    {
      "group": "Operators",
      "pages": [
        {
          "group": "Tabular operators",
          "icon": "table",
          "pages": [
            "apl/tabular-operators/overview",
            "apl/tabular-operators/count-operator",
            "apl/tabular-operators/distinct-operator",
            "apl/tabular-operators/extend-operator",
            "apl/tabular-operators/extend-valid-operator",
            "apl/tabular-operators/limit-operator",
            "apl/tabular-operators/order-operator",
            "apl/tabular-operators/parse-operator",
            "apl/tabular-operators/project-operator",
            "apl/tabular-operators/project-away-operator",
            "apl/tabular-operators/project-keep-operator",
            "apl/tabular-operators/project-reorder-operator",
            "apl/tabular-operators/sample-operator",
            "apl/tabular-operators/search-operator",
            "apl/tabular-operators/sort-operator",
            "apl/tabular-operators/summarize-operator",
            "apl/tabular-operators/take-operator",
            "apl/tabular-operators/top-operator",
            "apl/tabular-operators/union-operator",
            "apl/tabular-operators/where-operator"
          ]
        },
        {
          "group": "Scalar operators",
          "icon": "binary",
          "pages": [
            "apl/scalar-operators/logical-operators",
            "apl/scalar-operators/numerical-operators",
            "apl/scalar-operators/string-operators"
          ]
        }
      ]
    },
    {
      "group": "Reference",
      "pages": [
        {
          "group": "Reference",
          "icon": "book",
          "pages": [
            "apl/entities/entity-names",
            "apl/data-types/map-fields",
            "apl/data-types/null-values",
            "apl/data-types/scalar-data-types",
            "apl/query-statement/set-statement",
            "apl/reference/special-field-attributes"
          ]
        }
      ]
    },
    {
      "group": "Migration",
      "pages": [
        {
          "group": "Migration",
          "icon": "dove",
          "pages": [
            "apl/guides/splunk-cheat-sheet",
            "apl/guides/migrating-from-sql-to-apl",
            "apl/guides/migrating-from-sumologic-to-apl"
          ]
        }
      ]
    },
    {
      "group": "Get started",
      "pages": [
        "restapi/introduction",
        "restapi/ingest",
        "restapi/query",
        "restapi/pagination",
        "restapi/api-limits"
      ]
    },
    {
      "group": "User endpoints",
      "pages": [
        "restapi/endpoints/getCurrentUser"
      ]
    },
    {
      "group": "Dataset endpoints",
      "pages": [
        "restapi/endpoints/getDatasets",
        "restapi/endpoints/getDataset",
        "restapi/endpoints/createDataset",
        "restapi/endpoints/ingestIntoDataset",
        "restapi/endpoints/queryApl",
        "restapi/endpoints/queryDataset",
        "restapi/endpoints/trimDataset",
        "restapi/endpoints/updateDataset",
        "restapi/endpoints/deleteDataset"
      ]
    },
    {
      "group": "Annotation endpoints",
      "pages": [
        "restapi/endpoints/getAnnotations",
        "restapi/endpoints/getAnnotation",
        "restapi/endpoints/createAnnotation",
        "restapi/endpoints/updateAnnotation",
        "restapi/endpoints/deleteAnnotation"
      ]
    },
    {
      "group": "API token endpoints",
      "pages": [
        "restapi/endpoints/getTokens",
        "restapi/endpoints/getToken",
        "restapi/endpoints/createToken",
        "restapi/endpoints/regenerateToken",
        "restapi/endpoints/deleteToken"
      ]
    }
  ],
  "footerSocials": {
    "twitter": "https://twitter.com/AxiomFM",
    "github": "https://github.com/axiomhq",
    "linkedin": "https://linkedin.com/company/axiomhq"
  },
  "feedback": {
    "thumbsRating": true,
    "suggestEdit": true,
    "raiseIssue": true
  },
  "redirects": [
    {
      "source": "/index",
      "destination": "/introduction"
    },
    {
      "source": "/documentation",
      "destination": "/docs"
    },
    {
      "source": "/usage/analyze",
      "destination": "/query-data/datasets"
    },
    {
      "source": "/apl",
      "destination": "/apl/introduction"
    },
    {
      "source": "/data-shippers/api",
      "destination": "/data-shippers/overview"
    },
    {
      "source": "/usage/datasets",
      "destination": "/query-data/datasets"
    },
    {
      "source": "/usage/stream",
      "destination": "/query-data/stream"
    },
    {
      "source": "/usage/explore",
      "destination": "/query-data/explore"
    },
    {
      "source": "/monitor-data/explore",
      "destination": "/query-data/explore"
    },
    {
      "source": "/usage/dashboards",
      "destination": "/query-data/dashboards"
    },
    {
      "source": "/usage/alerts",
      "destination": "/monitor-data/monitors"
    },
    {
      "source": "/usage/monitors",
      "destination": "/monitor-data/monitors"
    },
    {
      "source": "/usage/settings",
      "destination": "/reference/settings"
    },
    {
      "source": "/data-shippers/fluentd",
      "destination": "/send-data/fluentd"
    },
    {
      "source": "/data-shippers/elastic-beats",
      "destination": "/send-data/elastic-beats"
    },
    {
      "source": "/data-shippers/fluent-bit",
      "destination": "/send-data/fluent-bit"
    },
    {
      "source": "/data-shippers/logstash",
      "destination": "/send-data/logstash"
    },
    {
      "source": "/data-shippers/loki-multiplexer",
      "destination": "/send-data/loki-multiplexer"
    },
    {
      "source": "/data-shippers/syslog-proxy",
      "destination": "/send-data/syslog-proxy"
    },
    {
      "source": "/data-shippers/kubernetes-filebeat",
      "destination": "/send-data/kubernetes"
    },
    {
      "source": "/data-shippers/axiom-honeycomb-proxy",
      "destination": "/send-data/axiom-honeycomb-proxy"
    },
    {
      "source": "/data-shippers/heroku-log-drains",
      "destination": "/send-data/heroku-log-drains"
    },
    {
      "source": "/install",
      "destination": "/install/introducing-axiom"
    },
    {
      "source": "/data-shippers/cloudfront",
      "destination": "/send-data/cloudfront"
    },
    {
      "source": "/data-shippers/cloudwatch",
      "destination": "/send-data/cloudwatch"
    },
    {
      "source": "/usage/field-restrictions",
      "destination": "/reference/field-restrictions"
    },
    {
      "source": "/usage/libraries",
      "destination": "/reference/libraries"
    },
    {
      "source": "/get-help/resources-and-tips",
      "destination": "/get-help/faq"
    },
    {
      "source": "/usage/getting-started",
      "destination": "/getting-started-guide/getting-started"
    },
    {
      "source": "/introducing-axiom",
      "destination": "/docs"
    },
    {
      "source": "/usage/ingest",
      "destination": "/send-data/ingest"
    },
    {
      "source": "/reference/visualizations",
      "destination": "/query-data/visualizations"
    },
    {
      "source": "/restapi/dashboard",
      "destination": "/restapi/introduction"
    },
    {
      "source": "/restapi/teams",
      "destination": "/restapi/introduction"
    },
    {
      "source": "/data-shippers/overview",
      "destination": "/integrations/introduction"
    },
    {
      "source": "/integrations/introduction",
      "destination": "/apps/introduction"
    },
    {
      "source": "/integrations/lambda",
      "destination": "/apps/lambda"
    },
    {
      "source": "/integrations/cloudflare-workers",
      "destination": "/apps/cloudflare-workers"
    },
    {
      "source": "/integrations/datadog-migration",
      "destination": "/apps/datadog-migration"
    },
    {
      "source": "/integrations/grafana",
      "destination": "/apps/grafana"
    },
    {
      "source": "/integrations/netlify",
      "destination": "/apps/netlify"
    },
    {
      "source": "/integrations/pagerduty",
      "destination": "/apps/pagerduty"
    },
    {
      "source": "/integrations/vercel",
      "destination": "/apps/vercel"
    },
    {
      "source": "/restapi/vfields",
      "destination": "/restapi/introduction"
    },
    {
      "source": "/restapi/starred",
      "destination": "/restapi/introduction"
    },
    {
      "source": "/restapi/monitors",
      "destination": "/restapi/introduction"
    },
    {
      "source": "/free-trial-guide",
      "destination": "/"
    },
    {
      "source": "/install/demo",
      "destination": "/install/cloud"
    },

    {
      "source": "/reference/api",
      "destination": "/restapi/introduction"
    },
    {
      "source": "/install/introducing-axiom",
      "destination": "/getting-started-guide/getting-started"
    },
    {
      "source": "/install/cloud",
      "destination": "/getting-started-guide/getting-started"
    },
    {
      "source": "/reference/virtual-fields",
      "destination": "/query-data/virtual-fields"
    },
    {
      "source": "/monitor-data/alerts",
      "destination": "/monitor-data/monitors"
    },
    {
      "source": "/send-data/kubernetes-filebeat",
      "destination": "/send-data/kubernetes"
    },
    {
      "source": "/restapi/token",
      "destination": "/reference/tokens"
    },
    {
      "source": "/reference/libraries",
      "destination": "/apps/introduction"
    },
    {
      "source": "/endpoints/introduction",
      "destination": "/send-data/ingest"
    },
    {
      "source": "/apps/pagerduty",
      "destination": "monitor-data/pagerduty"
    },
    {
      "source": "/query-data/dashboards",
      "destination": "dashboards/overview"
    },
    {
      "source": "/apl/guides/exploring-the-union-operator-in-apl",
      "destination": "/apl/tabular-operators/union-operator"
    },
    {
      "source": "/reference/eu-domain",
      "destination": "/reference/regions"
    }
  ]
}