← Tools Reference

Axiom

Axiom integration (Data, Developer Tools). Imported from open-connector.

API key5 toolshttps://api.axiom.co
GET
axiom_list_datasets
List Axiom datasets visible to the current token.

/v2/datasets

GET
axiom_get_dataset
Get an Axiom dataset by ID or unique name.

/v2/datasets/{dataset_id}

1 parameter
ParamTypeRequiredDescription
dataset_idstringrequiredThe Axiom dataset ID or unique dataset name.
POST
axiom_create_dataset
Create an Axiom dataset.

/v2/datasets

7 parameters
ParamTypeRequiredDescription
namestringrequiredThe unique Axiom dataset name.
descriptionstringoptionalThe dataset description.
edgeDeploymentstringoptionalThe edge deployment assigned to the dataset.
kindstringoptionalThe Axiom dataset kind.
retentionDaysintegeroptionalThe number of days Axiom should retain data in the dataset.
useRetentionPeriodbooleanoptionalWhether the dataset should use a retention period.
referrerstringoptionalOptional referrer slug sent as the create dataset query parameter.
DELETE
axiom_delete_dataset
Delete an Axiom dataset by ID or unique name.

/v2/datasets/{dataset_id}

1 parameter
ParamTypeRequiredDescription
dataset_idstringrequiredThe Axiom dataset ID or unique dataset name.
POST
axiom_run_apl_query
Run an Axiom Processing Language query through the global API endpoint.

/v1/datasets/_apl

11 parameters
ParamTypeRequiredDescription
aplstringrequiredThe APL query string to execute.
formatstringoptionalThe Axiom query result format.
nocachebooleanoptionalWhether Axiom should bypass cached query results.
saveAsKindstringoptionalThe saved query result kind.
dataset_namestringoptionalThe associated dataset name when saving query results.
cursorstringoptionalThe query cursor returned by a previous Axiom query.
endTimestringoptionalThe query end time as RFC3339 or a relative time expression.
includeCursorbooleanoptionalWhether the query response should include cursors.
queryOptionsobjectoptionalAxiom query options passed through to the APL API.
startTimestringoptionalThe query start time as RFC3339 or a relative time expression.
variablesobjectoptionalVariables inserted into the APL query.