Summary

The dashboardsPage() GraphQL query returns paginated information about dashboards. Use pageSize and pageNumber to control which page of results to retrieve, and optionally filter by dashboard name with search.

API Stability Long-Term

Syntax

graphql
dashboardsPage(
      search: String,
      pageNumber: Int!,
      pageSize: Int!
   ): DashboardPage!

pageNumber and pageSize are required and control pagination. search is optional and filters results by dashboard name. Returns a non-nullable DashboardPage object with details on each dashboard and result set tallies. See Returned Values 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. Select the Dashboard datatype in the table below for more parameters.

Input Parameters

Provide an optional dashboard name search filter, the number of results per page, and the page number to return.

Table: Input Parameters & Datatypes

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

Returned Values

The DashboardPage result includes pagination metadata and a list of Dashboard objects. Each dashboard entry provides its identifier, name, associated repository, and more. The available fields are listed here:

Table: DashboardPage Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
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: Oct 14, 2026 
pageDashboardyes Long-Term Specific information on each dashboard to be returned for the dashboard pages. See Dashboard.
pageInfoPageTypeyes Long-Term Information about the dashboards page itself. See PageType.

The DashboardPage type contains Dashboard objects. For reference, the Dashboard datatype table is included here:

Table: Dashboard Datatype

ParameterTypeRequiredDefaultStabilityAvailabilityDescription
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: Oct 14, 2026 
allowedActionsAssetActionyes Short-Term The allowed asset actions. See AssetAction Table). This is feature is a preview and may be changed.
createdInfoAssetCommitMetadata  Long-Term Metadata related to the creation of the dashboard. See AssetCommitMetadata.
defaultFilterDashboardFilter  Long-Term The default filter used with the dashboard (see DashboardFilter Table).
defaultSharedTimeEnabledBooleanyes Long-Term Whether the shared time by default is enabled.
defaultSharedTimeEndStringyes Long-Term The default shared ending time.
defaultSharedTimeStartStringyes Long-Term The default shared starting time.
descriptionString  Long-Term A description of the dashboard.
displayNameStringyes Long-Term The display name of the dashboard.
filtersDashboardFilteryes Long-Term The filters used with the dashboard. See DashboardFilter.
idStringyes Long-Term The unique identifier for the dashboard.
isStarredBooleanyes Long-Term Whether the dashboard is marked with a star.
labelsStringyes Long-Term Any labels associated with the dashboard.
modifiedInfoAssetCommitMetadata  Long-Term Metadata related to the latest modification of the dashboard. See AssetCommitMetadata.
nameStringyes Long-Term The name of the dashboard.
packagePackageInstallation  Long-Term The package, if there is one, in which the dashboard is included (see PackageInstallation Table).
packageIdVersionedPackageSpecifier  Long-Term The unique identifiers of the package. VersionedPackageSpecifier is a scalar.
parametersDashboardParameteryes Long-Term List of dashboard parameters (see DashboardParameter Table).
readOnlyTokensDashboardLinkyes Long-Term List of tokens used to access the dashboard without logging in. Useful for wall mounted dashboards or public dashboards. See DashboardLink.
resourceStringyes Short-Term The resource identifier for this dashboard.
searchDomainSearchDomainyes Long-Term The search domain for the dashboard. See SearchDomain.
sectionsSectionyes Long-Term The sections for the dashboard. See Section.
seriesSeriesConfigyes Long-Term The series configuration for the dashboard. See SeriesConfig.
seriesColorPaletteString  Short-Term Stability: Short-term
templateYamlStringyes  deprecated in 1.225A YAML formatted string that describes the dashboard. It does not contain links or permissions, and is safe to share and use for making copies of a dashboard.
timeJumpSizeInMsInt  Long-Term The skip time in milliseconds for the dashboard.
updateFrequencyDashboardUpdateFrequencyTypeyes Long-Term The frequency in which dashboard is updated. See DashboardUpdateFrequencyType, and the explanations under the DashboardParameter.
widgetsWidgetyes Long-Term Widgets for the dashboard (see Widget Table).
yamlTemplateYAMLyes Long-Term A 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.