API Stability Long-Term

The sharedDashboards() GraphQL query gets a shared dashboard by it's shared link token.

For more information on dashboards, see the Dashboards & Widgets documentation page. You may also want to look at the Dashboards page in the Training section.

Syntax

Below is the syntax for the sharedDashboards() query field:

graphql
sharedDashboards(
     token: string!
   ): SharedDashboard!

Below is an example of how this query field might be used:

Raw
graphql
query {
  sharedDashboards(token:"Pbxu4Pyz0O7GGfvsNPrMEQYLoUzxLjUocN7")
     { id, name, 
       widgets{id, title}
     }
}
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 {
  sharedDashboards(token:\"Pbxu4Pyz0O7GGfvsNPrMEQYLoUzxLjUocN7\")
     { id, name, 
       widgets{id, title}
     }
}"
}
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 {
  sharedDashboards(token:\"Pbxu4Pyz0O7GGfvsNPrMEQYLoUzxLjUocN7\")
     { id, name, 
       widgets{id, title}
     }
}"
}
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 { ^
  sharedDashboards(token:\"Pbxu4Pyz0O7GGfvsNPrMEQYLoUzxLjUocN7\") ^
     { id, name,  ^
       widgets{id, title} ^
     } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  sharedDashboards(token:\"Pbxu4Pyz0O7GGfvsNPrMEQYLoUzxLjUocN7\")
     { id, name, 
       widgets{id, title}
     }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "query {
  sharedDashboards(token:\"Pbxu4Pyz0O7GGfvsNPrMEQYLoUzxLjUocN7\")
     { id, name, 
       widgets{id, title}
     }
}"
}';
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 {
  sharedDashboards(token:\"Pbxu4Pyz0O7GGfvsNPrMEQYLoUzxLjUocN7\")
     { id, name, 
       widgets{id, title}
     }
}"
}'''

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 {
  sharedDashboards(token:\"Pbxu4Pyz0O7GGfvsNPrMEQYLoUzxLjUocN7\")
     { id, name, 
       widgets{id, title}
     }
}"
}
);


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();

Returned Datatypes

The returned datatype SharedDashboard has its own parameters. Below is a list of them along with their datatypes and a description of each:

Table: SharedDashboard

ParameterTypeRequiredDefaultStabilityDescription
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: Mar 27, 2025
displayNamestringyes Long-TermThe display name of the shared dashboard.
idstringyes Long-TermThe unique identifier of the shared dashboard.
ipFilterIPFilter  Long-TermThe shared dashboard's IP filter. See IPFilter.
namestringyes Long-TermThe name of the shared dashboard.
repoOrViewNameRepoOrViewNameyes Long-TermThe name of the repository or view on which queries are executed. RepoOrViewName is a scalar.
resourcestringyes Short-TermThe resource identifier for the dashboard.
sections[Section]  Long-TermThe related sections. See Section.
sharedTimeIntervalSharedDashboardTimeInterval  Long-TermThe time interval of the shared dashboard. See SharedDashboardTimeInterval.
widgets[Widget]yes Long-TermThe widgets used in the shared dashboard. See Widget.