entitiesPage()

API Stability	`Preview`

The entitiesPage() GraphQL is used to get the next and previous page when querying assets across LogScale views and repositories. It requires the cursor from the entitiesSearch() or the entitiesPage() response, as well as the direction.

Syntax

Below is the syntax for entitiesPage():

graphql

entitiesPage(
     input: EntitiesPageInputType!
   ): SearchResult!

For the input, you'd enter input, followed by a colon and what you want to input between curly-brackets. The parameters for EntitiesPageInputType are limited to two: direction and cursor. The direction value is either Previous or Next. For the cursor, you'll have to get that value by first using entitiesSearch() .

Below is an example using this query field:

Show:

graphql

query {
  entitiesPage(
     input: {direction: Next,
     cursor: "eyJlbnRpdHlU..."
    }
  ) {totalResults, hasPreviousPage, hasNextPage}
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  entitiesPage(
     input: {direction: Next,
     cursor: \"eyJlbnRpdHlU...\"
    }
  ) {totalResults, hasPreviousPage, hasNextPage}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "query {
  entitiesPage(
     input: {direction: Next,
     cursor: \"eyJlbnRpdHlU...\"
    }
  ) {totalResults, hasPreviousPage, hasNextPage}
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "query { ^
  entitiesPage( ^
     input: {direction: Next, ^
     cursor: \"eyJlbnRpdHlU...\" ^
    } ^
  ) {totalResults, hasPreviousPage, hasNextPage} ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  entitiesPage(
     input: {direction: Next,
     cursor: \"eyJlbnRpdHlU...\"
    }
  ) {totalResults, hasPreviousPage, hasNextPage}
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
  entitiesPage(
     input: {direction: Next,
     cursor: \"eyJlbnRpdHlU...\"
    }
  ) {totalResults, hasPreviousPage, hasNextPage}
}"
}';
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

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "query {
  entitiesPage(
     input: {direction: Next,
     cursor: \"eyJlbnRpdHlU...\"
    }
  ) {totalResults, hasPreviousPage, hasNextPage}
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "query {
  entitiesPage(
     input: {direction: Next,
     cursor: \"eyJlbnRpdHlU...\"
    }
  ) {totalResults, hasPreviousPage, hasNextPage}
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  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

Show:

json

{
  "data": {
    "entitiesPage": {
      "totalResults": 15,
      "hasPreviousPage": true,
      "hasNextPage": true
    }
  },
  "extensions": {
    "preview": [
      {
        "name": "entitiesPage",
        "reason": "[PREVIEW: Under development]"
      }
    ]
  }
}

Given Datatypes

For EntitiesPageInputType, there are two parameters that may be given. They're listed below:

Table: EntitiesPageInputType

Parameter	Type	Required	Default	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 18, 2024
`cursor`	string	yes		`Preview`	The cursor to use for entities pages.
`direction`	`EntitiesPageDirection`	yes	100	`Preview`	The direction the cursor represents. See `EntitiesPageDirection`.

Returned Datatypes

The returned datatype SearchResult has a few parameters. Below is a list of them along with a description of each:

Table: SearchResult

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 3, 2024
`cursor`	string		`Preview`	The cursor useds for going to the next or previous page.
`data`	[`EntitySearchResultEntity`]	yes	`Preview`	The results of the search. See `ViewInteractionEntry`, `FileEntry`, and `DashboardEntry`.
`hasNextPage`	boolean	yes	`Preview`	Whether there is a next page. False indicates it's the last page.
`hasPreviousPage`	boolean	yes	`Preview`	Whether there is a previous page. False indicates it's the first page.
`totalResults`	integer	yes	`Preview`	The total number of results that matched the search query. Only pageSize elements will be returned.

GraphQL Queries

GraphQL API Stability

GraphQL Mutations

GraphQL Datatypes

entitiesPage()

Syntax

Given Datatypes

Returned Datatypes

Enter search term