Summary

The dashboardsPage() GraphQL query is used to retrieve information on dashboards. You would specify which parameters you want and how many records you want returned in a batch, per page — and then which page you want returned.

API Stability Long-Term

Syntax

graphql
dashboardsPage(
     search: string,
     pageSize: integer!,
     pageNumber: integer!
   ): DashboardPage!

You may give text on which to search dashboard names. You'll have to also give the number of results per page, and which page to return.

For the results, you can get details on the dashboards, and tallies on the results. See the Returned Values section for details.

Example

Raw
graphql
query{
  dashboardsPage(
    search: "hosts"
    pageSize: 10
    pageNumber: 1
  ) {
    page {
      id, name, 
      displayName, searchDomain {
        id, name
      }
    }
    pageInfo {
      number
      totalNumberOfRows
      total
    }
  }
}
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" : "query{
  dashboardsPage(
    search: \"hosts\"
    pageSize: 10
    pageNumber: 1
  ) {
    page {
      id, name, 
      displayName, searchDomain {
        id, name
      }
    }
    pageInfo {
      number
      totalNumberOfRows
      total
    }
  }
}"
}
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" : "query{
  dashboardsPage(
    search: \"hosts\"
    pageSize: 10
    pageNumber: 1
  ) {
    page {
      id, name, 
      displayName, searchDomain {
        id, name
      }
    }
    pageInfo {
      number
      totalNumberOfRows
      total
    }
  }
}"
}
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" : "query{ ^
  dashboardsPage( ^
    search: \"hosts\" ^
    pageSize: 10 ^
    pageNumber: 1 ^
  ) { ^
    page { ^
      id, name,  ^
      displayName, searchDomain { ^
        id, name ^
      } ^
    } ^
    pageInfo { ^
      number ^
      totalNumberOfRows ^
      total ^
    } ^
  } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query{
  dashboardsPage(
    search: \"hosts\"
    pageSize: 10
    pageNumber: 1
  ) {
    page {
      id, name, 
      displayName, searchDomain {
        id, name
      }
    }
    pageInfo {
      number
      totalNumberOfRows
      total
    }
  }
}"
}'
    "$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 = "query{
  dashboardsPage(
    search: \"hosts\"
    pageSize: 10
    pageNumber: 1
  ) {
    page {
      id, name, 
      displayName, searchDomain {
        id, name
      }
    }
    pageInfo {
      number
      totalNumberOfRows
      total
    }
  }
}";
$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" : "query{
  dashboardsPage(
    search: \"hosts\"
    pageSize: 10
    pageNumber: 1
  ) {
    page {
      id, name, 
      displayName, searchDomain {
        id, name
      }
    }
    pageInfo {
      number
      totalNumberOfRows
      total
    }
  }
}"
}'''

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" : "query{
  dashboardsPage(
    search: \"hosts\"
    pageSize: 10
    pageNumber: 1
  ) {
    page {
      id, name, 
      displayName, searchDomain {
        id, name
      }
    }
    pageInfo {
      number
      totalNumberOfRows
      total
    }
  }
}"
}
);


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": {
    "dashboardsPage": {
      "page": [
        {
          "id": "abc123",
          "name": "Hosts",
          "displayName": "Hosts",
          "searchDomain": {
            "id": "def456",
            "name": "humio"
          }
        }
      ],
      "pageInfo": {
        "number": 1,
        "totalNumberOfRows": 1,
        "total": 1
      }
    }
  }
}

Notice that the example above requests information on dashboards with the name hosts. That resulted in one dashboard with that text in the name. The results show the unique identifiers, the name of the dashboard, and the repository, as requested. Click on Dashboard datatype in the table below for more parameters.

Input Parameters

For the input, you may provide a search for dashboard names on which to filter dashboards, as well as the number of results per page, and, based on that, which page to return.

Table: Input Parameters & Datatypes

Parameter Type Required Default Description
This table contains all input parameters for this query.
pageNumber integer yes   Which page to return.
pageSize integer yes   The number of results returned per page.
search string     Any text on which to search dashboard names.

Returned Values

For the results, you can get plenty about each dashboard. Below is a list of choices, with links to the sub-choices (see second table):

Table: DashboardPage 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: Jan 22, 2026
page[Dashboard]yes Long-TermSpecific information on each dashboard to be returned for the dashboard pages. See Dashboard.
pageInfoPageTypeyes Long-TermInformation about the dashboards page itself. See PageType.

The datatype outlined above uses another datatype for information on the dashboards returned. The table below details that datatype:

Table: Dashboard 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: Aug 19, 2025
allowedActions[AssetAction]yes Short-TermThe allowed asset actions. See AssetAction Table). This is feature is a preview and may be changed.
createdInfoAssetCommitMetadata  Long-TermMetadata related to the creation of the dashboard. See AssetCommitMetadata.
defaultFilterDashboardFilter  Long-TermThe default filter used with the dashboard (see DashboardFilter Table).
defaultSharedTimeEnabledbooleanyes Long-TermWhether the shared time by default is enabled.
defaultSharedTimeEndstringyes Long-TermThe default shared ending time.
defaultSharedTimeStartstringyes Long-TermThe default shared starting time.
descriptionstring  Long-TermA description of the dashboard.
displayNamestringyes Long-TermThe display name of the dashboard.
filters[DashboardFilter]yes Long-TermThe filters used with the dashboard. See DashboardFilter.
idstringyes Long-TermThe unique identifier for the dashboard.
isStarredbooleanyes Long-TermWhether the dashboard is marked with a star.
labels[string]yes Long-TermAny labels associated with the dashboard.
modifiedInfoAssetCommitMetadata  Long-TermMetadata related to the latest modification of the dashboard. See AssetCommitMetadata.
namestringyes Long-TermThe name of the dashboard.
packagePackageInstallationyes Long-TermThe package, if there is one, in which the dashboard is included (see PackageInstallation Table).
packageIdVersionedPackageSpecifieryes Long-TermThe unique identifiers of the package. VersionedPackageSpecifier is a scalar.
parameters[DashboardParameter]yes Long-TermList of dashboard parameters (see DashboardParameter Table).
readOnlyTokens[DashboardLink]yes Long-TermList of tokens used to access the dashboard without logging in. Useful for wall mounted dashboards or public dashboards. See DashboardLink.
resourcestringyes Short-TermThe resource identifier for this dashboard.
searchDomainSearchDomainyes Long-TermThe search domain for the dashboard. See SearchDomain.
sections[Section]yes Long-TermThe sections for the dashboard. See Section.
series[SeriesConfig]yes Long-TermThe series configuration for the dashboard. See SeriesConfig.
templateYamlstringyes DeprecatedA yaml formatted string that describes the dashboard. This field has been replaced with yamlTemplate. It will be removed at the earliest in version 1.225.
timeJumpSizeInMsinteger  Long-TermThe skip time in milliseconds for the dashboard.
updateFrequencyDashboardUpdateFrequencyTypeyes Long-TermThe frequency in which dashboard is updated. See DashboardUpdateFrequencyType, and the explanations under the DashboardParameter.
widgets[Widget]yes Long-TermWidgets for the dashboard (see Widget Table).
yamlTemplateYAMLyes Long-TermA yaml formatted string that describes the dashboard. YAML is a scalar. It doesn't contain links or permissions, and is safe to share and use for making copies of a dashboard. This replaced templateYaml starting in LogScale version 1.165.