Retrieve request message details

Use this request to retrieve a comprehensive set of Dynatrace Synthetic Monitoring account management metadata based on a specific request.

The following account management service supports the elicitation of Dynatrace Portal metadata via a rich request model. For more information, see Retrieving Basic Account Management Data.

User authentication

The request element that contains the username and password information that is authenticated to the Dynatrace Portal.

  • username – The account username
  • password – The account password

Context

These request elements support the elicitation of the Dynatrace Portal metadata that is independent of any particular account.

Data Element/Attribute Description
backboneGlobalRequest Request element supports elicitation of metadata information related to Backbone Nodes.
backboneGlobalRequest/?backboneLocationFilter
status Filter by ACTIVE or INACTIVE marking.
descriptionFilter Filter by node description or name.
cityFilter Filter by node city.
stateFilter Filter by node state.
countryFilter Filter by node country code.
createdTimeRangeFilter Filter by the date the node was initially recognized by the Dynatrace Portal.
modifiedTimeRangeFilter Filter by the date the node configuration was last modified.
lastMileGlobalRequest Request element supports elicitation of metadata information related to Last Mile, Private Peer, and Mobile Nodes.
lastMileGlobalRequest/?lastMileLocationFilter
type Filter by population type PUBLIC, PRIVATE, or LOADTEST.
descriptionFilter Filter by population description.
createdTimeRange Filter by date the population was initially configured and recognized by the Dynatrace Portal.
modifiedTimeRange Filter by the date the population configuration was last modified.

User account context

These request elements support elicitation of metadata that applies to a particular user account.

Data Element/Attribute Description
accountRequest
childAccountStatusFilter
  • ACTIVE – Filter for child accounts currently set to active status.
  • INACTIVE – Filter for child account currently set to inactive status.
userStatusFilter
  • ACTIVE – Filter for users currently set to active status.
  • INACTIVE – Filter for users currently set to inactive status.
productRequest
productRequest/?activeXFProductRequest
productRequest/?activeXFProductRequest/?activeXFTestRequest
productRequest/?activeXFProductRequest/?activeXFTestRequest/?testGroupFilter
status
  • ACTIVE – Filter for test groups currently set to active status.
  • INACTIVE – Filter for test groups currently set to inactive status.
descriptionFilter Filter for test groups based on specified description.
createdTimeRangeFilter Filter for test groups based on when they were initially configured and recognized by the system.
modifiedTimeRangeFilter Filter for test groups based on the group was last changed within the system.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter
idFilter Filter for tests having specific monitor IDs. IDs must be owned by the requesting account context.
typeFilter
  • BACKBONETX – Filter for set of Backbone transaction tests.
  • LMTX – Filter for set of Last Mile tests.
  • PPTX – Filter for set of Private peer (and Mobile) tests.
  • SCRIPT – Filter for set of un-provisioned tests (execution platform agnostic).
  • UNASSIGNED – Filter for set of un-provisioned tests (execution platform agnostic).
status
  • ACTIVE – Filter for set of tests set to active status.
  • INACTIVE – Filter for set of tests set to inactive status.
scriptVersion
  • 1 – Filter for test sets which comply with the GSL v1.0 script specification (IE Browser Agent compatible).
  • 2 – Filter for tests sets which comply with the GSL v2.0 script specification (Browser agent compatible).
scriptBrowserVersion
  • IE7 – Filter for set of tests targeting IE7 browser agent.
  • FF35– Filter for set of tests targeting FireFox 35 browser agent.
scriptConfiguration
  • BROWSER – Filter for set of tests targeting browser agents.
  • MOBILE – Filter for set of tests targeting agents running on Mobile nodes.
pageUrlFilter Filter for tests with page URLs matching the URL specified in the string.
pageNameFilter Filter for tests with page names matching the specified filter string(s).
descriptionFilter Filter for tests with descriptions matching the specified filter string(s).
createdTimeRangeFilter Filter for tests created within the specified time range.
modifiedTimeRangeFilter Filter for tests modified within the specified time range.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter/?backboneLocationFilter
status Filter by ACTIVE or INACTIVE marking.
descriptionFilter Filter by node description or name.
cityFilter Filter by node city.
stateFilter Filter by node state.
countryFilter Filter by node country code.
createdTimeRangeFilter Filter by the date the node was initially recognized by the Dynatrace Portal.
modifiedTimeRangeFilter Filter by the date the node configuration was last modified.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter/?lastMileMonitorInstanceFilter Filter Last Mile Transaction Monitor Instance metadata (also referred to as Monitor Batch Group Monitors in other parts of the system).
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter/?lastMileMonitorInstanceFilter
status Filter by ACTIVE or INACTIVE marking.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter/?lastMileMonitorInstance/?lastMileBatchGroupFilter Filter by Last Mile/Private Peer batch group metadata:
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter/?lastMileMonitorInstance/?lastMileBatchGroupFilter
status Filter by ACTIVE or INACTIVE marking.
type Filter by NORMAL or LOADTEST marking.
startTimeRangeFilter Filter for tests started within the specified time range.
endTimeRangeFilter Filter for tests that end within the specified time range.
descriptionFilter Filter by Last Mile Batch Group description.
createdTimeRangeFilter Filter by the time the batch group was initially recognized by the Dynatrace Portal.
modifiedTimeRangeFilter Filter by the time the batch group was last modified.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter/?lastMileMonitorInstance/?lastMileBatchGroupFilter/?lastMileLocationFilter Filter Last Mile/Private Peer population metadata:
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter/?lastMileMonitorInstance/?lastMileBatchGroupFilter/?lastMileLocationFilter
type Filter by PUBLIC, PRIVATE, or LOADTEST marking.
descriptionFilter Filter by population description.
createdTimeRangeFilter Filter by the time the population was initially recognized by the Dynatrace Portal.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter/?modifiedTimeRangeFilter Filter by the time the population was last modified.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter
includeParentGroups Set to TRUE to elicit group/folder elements for tests.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter/?scriptMetadataOptionsFilter Filters tests by script metadata elements:
productRequest/?activeXFProductRequest/?activeXFTestRequest/?activeXFTestFilter/?scriptMetadataOptionsFilter
includeBrowserVersion Set to TRUE to elicit browser version for tests.
includeGSLVersion Set to TRUE to elicit GSL version for tests.
includeUserAgent Set to TRUE to elicit user agent for tests.
includeMobileDeviceName Set to TRUE to elicit mobile device name for tests.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneStreamTestFilter
status
  • ACTIVE – Filter for test groups currently set to active status.
  • INACTIVE – Filter for test groups currently set to inactive status.
type
  • WMP – Filter for test set to target the Windows Media Player 10 agent.
  • FLASH – Filter for tests sets to target the Flash agent.
streamUrlFilter Filter for tests with URLs matching the specified filter string.
streamNameFilter Filter for tests with stream names matching the specified filter string(s).
descriptionFilter Filter for tests based on specified description.
createdTimeRangeFilter Filter for tests based on when they were initially configured and recognized by the system.
modifiedTimeRangeFilter Filter for tests based on the group was last changed within the system.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneStreamTestFilter/?backboneLocationFilter Filter by node/site metadata:
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneStreamTestFilter/?backboneLocationFilter
status Filter by ACTIVE or INACTIVE marking.
descriptionFilter Filter by node description or name.
cityFilter Filter by node city.
stateFilter Filter by node state.
countryFilter Filter by node country code.
createdTimeRangeFilter Filter by the date the node was initially recognized by the Dynatrace Portal.
modifiedTimeRangeFilter Filter by the date the node configuration was last modified.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneStreamTestFilter
includeParentGroups
  • TRUE – Elicit parent group information for tests satisfying specified filter criteria.
  • FALSE – Do not elicit parent group information.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneTransactionTestFilter
status
  • ACTIVE – Filter for set of tests set to active status.
  • INACTIVE – Filter for set of tests set to inactive status.
scriptVersion
  • 1 – Filter for test sets which comply with the GSL v1.0 script specification (IE Browser Agent compatible).
  • 2 – Filter for tests sets which comply with the GSL v2.0 script specification (Browser agent compatible).
scriptBrowserVersion
  • IE7 – Filter for set of tests targeting IE7 browser agent.
  • FF35 – Filter for set of tests targeting FireFox 35 browser agent.
scriptConfiguration
  • BROWSER – Filter for set of tests targeting browser agents.
  • MOBILE – Filter for set of tests targeting agents running on Mobile nodes.
pageUrlFilter Filter for tests with page URLs matching the URL specified in the string.
pageNameFilter Filter for tests with page names matching the specified filter string(s).
descriptionFilter Filter for tests with descriptions matching the specified filter string(s).
createdTimeRangeFilter Filter for tests created within the specified time range.
modifiedTimeRangeFilter Filter for tests modified within the specified time range.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneTransactionTestFilter/?backboneLocationFilter Filter by node/site metadata:
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneTransactionTestFilter/?backboneLocationFilter
status Filter by ACTIVE or INACTIVE marking.
descriptionFilter Filter by node description or name.
cityFilter Filter by node city.
stateFilter Filter by node state.
countryFilter Filter by node country code.
createdTimeRangeFilter Filter by the date the node was initially recognized by the Dynatrace Portal.
modifiedTimeRangeFilter Filter by the date the node configuration was last modified.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneTransactionTestFilter
includeParentGroups
  • TRUE – Elicit parent group information for tests satisfying specified filter criteria.
  • FALSE – Do not elicit parent group information.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneTransactionTestFilter/?scriptMetadataOptionsFilter Filters tests by script metadata elements:
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneTransactionTestFilter/?scriptMetadataOptionsFilter
includeBrowserVersion Set to TRUE to elicit browser version for tests.
includeGSLVersion Set to TRUE to elicit GSL version for tests.
includeUserAgent Set to TRUE to elicit user agent for tests.
includeMobileDeviceName Set to TRUE to elicit mobile device name for tests.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?backboneTestRequest/?backboneLocationFilter
status Filter by ACTIVE or INACTIVE marking.
descriptionFilter Filter by node description or name.
cityFilter Filter by node city.
stateFilter Filter by node state.
countryFilter Filter by node country code.
createdTimeRangeFilter Filter by the date the node was initially recognized by the Dynatrace Portal.
modifiedTimeRangeFilter Filter by the date the node configuration was last modified.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest/?lastMileTransactionTestFilter
status
  • ACTIVE – Filter for set of tests set to active status.
  • INACTIVE – Filter for set of tests set to inactive status.
type
  • LMTX – Filter for tests based on Last Mile Network.
  • PPTX – Filter for tests based on Private Peer Networks (includes Mobile subtypes).
scriptVersion
  • 1 – Filter for test sets which comply with the GSL v1.0 script specification (IE Browser Agent compatible).
  • 2 – Filter for tests sets which comply with the GSL v2.0 script specification (Browser agent compatible).
scriptBrowserVersion
  • IE7 – Filter for set of tests targeting IE7 browser agent.
  • FF35 – Filter for set of tests targeting FireFox 35 browser agent.
scriptConfiguration
  • BROWSER – Filter for set of tests targeting browser agents.
  • MOBILE – Filter for set of tests targeting agents running on Mobile nodes.
pageUrlFilter Filter for tests with page URLs matching the URL specified in the string.
pageNameFilter Filter for tests with page names matching the specified filter string(s).
descriptionFilter Filter for tests with descriptions matching the specified filter string(s).
createdTimeRangeFilter Filter for tests created within the specified time range.
modifiedTimeRangeFilter Filter for tests modified within the specified time range.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest/?lastMileTransactionTestFilter/?lastMileMonitorInstanceFilter Filter Last Mile Transaction Monitor Instance metadata.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest/?lastMileTransactionTestFilter/?lastMileMonitorInstanceFilter
status Filter by ACTIVE or INACTIVE marking.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest/?lastMileTransactionTestFilter/?lastMileMonitorInstanceFilter/?lastMileBatchGroupFilter Filter by Last Mile/Private Peer batch group metadata:
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest/?lastMileTransactionTestFilter/?lastMileMonitorInstanceFilter/?lastMileBatchGroupFilter
status Filter by ACTIVE or INACTIVE marking.
type Filter by NORMAL or LOADTEST marking.
startTimeRangeFilter Filter for tests started within the specified time range.
endTimeRangeFilter Filter for tests that end within the specified time range.
descriptionFilter Filter by Last Mile Batch Group description.
createdTimeRangeFilter Filter by the time the batch group was initially recognized by the Dynatrace Portal.
modifiedTimeRangeFilter Filter by the time the batch group was last modified.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest/?lastMileTransactionTestFilter/?lastMileMonitorInstanceFilter/?lastMileBatchGroupFilter/?lastMileLocationFilter Filter Last Mile/Private Peer population metadata:
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest/?lastMileTransactionTestFilter/?lastMileMonitorInstanceFilter/?lastMileBatchGroupFilter/?lastMileLocationFilter
type Filter by PUBLIC, PRIVATE, or LOADTEST marking.
descriptionFilter Filter by population description.
createdTimeRangeFilter Filter by the time the population was initially recognized by the Dynatrace Portal.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest/?lastMileTransactionTestFilter
includeParentGroups
  • TRUE – Elicit parent group information for tests satisfying specified filter criteria.
  • FALSE – Do not elicit parent group information.
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest/?lastMileTransactionTestFilter/?scriptMetadataOptionsFilter Filters tests by script metadata elements:
productRequest/?activeXFProductRequest/?activeXFTestRequest/?lastMileTestRequest/?lastMileTransactionTestFilter/?scriptMetadataOptionsFilter
includeBrowserVersion Set to TRUE to elicit browser version for tests.
includeGSLVersion Set to TRUE to elicit GSL version for tests.
includeUserAgent Set to TRUE to elicit user agent for tests.
includeMobileDeviceName Set to TRUE to elicit mobile device name for tests.

Security

All interactions with the Dynatrace Portal account management service require authentication by user name and password. The service is secured via HTTPS.