Summary

The enableScheduledReport() GraphQL mutation may be used to enable a scheduled report.

API Stability Long-Term

Syntax

graphql
enableScheduledReport(
      input: EnableScheduledReportInput!
   ): boolean

For the input, you have to give the unique identifier of the scheduled report to enable, and the name of the view or repository. To see how to get the identifier, click on the Show Query link above. See the Input Parameters section for details.

For the results, you'll receive confirmation if successful.

Example

Raw
graphql
mutation {
  enableScheduledReport (input:
    { viewName: "humio",
      id: "uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn"
    } )
}
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 {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}"
}
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 {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}"
}
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 { ^
  enableScheduledReport (input: ^
    { viewName: \"humio\", ^
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\" ^
    } ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}"
}'
    "$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 {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}";
$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 {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}"
}'''

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 {
  enableScheduledReport (input:
    { viewName: \"humio\",
      id: \"uwsVwYlFWGqzD9bIgKeciwmiS1hCVMyn\"
    } )
}"
}
);


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": {
    "enableScheduledReport": true
  }
}

Input Parameters

For the input, you would give the unique identifier of the scheduled report to enable. To see how to get that, click on the Show Query link above the Syntax section. You'll need to give the name of the associated view or repository. This is described in the table here:

Table: EnableScheduledReportInput 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: Sep 18, 2024
idstringyes Long-TermThe unique identifier of the scheduled report.
viewNamestringyes Long-TermThe name of the view of the scheduled report.