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

Table: CreatePersistedAggregationInput

ParameterTypeRequiredDefaultStabilityDescription
Some input parameters may be required, as indicated in the Required column. For return values, this indicates that you are assured a value if the field is requested for the results.
Table last updated: Mar 30, 2026
descriptionstring  PreviewA description of what the persisted aggregation does.
destinationRepositoryIdstringyes PreviewThe destination repository's identifier where aggregation output data will be written. You must specify an existing, PersistedAggregation type of repository: it can't be changed afterwards.
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.
staticFields[StaticFieldInput]  PreviewThe static key-value fields to attach to each result event. No more than twenty, though. Field names must not start with @ or with #. See StaticFieldInput.
tagstringyes PreviewThe unique tag for the persisted aggregation. This must start with a letter, contain only alphanumeric characters, underscores, hyphens, and periods. Also, it cannot be more than 128 characters. The tag has to be unique within the organization. It can't be changed afterwards.
viewIdstringyes PreviewThe LogScale repository's identifier or saved search set by which to query. It must be non-empty and reference an existing repository to which the requester has access.