PersistedAggregation is a datatype for a persisted aggregation configuration.

This datatype is used by the createPersistedAggregation(), enablePersistedAggregation(), disablePersistedAggregation(), updatePersistedAggregation(), and deletePersistedAggregation() mutations. It's also used by the persistedAggregations() query.

Table: PersistedAggregation

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: May 12, 2026
createdInfoPersistedAggregationCommitMetadatayes PreviewMetadata related to the creation of the persisted aggregation. See PersistedAggregationCommitMetadata.
descriptionstring  PreviewThe description of the persisted aggregation.
enabledbooleanyes PreviewWhether the persisted aggregation is enabled.
destinationRepository  PreviewThe destination repository where aggregation output data is written. This is immutable after creation. See Repository.
healthInfoPersistedAggregationHealthInfo  PreviewDerived health status information for the persisted aggregation. See PersistedAggregationHealthInfo.
idstringyes PreviewThe unique identifier of the persisted aggregation.
labels[string]yes PreviewThe labels associated with the aggregation.
modifiedInfoPersistedAggregationCommitMetadata  PreviewMetadata related to the last modification of the persisted. See PersistedAggregationCommitMetadata.
namestringyes PreviewThe name of the persisted aggregation.
queryOwnershipTypestringyes PreviewThe ownership type of the query.
queryStringstringyes PreviewThe query string for the aggregation.
schedulePersistedAggregationScheduleyes PreviewThe schedule configuration for the aggregation. See PersistedAggregationSchedule.
searchDomainSearchDomain  PreviewThe view or repository to which this persisted aggregation belongs. See SearchDomain.
staticFields[PersistedAggregationStaticField]yes PreviewStatic key-value fields attached to each result event. See PersistedAggregationStaticField.
tagstringyes PreviewThe unique tag identifier for the persisted aggregation. Immutable after creation.