The logAnalytics() GraphQL mutation is used to log actions in the LogScale user interface. To do this in batches, use the logAnalyticsBatch() mutation.

For information on auditing logs of user actions, see the Audit Logging documentation page.

API Stability Short-Term

Syntax

graphql
logAnalytics(
     input: AnalyticsLog!
   ): boolean

For the input, you'd provide information for logging actions (e.g., what kind of action). See the Given Datatype section.

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

Example

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

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 {
  logAnalytics ( input: 
    { category: \"something\",
      action: \"action-1\" }
  )
}"
}
);


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

Given Datatype

For this input datatype, you'll have to give information for logging actions (e.g., what kind of action). The table below provides more information on this:

Table: AnalyticsLog

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: Sep 17, 2024
actionstringyes Short-TermThe action to take related to the analytics log.
categorystringyes Short-TermThe category associated with the analytics log.
messagestring  Short-TermThe message related to the action.