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.

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
    Scopesviews|create
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

aplQuerystring required

APL query that defines the view

datasetsstring[]

Datasets the view queries. Axiom derives this from aplQuery and ignores it in requests.

descriptionstring
edgeDeploymentstring

Region of the source datasets; ignored in requests

edgeDeploymentUrlstring

URL of the edge deployment; ignored in requests

namestring required

Name of the view. Use it as the view ID and to query the view like a dataset.

sharedByOrgstring

ID of the org that shared this resource, if it's shared

sharedByOrgNamestring

The name of the org that shared this resource, if it's shared

Response

Created view.

aplQuerystring required

APL query that defines the view

datasetsstring[]

Datasets the view queries. Axiom derives this from aplQuery and ignores it in requests.

descriptionstring
edgeDeploymentstring

Region of the source datasets; ignored in requests

edgeDeploymentUrlstring

URL of the edge deployment; ignored in requests

namestring required

Name of the view. Use it as the view ID and to query the view like a dataset.

sharedByOrgstring

ID of the org that shared this resource, if it's shared

sharedByOrgNamestring

The name of the org that shared this resource, if it's shared

Changes

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status