Stability Level Preview

The enablePersistedAggregation() GraphQL mutation is used to enable a persisted aggregation. It will return if successful the updated persisted aggregation Otherwise, it will return FieldValidationException for validation errors.

To disable a persisted aggregation, use the disablePersistedAggregation() mutations. To create a persisted aggregation, use the createPersistedAggregation() mutation. To make changes to a persisted aggreation, use updatePersistedAggregation(). To delete one, use the deletePersistedAggregation() mutation. To get a list of all persisted aggregations accessible, use the persistedAggregations() query.

Syntax

graphql
enablePersistedAggregation(
     input: EnablePersistedAggregationInput!
   ): PersistedAggregation!

For the input, you would only give the unique identifier of the persisted aggregation to enable. For the results, there are several parameters you can request. See the Returned Datatype section farther down this page.

Example

Raw
graphql
mutation {
  enablePersistedAggregation(
    input: { id: "abc123" }
  ) {  name,
       schedule { backfillAmount, backfillUnit, 
                  interval, timestampType }
       }
}
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 {
  enablePersistedAggregation(
    input: { id: \"abc123\" }
  ) {  name,
       schedule { backfillAmount, backfillUnit, 
                  interval, timestampType }
       }
}"
}
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 {
  enablePersistedAggregation(
    input: { id: \"abc123\" }
  ) {  name,
       schedule { backfillAmount, backfillUnit, 
                  interval, timestampType }
       }
}"
}
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 { ^
  enablePersistedAggregation( ^
    input: { id: \"abc123\" } ^
  ) {  name, ^
       schedule { backfillAmount, backfillUnit,  ^
                  interval, timestampType } ^
       } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  enablePersistedAggregation(
    input: { id: \"abc123\" }
  ) {  name,
       schedule { backfillAmount, backfillUnit, 
                  interval, timestampType }
       }
}"
}'
    "$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 {
  enablePersistedAggregation(
    input: { id: \"abc123\" }
  ) {  name,
       schedule { backfillAmount, backfillUnit, 
                  interval, timestampType }
       }
}";
$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 {
  enablePersistedAggregation(
    input: { id: \"abc123\" }
  ) {  name,
       schedule { backfillAmount, backfillUnit, 
                  interval, timestampType }
       }
}"
}'''

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 {
  enablePersistedAggregation(
    input: { id: \"abc123\" }
  ) {  name,
       schedule { backfillAmount, backfillUnit, 
                  interval, timestampType }
       }
}"
}
);


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": {
    "enablePersistedAggregation": {
      "name": "perag-1",
      "schedule": {
         "backfillAmount": "7",
         "backfillUnit": "Days",
         "interval": "Weekly",
         "timestampType": "EventTime"
      }
    }
  }
}

Given Datatype

For the input datatype, there is only one parameter, the id. This is described in the table here:

Table: EnablePersistedAggregationInput

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
idstringyes PreviewThe unique identifier of the persisted aggregation to enable.

Returned Datatype

For the returned datatype, there are a few parameters. They consist primarily of the name of the persisted aggregation, and details on the schedule. These parameters and a link to sub-parameters are listed here:

Table: PersistedAggregation

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  PreviewThe description of the persisted aggregation.
enabledbooleanyes PreviewWhether the persisted aggregation is enabled.
idstringyes PreviewThe unique identifier of the persisted aggregation.
labels[string]yes PreviewThe labels associated with the aggregation.
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.
viewNamestringyes PreviewThe name of the view to which the persisted aggregation belongs.