Summary

The updatePersistedAggregation() GraphQL mutation is used to make changes to a persisted aggregation.

Stability Level Preview

Syntax

graphql
updatePersistedAggregation(
     input: UpdatePersistedAggregationInput!
   ): PersistedAggregation!

For the input, you'll have to provide the name of the persisted aggregation to update, then any parameters you want to change, such as the schedule. See the Input Parameters section for more on this.

You can request several return values, but since you're updating a persisted aggregation, you probably won't want much. See the Returned Values section farther down this page.

Example

Raw
graphql
mutation {
  updatePersistedAggregation(
    input: { currentName: "perag-1",
             schedule { "backfillAmount": "7",
                        "backfillUnit": "Days",
                        "interval": "Weekly",
                        "timestampType": "EventTime" } 
            }
  ) { name } 
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updatePersistedAggregation(
    input: { currentName: \"perag-1\",
             schedule { \"backfillAmount\": \"7\",
                        \"backfillUnit\": \"Days\",
                        \"interval\": \"Weekly\",
                        \"timestampType\": \"EventTime\" } 
            }
  ) { name } 
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  updatePersistedAggregation(
    input: { currentName: \"perag-1\",
             schedule { \"backfillAmount\": \"7\",
                        \"backfillUnit\": \"Days\",
                        \"interval\": \"Weekly\",
                        \"timestampType\": \"EventTime\" } 
            }
  ) { name } 
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  updatePersistedAggregation( ^
    input: { currentName: \"perag-1\", ^
             schedule { \"backfillAmount\": \"7\", ^
                        \"backfillUnit\": \"Days\", ^
                        \"interval\": \"Weekly\", ^
                        \"timestampType\": \"EventTime\" }  ^
            } ^
  ) { name }  ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  updatePersistedAggregation(
    input: { currentName: \"perag-1\",
             schedule { \"backfillAmount\": \"7\",
                        \"backfillUnit\": \"Days\",
                        \"interval\": \"Weekly\",
                        \"timestampType\": \"EventTime\" } 
            }
  ) { name } 
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  updatePersistedAggregation(
    input: { currentName: \"perag-1\",
             schedule { \"backfillAmount\": \"7\",
                        \"backfillUnit\": \"Days\",
                        \"interval\": \"Weekly\",
                        \"timestampType\": \"EventTime\" } 
            }
  ) { name } 
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  updatePersistedAggregation(
    input: { currentName: \"perag-1\",
             schedule { \"backfillAmount\": \"7\",
                        \"backfillUnit\": \"Days\",
                        \"interval\": \"Weekly\",
                        \"timestampType\": \"EventTime\" } 
            }
  ) { name } 
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  updatePersistedAggregation(
    input: { currentName: \"perag-1\",
             schedule { \"backfillAmount\": \"7\",
                        \"backfillUnit\": \"Days\",
                        \"interval\": \"Weekly\",
                        \"timestampType\": \"EventTime\" } 
            }
  ) { name } 
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "updatePersistedAggregation": {
      "name": "perag-1"
    }
  }
}

Input Parameters

For the input, you'll have to provide the name of the persisted aggregation to update, then any parameters you want to change, such as the schedule. The table below provides details on the parameters you can change, and a link to the scheduling sub-parameters:

Table: UpdatePersistedAggregationInput Input Datatype

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
currentNamestringyes PreviewThe unique name of the persisted aggregation to update.
descriptionstring  PreviewA description of what the persisted aggregation does.
enabledboolean  PreviewWhether the persisted aggregation should be enabled.
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.
newNamestring  PreviewThe new 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.
queryOwnershipTypeQueryOwnershipType  PreviewThe ownership type of the query. See QueryOwnershipType.
schedulePersistedAggregationScheduleInput  PreviewThe schedule configuration defining when and how often the aggregation runs. See PersistedAggregationScheduleInput.

Returned Values

For the results, since you'll provide the details of the persisted aggregation to be update, you probably won't want anything returned, other than confirmation. The table below lists your choices:

Table: PersistedAggregation Datatype

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.