CreatePersistedAggregationInput is an input for creating a persisted aggregation. This datatype is used by the createPersistedAggregation() mutation.

Table: CreatePersistedAggregationInput

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Mar 30, 2026
descriptionstring  PreviewA description of what the persisted aggregation does.
enabledbooleanyes PreviewWhether the persisted aggregation should be enabled when created.
labels[string]  PreviewA list of labels to tag the persisted aggregation for organizing and filtering. Each label can be up to sixty-four characters long and may contain only alphanumeric characters, spaces, hyphens, and underscores.
namestringyes PreviewThe unique name for the persisted aggregation. It can be up to one-hundred twenty-eight characters long, must start with an alphanumeric character, and may contain only alphanumeric characters, spaces, hyphens, and underscores. The name must be unique within the organization.
queryOwnershipTypeQueryOwnershipTypeyes PreviewThe ownership type of the query (e.g., User or Organization). See QueryOwnershipType.
queryStringstringyes PreviewThe LogScale query string that defines the aggregation logic. This must be a valid query.
schedulePersistedAggregationScheduleInputyes PreviewThe schedule configuration defining when and how often the aggregation runs. See PersistedAggregationScheduleInput.
viewNamestringyes PreviewThe LogScale repository or saved search set to query against. This must be non-empty, and reference an existing repository to which the requester has access.