List all dashboard share configurations in your Dynatrace environment as an admin with the Public Access API, with filter and sort parameters.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/admin/shares |
You use this admin operation to list the dashboard share configurations of every user in your environment, for example to audit which dashboards are publicly accessible. The filter and sort query parameters work the same way as for your own shares. A 200 response returns the list of shared configurations for the tenant.
To execute this request, you need a platform token or OAuth access token with public-access:shares:admin scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| filter | string | Filter expression following DT REST API Guidelines. Same fields and syntax as the public list endpoint. For admins the primary use cases are filtering by creatorId and documentId (e.g. creatorId = '...', documentId = '...'). An empty filter returns all shares for the tenant. | query | Optional |
| sort | string | Comma-separated sort fields following DT REST API Guidelines. Same semantics as the public list endpoint. | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Share | List of shared configs for the tenant |
| 400 | - | - |
| 4XX | - | - |
| 5XX | - | - |
ShareListResponse object| Element | Type | Description |
|---|---|---|
| shares | Share | - |
| totalCount | integer | Total number of shares |
ShareResponse object| Element | Type | Description |
|---|---|---|
| id | string | Share UUID |
| documentId | string | ID of the document being shared |
| name | string | Name of the share |
| expirationDate | string | Expiration date in ISO 8601 format |
| creationDate | string | Creation date of the share in ISO 8601 format |
| variables | object | Dashboard variables |
| timeframe | Timeframe | Timeframe override |
| filterSegments | Filter | Filter segments |
| locale | string | Locale (e.g. en-US) |
| timezone | string | Timezone (e.g. Europe/Vienna) |
| type | string | Share type The element can hold these values
|
| sessionTimeoutMinutes | integer | Session timeout in minutes; null when passcode is disabled |
| refreshIntervalMinutes | integer | Refresh interval in minutes |
| ipAllowList | object | - |
| passcode | Passcode | - |
| iframeEmbedding | Iframe | - |
| documentSnapshotDate | string | Date when the document snapshot was captured in ISO 8601 format |
| documentVersion | integer | Document version at the time the snapshot was captured |
Timeframe object| Element | Type | Description |
|---|---|---|
| from | string | 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). |
| to | string | 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). |
FilterSegment object| Element | Type | Description |
|---|---|---|
| id | string | Segment ID |
| variables | Filter | - |
FilterSegmentVariable object| Element | Type | Description |
|---|---|---|
| name | string | Variable name |
| values | string[] | Variable values |
PasscodeInfo object| Element | Type | Description |
|---|---|---|
| enabled | boolean | Whether passcode protection is enabled |
| value | string | The passcode value; null when passcode is disabled |
IframeEmbedding object| Element | Type | Description |
|---|---|---|
| enabled | boolean | Whether iframe embedding is enabled for this share |
{"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}