.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("#sidebar a")) {
    const logoLink = document.querySelector("#sidebar a");

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

Retrieve field in dataset

Auth

Axiom’s official documentation site. Learn everything about how to use Axiom.

Axiom Docs

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

Interactive demonstration of Axiom and its features

Axiom tour

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 article summarizes what Axiom does to ensure the highest standards of information security and data protection.

Data security

This page explains how to interpret Axiom docs with LLMs.

Interpret Axiom docs with LLMs

List of docs pages

Full docs

Enrich your Axiom organization with dedicated apps.

Apps

This page explains how to enrich your Axiom experience with AWS Lambda.

AWS Lambda

Enrich Axiom experience with AWS Lambda

This page explains how to enrich your Axiom experience with AWS PrivateLink.

AWS PrivateLink

Enrich Axiom experience with AWS PrivateLink

This page explains how to enrich your Axiom experience with Cloudflare Workers.

Cloudflare Workers

Connect Axiom with Cloudflare Workers

Axiom gives you an all-at-once view of key Cloudflare Logpush metrics and logs, out of the box, with our dynamic Cloudflare Logpush dashboard.

Cloudflare Logpush

Connect Axiom with Cloudflare Logpush

Learn how to extend the functionality of Grafana by installing the Axiom data source plugin.

Grafana

Connect Axiom with Grafana

This page exlains how to visualize geospatial log data from Axiom using Hex interactive maps.

Map location data with Axiom and Hex

Integrating Axiom with Netlify to get a comprehensive observability experience for your Netlify projects. This app will give you a better understanding of how your Jamstack apps are performing.

Netlify

Connect Axiom with Netlify

This page explains how to integrate Axiom with Tailscale.

Tailscale

Connect Axiom with Tailscale

Provision and manage Axiom resources such as datasets and monitors with Terraform.

Terraform

Connect Axiom with Terraform

Easily monitor data from requests, functions, and web vitals in one place to get the deepest observability experience for your Vercel projects.

Vercel

Connect Axiom with Vercel

This section explains how to use the Axiom Processing Language to get deeper insights from your data.

Axiom Processing Language (APL)

Explore how to use APL in Axiom’s Query tab to run queries using Tabular Operators, Scalar Functions, and Aggregation Functions.

Sample queries

This section explains how to send data to Axiom, query data, and manage resources using the Axiom API.

Get started with Axiom API

This page explains how to send to Axiom using the API.

Send data to Axiom via API

Learn how to use the Axiom API to query data.

Query data

Query data via Axiom API

Learn how to use pagination with the Axiom API.

Pagination

Pagination in Axiom API

Learn how to limit the number of calls a user can make over a certain period of time.

API limits

List all annotations

Retrieve annotation

Create annotation

Update annotation

Delete annotation

List all API tokens

Retrieve API token

Create API token

Regenerate API token

Delete API token

List all datasets

Retrieve dataset

List all fields in dataset

Create dataset

Ingest data

Run query

Run query (legacy)

Trim dataset

Update dataset

Update field

Vacuum dataset

Delete dataset

List all map fields

Create map field

Update list of map fields

Delete map fields

Lists all configured monitors. Returns an array of monitor configurations including their IDs and current status.

List all monitors

Retrieves detailed configuration for a specific monitor by its unique identifier

Retrieve monitor

Retrieve monitor history

Create monitor

Update monitor

Delete monitor

Lists all configured notifiers. Returns an array of notification configurations including their IDs and current status.

List all notifiers

Retrieves detailed configuration for a specific notifier by its unique identifier

Retrieve notifier

Creates a new notifier configuration for sending alerts through various channels (Slack, Email, etc)

Create notifier

Update notifier

Delete notifier

List all orgs

Retrieve org

Create org

Update org

Retrieves all roles in the organization with their associated permissions and members.

List all roles

Retrieves detailed information about a specific role by its unique identifier.

Retrieve role

Retrieves all groups in the organization.

List all groups

Retrieves detailed information about a specific group by its unique identifier.

Retrieve group

Creates a new role in the organization with the specified permissions and member assignments.

Create role

Create group

Updates an existing role's configuration including its permissions and member assignments.

Update role

Updates an existing group's configuration.

Update group

Permanently removes a role from the organization.

Delete role

Permanently removes a group from the organization.

Delete group

List all starred queries

Retrieve starred query

Create starred query

Update starred query

Delete starred query

Retrieve current user

List all users

Retrieve user

Create user

Update current user

Update user role

Delete user from org

List all virtual fields

Retrieve virtual field

Create virtual field

Update virtual field

Delete virtual field

This page explains the fundamentals of timestamped event data in Axiom.

Event data

This page explains how Axiom helps you leverage timestamped event data for observability purposes.

Observability

Axiom for observability

This section explains the feature states in Axiom.

Feature states

Feature states in Axiom

The glossary explains the key concepts in Axiom.

Glossary

Glossary of key Axiom terms

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 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

Datadog

Send data from Datadog 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.

Get started

Annotation endpoints

API token endpoints

Dataset endpoints

Map field endpoints

Monitor endpoints

Notifier endpoints

Organization endpoints

Role-based access control endpoints

Saved queries endpoints

User endpoints

Virtual fields endpoints

Retrieve field in dataset

Authorizations

Path Parameters

Response