Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryBatch

Package version

The Analytics query. Learn more about the Analytics query syntax

Hierarchy

  • QueryBatch

Index

Properties

Optional additionalWorkspaces

additionalWorkspaces: string[]

A list of workspaces that are included in the query, except for the one set as the workspaceId parameter These may consist of the following identifier formats:

  • Qualified workspace names
  • Workspace IDs
  • Azure resource IDs

Optional includeQueryStatistics

includeQueryStatistics: undefined | false | true

Results will also include statistics about the query.

Optional includeVisualization

includeVisualization: undefined | false | true

Results will also include visualization information, in JSON format.

query

query: string

The query to execute.

Optional serverTimeoutInSeconds

serverTimeoutInSeconds: undefined | number

The maximum amount of time the server will spend processing the query. Default: 180 seconds (3 minutes), maximum allowed is 600 seconds (10 minutes)

timespan

timespan: TimeInterval

The timespan over which to query data. This timespan is applied in addition to any that are specified in the query expression.

workspaceId

workspaceId: string

The workspace for this query.

Generated using TypeDoc