๐ŸŽฏAPI Stability
Long-TermThis API is stable and will remain supported across versions with minimal breaking changes.

Summary

The scheduledReportResultSucceeded() mutation records a successful scheduled report generation in LogScale. Call this mutation after the external report generation process completes without error. Provide the generated file's filename as the result reference for the run. To record a failed run instead, use scheduledReportResultFailed().

Syntax

graphql
scheduledReportResultSucceeded(
      input: ScheduledReportResultSucceededInput!
   ): Boolean!

The input argument accepts a ScheduledReportResultSucceededInput! object. Provide the filename of the generated report file. The mutation returns Boolean!.

Input parameters

The ScheduledReportResultSucceededInput! object requires one field: filename. It identifies the report file produced by your generation process. LogScale stores this value as the result reference for the completed run.

Table: ScheduledReportResultSucceededInput Input Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
filenameStringyesย Long-Termย The filename of resulting report file.

Example

Raw
graphql
mutation {
  scheduledReportResultSucceeded( input:
    { filename: "report-file.txt" }
  )
}
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 {
  scheduledReportResultSucceeded( input:
    { filename: \"report-file.txt\" }
  )
}"
}
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 {
  scheduledReportResultSucceeded( input:
    { filename: \"report-file.txt\" }
  )
}"
}
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 { ^
  scheduledReportResultSucceeded( input: ^
    { filename: \"report-file.txt\" } ^
  ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  scheduledReportResultSucceeded( input:
    { filename: \"report-file.txt\" }
  )
}"
}'
    "$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 {
  scheduledReportResultSucceeded( input:
    { filename: \"report-file.txt\" }
  )
}";
$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 {
  scheduledReportResultSucceeded( input:
    { filename: \"report-file.txt\" }
  )
}"
}'''

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 {
  scheduledReportResultSucceeded( input:
    { filename: \"report-file.txt\" }
  )
}"
}
);


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

Returned values

The mutation returns Boolean!. A value of true indicates LogScale recorded the successful result.