Create view

POST/v2/views

Creates a view, a named APL query that you can query like a dataset. Axiom derives datasets from aplQuery. The name can't match an existing dataset or view, and the query can't reference views or use wildcards.

Body

application/json

Property	Type	Description
`aplQuery`	`string`Required	APL query that defines the view
`datasets`	`string[]`	Datasets the view queries. Axiom derives this from `aplQuery` and ignores it in requests.
`description`	`string`
`name`	`string`Required	Name of the view. Use it as the view ID and to query the view like a dataset.
`sharedByOrg`	`string`	ID of the org that shared this resource, if it's shared
`sharedByOrgName`	`string`	The name of the org that shared this resource, if it's shared

Request

curl -X POST 'https://api.axiom.co/v2/views' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"aplQuery":"string","datasets":["string"],"description":"string","name":"string","sharedByOrg":"string","sharedByOrgName":"string"}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token RequiredRequest body application/json

Response

200Created view.

application/json

400Invalid view, for example an APL parse error, a name that's already in use, or a query that references a view or datasets in different regions.

403You don't have query access to a dataset that `aplQuery` references.

Property	Type	Description
`aplQuery`	`string`Required	APL query that defines the view
`datasets`	`string[]`	Datasets the view queries. Axiom derives this from `aplQuery` and ignores it in requests.
`description`	`string`
`name`	`string`Required	Name of the view. Use it as the view ID and to query the view like a dataset.
`sharedByOrg`	`string`	ID of the org that shared this resource, if it's shared
`sharedByOrgName`	`string`	The name of the org that shared this resource, if it's shared