Try it free

List your dashboard shares

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

List the dashboard share configurations you created in Dynatrace with the Public Access API, with filter and sort parameters to narrow the results.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/v1/shares

Overview

You use this operation to list the dashboard share configurations you created. The filter query parameter narrows the results by fields such as id and document, and the sort parameter orders them by one or more fields. A 200 response returns the list of shares, which you can use to review, update, or remove public links to your dashboards.

Authentication

To execute this request, you need a platform token or OAuth access token with public-access:shares:read scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
filterstring

Filter expression following DT REST API Guidelines. Supported fields: id, documentId, expirationDate, type, locale, timezone, refreshIntervalMinutes. Boolean operators 'and', 'or', 'not' are supported with standard precedence (and before or); round braces override precedence. String operators: '=', '!=', 'contains', 'starts-with', 'ends-with', 'in' (inexact operators are case-insensitive). Date/time operators: '=', '!=', '<', '<=', '>', '>=', 'in' (ISO 8601 format). The 'in' operator allows matching a set of values, e.g. documentId in ('id1', 'id2'). An empty filtered result is a successful HTTP 200 response. Null field behaviour: shares whose expirationDate is not set (null) do not match any date comparison operator and are excluded from results that filter on expirationDate. Maximum nesting depth: the filter engine enforces a maximum of 3 levels of nested parentheses. Expressions that exceed this limit are rejected with HTTP 400. Examples: documentId = '22' | expirationDate < '2026-01-01T00:00:00Z' | locale starts-with 'en'

queryOptional
sortstring

Comma-separated sort fields following DT REST API Guidelines. Ascending order is the default; prefix a field name with '-' for descending order. Multiple fields are applied left-to-right as tie-breakers. String fields are compared case-insensitively. Unknown or unsupported field names are silently ignored. An empty or blank sort value (e.g. ?sort=) is treated as no sort and returns shares in their natural insertion order. Sortable fields: id, documentId, name, creatorId, expirationDate, creationDate, type, locale, timezone, refreshIntervalMinutes, ipAllowList, sessionTimeoutMinutes. Example: -expirationDate,documentId

queryOptional

Response

Response codes

CodeTypeDescription
200ShareListResponse

List of shares

400--
4XX--
5XX--

Response body objects

The ShareListResponse object

ElementTypeDescription
sharesShareResponse[]-
totalCountinteger

Total number of shares

The ShareResponse object

ElementTypeDescription
idstring

Share UUID

documentIdstring

ID of the document being shared

namestring

Name of the share

expirationDatestring

Expiration date in ISO 8601 format

creationDatestring

Creation date of the share in ISO 8601 format

variablesobject

Dashboard variables

timeframeTimeframe

Timeframe override

filterSegmentsFilterSegment[]

Filter segments

localestring

Locale (e.g. en-US)

timezonestring

Timezone (e.g. Europe/Vienna)

typestring

Share type

The element can hold these values
  • dashboard
sessionTimeoutMinutesinteger

Session timeout in minutes; null when passcode is disabled

refreshIntervalMinutesinteger

Refresh interval in minutes

ipAllowListobject-
passcodePasscodeInfo-
iframeEmbeddingIframeEmbedding-
documentSnapshotDatestring

Date when the document snapshot was captured in ISO 8601 format

documentVersioninteger

Document version at the time the snapshot was captured

The Timeframe object

ElementTypeDescription
fromstring

Start of the timeframe as a relative or absolute expression parseable by the Dynatrace time parser (e.g. now()-2h, -1d@d, 2024-01-01T00:00:00Z).

tostring

End of the timeframe as a relative or absolute expression parseable by the Dynatrace time parser (e.g. now(), -1h@h, 2024-12-31T23:59:59Z).

The FilterSegment object

ElementTypeDescription
idstring

Segment ID

variablesFilterSegmentVariable[]-

The FilterSegmentVariable object

ElementTypeDescription
namestring

Variable name

valuesstring[]

Variable values

The PasscodeInfo object

ElementTypeDescription
enabledboolean

Whether passcode protection is enabled

valuestring

The passcode value; null when passcode is disabled

The IframeEmbedding object

ElementTypeDescription
enabledboolean

Whether iframe embedding is enabled for this share

Response body JSON models

{
  "shares": [
    {
      "id": "string",
      "documentId": "string",
      "name": "string",
      "expirationDate": "string",
      "creationDate": "string",
      "variables": {},
      "timeframe": {
        "from": "now()-2h",
        "to": "now()"
      },
      "filterSegments": [
        {
          "id": "string",
          "variables": [
            {
              "name": "string",
              "values": [
                "string"
              ]
            }
          ]
        }
      ],
      "locale": "string",
      "timezone": "string",
      "type": "dashboard",
      "sessionTimeoutMinutes": 1,
      "refreshIntervalMinutes": 1,
      "ipAllowList": {
        "enabled": true
      },
      "passcode": {
        "enabled": true,
        "value": "string"
      },
      "iframeEmbedding": {
        "enabled": true
      },
      "documentSnapshotDate": "string",
      "documentVersion": 1
    }
  ],
  "totalCount": 1
}
Related tags
Platform APIDynatrace Platform