The logAnalyticsBatch() GraphQL mutation is used to log actions in the LogScale user interface in batches.

For information on auditing logs of user actions, see the Audit Logging documentation page.

Syntax

Below is the syntax for the logAnalyticsBatch() mutation field:

graphql
logAnalyticsBatch(
     input: [AnalyticsLogWithTimestamp!]!
   ): boolean!

Given Datatypes

For the given datatype, AnalyticsLogWithTimestamp, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: AnalyticsLogWithTimestamp

ParameterTypeRequiredDefaultDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 17, 2024
actionstringyes The action to take related to the event.
arguments[string]yes Any arguments passed for the analytics.
contextstringyes The context of the analytics.
eventIdstringyes The unique identifier of the event.
featurestring  Our GraphQL pages are currently under development. This description will be added or changed soon.
features[AnalyticsFeature]yes Our GraphQL pages are currently under development. This description will be added or changed soon. See AnalyticsFeature.
metricsAnalyticsMetricsyes The frames per second to use for the analytics metrics. See AnalyticsMetrics.
routestringyes Our GraphQL pages are currently under development. This description will be added or changed soon.
systemstringyes Our GraphQL pages are currently under development. This description will be added or changed soon.
timestamplongyes The date and time stamp of the event.
userAgentAnalyticsUserAgentyes The browser, device type, and other information for the analytics. See AnalyticsUserAgent.