vfields

GET /vfields/{id}

Changed on Oct 16, 2026

Retrieves a virtual field by its ID.

Request

Base URL
https://api.axiom.co/v2
Auth
OAuth 2
Authorization codehttps://accounts.google.com/o/oauth2/v2/auth
Token URLhttps://www.googleapis.com/oauth2/v4/token
ScopesvirtualFields|read
TypeScript
https://skmtc.dev/axiom/apis/axiom-public-api/docs/vfields/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

ID of the virtual field in the form <dataset>.<name>

Response

Virtual field.

datasetstring required

descriptionstring

expressionstring required

namestring required

Name of the virtual field. Use letters, digits, underscores, and hyphens, starting and ending with a letter or digit.

typestring

unitstring

idstring required

Changes

Oct 16, 2026v2fbc1b8430feb Revision changes
- info
  added the non-success response with the status

Operation history