Skip to main content

Axiom

Observability and log analytics — query logs, traces, and metrics with APL, and manage datasets, monitors, notifiers, and annotations.

Categories: Developer Tools, Analytics

Set up​

Axiom connects with credentials from your Axiom account. Have these values ready:

  • Scoped API Token or Personal Access Token
  • Organization ID (optional for Scoped API Token)
  1. Go to Organization > Connectors and find Axiom.
  2. Click Enable and choose which tools to allow.
  3. Each member enters their own values the first time they use it.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

Tools​

Axiom offers 32 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (18)​

View and search information without changing it.

ToolWhat it does
get_annotationRetrieve a single annotation by ID.
get_current_userRetrieve the user that the current API token belongs to, including their role.
get_datasetRetrieve a single dataset by ID.
get_monitorRetrieve a single monitor by ID.
get_monitor_historyRetrieve a monitor's alert history (open/closed state changes) within a time range.
get_notifierRetrieve a single notifier by ID.
get_orgRetrieve a single organization by ID.
get_tokenRetrieve metadata for a single API token by ID.
get_userRetrieve a single user by ID.
list_annotationsList annotations, optionally filtered by dataset names and a time range (ISO 8601).
list_datasetsList all datasets in the organization.
list_monitorsList all monitors (alerting rules).
list_notifiersList all notifiers (alert delivery targets such as email, Slack, or webhook).
list_orgsList the organizations accessible to the current token, including plan information.
list_tokensList API tokens in the organization.
list_usersList all users in the organization, including their names, emails, and roles.
query_aplRun an APL (Axiom Processing Language) query across one or more datasets and return tabular results.
validate_credentialValidate the Axiom API token and organization ID with a lightweight datasets lookup.

Write (4)​

Create or send data.

ToolWhat it does
create_annotationCreate an annotation that appears on charts for the given datasets.
create_datasetCreate a new dataset.
create_monitorCreate a monitor.
create_notifierCreate a notifier.

Delete or overwrite (10)​

Remove or replace existing data.

ToolWhat it does
delete_annotationPermanently delete an annotation by ID.
delete_datasetPermanently delete a dataset and all its data.
delete_monitorPermanently delete a monitor by ID.
delete_notifierPermanently delete a notifier by ID.
trim_datasetQueue deletion of data older than maxDuration (e.g. '24h', '30d') in a dataset.
update_annotationUpdate an annotation's fields.
update_datasetUpdate a dataset's description or retention settings.
update_monitorUpdate a monitor.
update_notifierUpdate a notifier.
vacuum_datasetVacuum a dataset to prune fields that have not received data recently, reducing the field schema.
⌘J