.inline-icon {
    display: inline;
    max-height: 1.3em;
    margin: 0 0.2em;
    background-color: #FCFCFC;
    padding: 0.1em;
    border-radius: 0.2em
}

/* If two ul elements follow each other, remove margin between them. */
.prose :where(ul+ul):not(:where([class~=not-prose] *)) {
    margin-top: 0;
}

.prose ul:has(+ ul):not(:where([class~=not-prose] *)) {
    margin-bottom: 0;
}

// Make all links on the page to the marketing site open in the same tab.
if (document.querySelectorAll("a")) {
    const links = document.querySelectorAll("a");

    for (i = 0; i < links.length; i++){
        const link = links[i];
        let linkHref = link.getAttribute("href");
        
        if (linkHref.match("axiom.co")) {
            link.removeAttribute("target");
        }
    }
}

// Make top-left logo link to marketing site. The event listener is necessary to replace Mintlify's default event listener.
if (document.querySelector("#navbar a")) {
    const logoLink = document.querySelector("#navbar a");

    if (logoLink.getAttribute("href") == "/" || logoLink.getAttribute("href") == "/docs") {
        logoLink.addEventListener("click", function(){document.location.href = "https://axiom.co/";});
    }
}

Axiom Playground

Changelog

Book a Demo

Axiom Docs

Documentation

Apps and Integrations

Query Reference

API Reference

Launch Axiom

Blog

Support

Run Query

AggInfo captures information about an aggregation

Args specifies any non-field arguments for the aggregation. Fx. [10] for topk(players, 10).

Fields specifies the names of the fields this aggregation is computed on.
Fx ["players"] for topk(players, 10)

Name is the system name of the aggregation, which is the string form of aggregation.Type.
If the aggregation is aliased, the alias is stored in the parent FieldInfo

The standard mode of operation for Kirby is to create buckets on the _time column,

Field specifies the field used to create buckets on. Normally this would be _time.

An integer or float representing the fixed bucket size.
When the bucket field is _time this value is in nanoseconds.

BucketInfo captures information about how a grouped query is sorted into buckets.

FieldInfo captures information about a field used in the tabular result format. See Table.

Supported for these filters: starts-with, not-starts-with, ends-with, not-ends-with, contains, not-contains, eq, ne.

Supported for these filters: and, or, not.

We also support '==', but we’re not exporting that to swagger, because it can’t deal with it add >, >=, <, <= to that list, it breaks codegen.

GroupInfo captures information about a grouping clause in the tabular result format. See Table.

FieldsMeta contains the unit information (if we have it) for each field

The time resolution of the query’s graph, in seconds. Valid values are
the query’s time range /100 at maximum and /1000 at minimum or "auto".

start and end time for the query, these must be specified as RFC3339 strings
or using relative time expressions (e.g. now-1h, now-1d, now-1w, etc)

End is the ending time the query is limited by.
Queries are restricted to the interval [start,end).

Field specifies the field name on which the query range was restricted. Normally _time

Start is the starting time the query is limited by.
Queries are restricted to the interval [start,end).

RangeInfo specifies the window a query was restricted to.

Result sources will typically be the names of a datasets that were searched,
but may be expanded to other things in the future.

SourceInfo specifies the provenance of a results Table.

Row id of the newest row, as seen server side.
May be higher than what the results include if the server scanned more data than included in the results.
Can be used to efficiently resume time-sorted non-aggregating queries (ie filtering only).

Row id of the oldest row, as seen server side.
May be lower than what the results include if the server scanned more data than included in the results.
Can be used to efficiently resume time-sorted non-aggregating queries (ie filtering only).

The tabular result format can be enabled via APLQueryParams.ResultFormat or QueryParams.ResultFormat.

Columns contain a series of arrays with the raw result data.
The columns here line up with the fields in the Fields array.

Fields contain information about the fields included in these results.
The order of the fields match up with the order of the data in Columns.

Groups specifies which grouping operations has been performed on the results.

Name is the name assigned to this table. Defaults to "0". The name "_totals" is reserved for system use.

Order echoes the ordering clauses that was used to sort the results.

Sources contain the names of the datasets that contributed data to these results.

Table defines the schema for query results in the "tabular" result format.

Auth

In this documentation, you will be able to gain a deeper understanding of what Axiom is, how to get it installed, and how best to use it for your organization’s use case.

Introduction

This guide introduces you to the concepts behind working with Axiom and give a short introduction to each of the high-level features.

Get Started

Get started

FAQs

Frequently Asked Questions

Use Axiom’s API to ingest, transport, and retrieve data from different sources such as relational databases, web logs, app logs, and kubernetes.

Overview

Send data

This guide explains how to send data from Convex to Axiom.

Convex

Send data from Convex to Axiom

Learn how to configure Cribl LogStream to forward logs to Axiom using both HTTP and Syslog destinations.

Cribl

Send data from Cribl to Axiom

Collect metrics and logs from elastic beats, and monitor them with Axiom.

Elastic Beats

Send data from Elastic Beats to Axiom

This step-by-step guide will help you get started with migrating from Elasticsearch to Axiom using the Elastic Bulk API

Elastic Bulk API

Send data from Elastic Bulk API to Axiom

This step-by-step guide will help you collect any data like metrics and logs from different sources, enrich them with filters, and send them to Axiom.

Fluent Bit

Send data from Fluent Bit to Axiom

This step-by-step guide will help you collect, aggregate, analyze, and route log files from multiple Fluentd sources into Axiom

Fluentd

Send data from Fluentd to Axiom

This step-by-step guide helps you collect, and parse logs from your logstash processing pipeline into Axiom

Logstash

Send data from Logstash to Axiom

This step-by-step guide provides a gateway for you to connect a direct link interface to Axiom via Loki endpoint.

Loki Multiplexer

Send data from Loki Multiplexer to Axiom

Learn how to monitor syslog events on your devices and send them directly into Axiom

Syslog

Send data from Syslog to Axiom

This step-by-step guide will help you configure Vector to read and collect metrics from your sources using the Axiom sink.

Vector

Send data from Vector to Axiom

This step-by-step guide will help you configure Tremor connectors and events components to interact with your databases, APIs, and ingest data from these sources into Axiom.

Tremor

Send data from Tremor to Axiom

Send data from CloudFront to Axiom using AWS S3 bucket and Lambda to monitor your static and dynamic content.

AWS CloudFront

Send data from CloudFront to Axiom

Axiom provides a unique way of ingesting CloudWatch logs into Axiom. The Axiom CloudWatch integration is subscribed to one or more of your CloudWatch Log Groups and runs as a Lambda function.

AWS CloudWatch

Send data from CloudWatch to Axiom

Leverage AWS FireLens to forward logs from Amazon ECS tasks to Axiom for efficient, real-time analysis and insights.

AWS FireLens

Send data from AWS FireLens to Axiom

This page explains how to route device log data from AWS IoT Core to Axiom using AWS IoT and Lambda functions

AWS IoT

Send data from AWS IoT to Axiom

Efficiently send log data from AWS S3 to Axiom via Lambda function

AWS S3

Send data from AWS S3 to Axiom

This step-by-step guide will help you forward logs from your apps, and deployments to Axiom by sending them via HTTPS.

Heroku

Send data from Heroku Log Drains to Axiom

Integrate Axiom in your existing Honeycomb stack with minimal effort and without breaking any of your existing Honeycomb workflows.

Honeycomb

Send data from Honeycomb to Axiom

This step-by-step guide helps you ingest logs from your Kubernetes cluster into Axiom using the DaemonSet configuration.

Kubernetes

Send data from Kubernetes Cluster to Axiom

Integrate Axiom in your existing Loki stack with minimal effort and without breaking any of your existing Loki workflows.

Loki

Send data from Loki to Axiom

Learn how OpenTelemetry-compatible events flow into Axiom and explore Axiom comprehensive observability through browsing, querying, dashboards, and alerting of OpenTelemetry data.

OpenTelemetry

Send OpenTelemetry data to Axiom

Learn how to monitor the behavior of your websites and apps, and capture data about the status and performance of your websites and apps.

Render

Send Render logs to Axiom

Integrate Axiom in your existing Splunk app with minimal effort and without breaking any of your existing Splunk stack.

Splunk

Send data from Splunk to Axiom

This guide explains how to set up and configure logging in a .NET application, and how to send logs to Axiom.

.NET

Send logs from a .NET app

This guide explains how to configure a .NET app using the .NET OpenTelemetry SDK to send telemetry data to Axiom.

.NET Using OTel

OpenTelemetry using .NET

This guide explains how to configure a Cloudflare Workers app to send telemetry data to Axiom.

Cloudflare Workers

OpenTelemetry using Cloudflare Workers

This guide explains how to send OpenTelemetry data from a Django app to Axiom using the Python OpenTelemetry SDK.

Django Using OTel

Send OpenTelemetry data from a Django app to Axiom

This guide explains how to configure a Go app using the Go OpenTelemetry SDK to send telemetry data to Axiom.

Golang Using OTel

OpenTelemetry using Golang

This guide demonstrates how to configure logging in a Laravel app to send logs to Axiom

Laravel

Send logs from Laravel to Axiom

This page explains how to send data from your Next.js app to Axiom using the next-axiom library.

Next.js

Send data from Next.js app to Axiom

This guide demonstrates how to configure OpenTelemetry in a Next.js app to send telemetry data to Axiom.

Next.js Using OTel

OpenTelemetry using Next.js

This guide demonstrates how to configure OpenTelemetry in a Node.js app to send telemetry data to Axiom.

Node.js Using OTel

OpenTelemetry using Node.js

This guide explains how to send OpenTelemetry data from a Python app to Axiom using the Python OpenTelemetry SDK.

Python Using OTel

Send OpenTelemetry data from a Python app to Axiom

This guide provides step-by-step instructions on how to send logs from a Ruby on Rails application to Axiom using the Faraday library.

Ruby on Rails

Send logs from a Ruby on Rails application using Faraday

This guide explains how to send OpenTelemetry data from a Ruby on Rails App to Axiom using the Ruby OpenTelemetry SDK.

Ruby on Rails Using OTel

Send OpenTelemetry data from a Ruby on Rails app to Axiom

Gain insights from your data visually, and run aggregations across all or a subset of events in a dataset.

Analyze Data

Analyze data

Learn how to filter, manipulate, extend, and summarize your data without having to worry about query speed or indexes.

Explore Data

Explore data with Axiom

The Stream tab enables you to process and analyze high volumes of high-velocity data from a variety of sources in real time.

Stream Data

Stream data

Learn how to run powerful aggregations across your data to produce insights that are easy to understand and monitor.

Visualize Data

Visualize data

Virtual fields allow you to derive new values from your data in real time, eliminating the need for up-front data structuring, enhancing flexibility and efficiency.

Virtual Fields

Virtual fields

Learn how to observe how requests propagate through your distributed systems, understand the interactions between microservices, and trace the life of the request through your app’s architecture.

Explore Traces

Explore traces

Axiom provides a mature dashboard experience that allows collections of queries across multiple datasets to be visualized in one place.

Dashboards

This page explains how to create dashboards with filters that let you choose the data you want to display.

Dashboard Filters

Create dashboards with filters

This guide explains how to use annotations to add context to your charts.

Annotate Charts

Annotate charts

Learn how to setup monitors and notifiers to get alerts when queries match certain conditions.

Monitors and Notifiers

Monitors and notifiers

This section explains how to organize your Axiom instance.

Organize your Axiom instance

Learn how to use the Axiom CLI to ingest data, manage authentication state, and configure multiple deployments.

Axiom CLI

Learn how to calculate and manage query compute resources in GB-hours to optimize usage within Axiom.

Get Started

User Endpoints

Dataset Endpoints

Annotation Endpoints

API Token Endpoints

Run Query

Authorizations

Query Parameters

Body

Response