Virtual Fields

Creating an Access Token

Access Tokens can be your API or Personal Tokens managed inside your account setings.

API Token

API Tokens allow access to datasets for either querying data, ingesting data, or both. In your settings menu click on API Tokens and create your API Token

API Token overview

Personal Token

Personal tokens allows you to access the Axiom API programmatically for custom integrations. In your settings menu, click on Profile and select Personal Token.

Personal Token overview

GET /vfields

GET /api/v1/vfields?dataset=string

Example Request

curl -X 'GET' \
'https://cloud.axiom.co/api/v1/vfields?dataset=<string>' \
-H 'Authorization: Bearer <$PERSONAL_TOKEN>' \
-H 'X-Axiom-Org-ID: <$ORG_ID>'

Example Response

Response sample code 200 and the body.

[
{
"dataset": "string",
"description": "string",
"expression": "string",
"id": "string",
"name": "string"
}
]

POST /vfields

POST /api/v1/vfields

Example Request

curl -X 'POST' \
'https://cloud.axiom.co/api/v1/vfields' \
-H 'Authorization: Bearer <$PERSONAL_TOKEN or $API_TOKEN>' \
-H 'X-Axiom-Org-ID: <$ORG_ID>' \
-H 'Content-Type: application/json' \
-d '{
"dataset": "string",
"description": "string",
"expression": "string",
"name": "string"
}'

Example Response

Response sample code 200 and the body.

{
"dataset": "string",
"description": "string",
"expression": "string",
"id": "string",
"name": "string"
}

DELETE /vfields/{id}

DELETE /api/v1/vfields/{id}

Example Request

curl -X 'DELETE' \
'https://cloud.axiom.co/api/v1/vfields/<STRING_ID>' \
-H 'Authorization: Bearer <$PERSONAL_TOKEN>' \
-H 'X-Axiom-Org-ID: <$ORG_ID>'

Example Response

A successful response will have status code 204 and an empty body.

GET /vfields/{id}

GET /api/v1/vfields/{id}

Example Request

curl -X 'GET' \
'https://cloud.axiom.co/api/v1/vfields/<STRING_ID>' \
-H 'Authorization: Bearer <$PERSONAL_TOKEN>' \
-H 'X-Axiom-Org-ID: <$ORG_ID>'

Example Response

Response sample code 200 and the body.

{
"dataset": "string",
"description": "string",
"expression": "string",
"id": "string",
"name": "string"
}

PUT /vfields/{id}

PUT /api/v1/vfields/{id}

Example Request

curl -X 'PUT' \
'https://cloud.axiom.co/api/v1/vfields/string' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <$PERSONAL_TOKEN>' \
-H 'X-Axiom-Org-ID: <$ORG_ID>' \
-d '{
"dataset": "string",
"description": "string",
"expression": "string",
"name": "string"
}'

Example Response

Response sample code 200 and the body.

{
"dataset": "string",
"description": "string",
"expression": "string",
"id": "string",
"name": "string"
}