Package Exports

@axiomhq/axiom-node

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@axiomhq/axiom-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Axiom Node

Axiom Node

Introduction

Axiom Node is a NodeJS package for accessing the Axiom API.

Installation

 git clone https://github.com/axiomhq/axiom-node
 cd axiom-node

Authentication

The Client is initialized with the url of the deployment and an access token. The access token can be a personal token retrieved from the users profile page or an ingest token retrieved from the settings of the Axiom deployment.

The personal access token grants access to all resources available to the user on his behalf.

The ingest token just allows ingestion into the datasets the token is configured for.

Usage

You need to at least provide the URL of your deployment and a valid personal access or ingest token.

import Client from '../lib/client';

const depylomentURL = process.env.AXIOM_URL || '';
const accessToken = process.env.AXIOM_TOKEN || '';

const client = new Client(depylomentURL, accessToken);

// ...

For more sample code snippets, head over to the examples directory.

Documentation

You can find the Axiom and Axiom node documentation on the docs website.

The documentation is divided into several sections:

Contributing

The main aim of this repository is to continue developing and advancing Axiom Node, making it faster and more simplified to use. Kindly check our contributing guide on how to propose bugfixes and improvements, and submitting pull requests to the project

License

Distributed under MIT License (The MIT License).

See LICENSE for more information.

@axiomhq/axiom-node