๐ŸŽฏAPI Stability
PreviewThis API is under active development and may change significantly. Not recommended for production use.

Summary

The enablePersistedAggregation() mutation resumes a persisted aggregation that was previously disabled. The aggregation returns to active processing according to its configured schedule. The mutation returns the updated PersistedAggregation object. To pause a persisted aggregation without removing it, use disablePersistedAggregation().

Syntax

graphql
enablePersistedAggregation(
      input: EnablePersistedAggregationInput!
   ): PersistedAggregation!

The mutation accepts a single required argument, input, of type EnablePersistedAggregationInput!. Provide the id of the persisted aggregation to enable. The mutation returns a non-null PersistedAggregation object reflecting the updated state. See the Returned Values section for the fields available on that type.

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"
      }
    }
  }
}

Input Parameters

The EnablePersistedAggregationInput type requires one field: id, the unique identifier of the persisted aggregation to enable. The following table describes the available fields.

Returned Values

The mutation returns a non-null PersistedAggregation object reflecting the state of the aggregation after it is enabled. The returned fields include the aggregation's identity, current enabled state, and schedule configuration. Request the fields relevant to your use case.