AppDynamics Application Intelligence Platform

3.9.x Documentation

PDFs

Learn by Watching

Doc Maps

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Changed Output to output-CORE-44645

...

Parameter Name

Parameter Type

Value

Mandatory

Outputoutput

Query

HTTP Request parameter included as part
of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

exclude

Query

If false, the query retrieves only the business transactions that are included for monitoring. If true, the query retrieves only the excluded business transactions. Excluded business transactions are those that have been configured to be excluded from monitoring either from the UI or through the REST interface. The default is false.

No

Outputoutput

Query

HTTP Request parameter included as part of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

Outputoutput

Query

HTTP Request parameter included as part
of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

Outputoutput

Query

HTTP Request parameter included as part
of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

<node-name>

URI

Provide the node name

Yes

Outputoutput

Query

HTTP Request parameter included as part
of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

<tier-name>

URI

Provide the tier name.

Yes

Outputoutput

Query

HTTP Request parameter included as part
of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

<tier-name>

URI

Provide the tier name.

Yes

Outputoutput

Query

HTTP Request parameter included as part
of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

metrics

Query

 

Yes

Outputoutput

Query

HTTP Request parameter included as part of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

metric-path

Query

The metric expression to get the metric data. 
Use the pipe character to separate the parent and child name elements in the tree.
The Pipe delimiter must not appear at the beginning or at the end of the metric expression.

Yes

time-range-type

Query

Possible values are:
BEFORE_NOW 
To use the "BEFORE_NOW" option, you must also specify the "duration-in-mins" parameter.
BEFORE_TIME
To use the "BEFORE_TIME" option, you must also specify the "duration-in-mins" and "end-time" parameters.
AFTER_TIME 
To use the "AFTER_TIME" option, you must also specify the "duration-in-mins" and "start-time" parameters.
BETWEEN_TIMES
To use the "BETWEEN_TIMES" option, you must also specify the "start-time" and "end-time" parameters. The "BETWEEN_TIMES" range includes the start- time and excludes the end-time.

Yes

duration-in-mins

Query

Duration (in minutes) to return the metric data.

If time-range-type is BEFORE_NOW, BEFORE_TIME, or AFTER_TIME

start-time

Query

Start time (in milliseconds) from which the metric data is returned in UNIX epoch time.

If time-range-type is AFTER_TIME or BETWEEN_TIMES

end-time

Query

End time (in milliseconds) until which the metric data is returned in UNIX epoch time.

If time-range-type is BEFORE_TIME or BETWEEN_TIMES 

rollup

Query

Default is true.
If true, value as single data point is returned. If false, all the values within the specified time range are returned.

No

Outputoutput

Query

HTTP Request parameter included as part of the URL to change the output format. Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

time-range-type

Query

Possible values are:
BEFORE_NOW 
To use the "BEFORE_NOW" option, you must also specify the "duration-in-mins" parameter.
BEFORE_TIME  
To use the "BEFORE_TIME" option, you must also specify the "duration-in-mins" and "end-time" parameters.
AFTER_TIME
To use the "AFTER_TIME" option, you must also specify the "duration-in-mins" and "start-time" parameters.
BETWEEN_TIMES 
To use the "BETWEEN_TIMES" option, you must also specify the "start-time" and "end-time" parameters. The "BETWEEN_TIMES" range includes the start- time and excludes the end-time.

Yes

duration-in-mins

Query

Duration (in minutes) to return the metric data.

If time-range-type is BEFORE_NOW, BEFORE_TIME, or AFTER_TIME

start-time

Query

Start time (in milliseconds) from which the metric data is returned.

If time-range-type is AFTER_TIME or BETWEEN_TIMES

end-time

Query

End time (in milliseconds) until which the metric data is returned.

If time-range-type is BEFORE_TIME or BETWEEN_TIMES

Outputoutput

Query

HTTP Request parameter included as part of the URL to change the output format. Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

time-range-type

Query

Possible values are:
BEFORE_NOW 
To use the "BEFORE_NOW" option, you must also specify the "duration-in-mins" parameter.
BEFORE_TIME  
To use the "BEFORE_TIME" option, you must also specify the "duration-in-mins" and "end-time" parameters.
AFTER_TIME
To use the "AFTER_TIME" option, you must also specify the "duration-in-mins" and "start-time" parameters.
BETWEEN_TIMES 
To use the "BETWEEN_TIMES" option, you must also specify the "start-time" and "end-time" parameters. The "BETWEEN_TIMES" range includes the start- time and excludes the end-time.

Yes

duration-in-mins

Query

Duration (in minutes) to return the metric data.

If time-range-type is BEFORE_NOW, BEFORE_TIME, or AFTER_TIME

start-time

Query

Start time (in milliseconds) from which the metric data is returned.

If time-range-type is AFTER_TIME or BETWEEN_TIMES

end-time

Query

End time (in milliseconds) until which the metric data is returned.

If time-range-type is BEFORE_TIME or BETWEEN_TIMES

Outputoutput

Query

HTTP Request parameter included as part of the URL to change the output format. Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

time-range-type

Query

Possible values are:
BEFORE_NOW 
To use the "BEFORE_NOW" option, you must also specify the "duration-in-mins" parameter.
BEFORE_TIME 
To use the "BEFORE_TIME" option, you must also specify the "duration-in-mins" and "end-time" parameters.
AFTER_TIME 
To use the "AFTER_TIME" option, you must also specify the "duration-in-mins" and "start-time" parameters.
BETWEEN_TIMES
To use the "BETWEEN_TIMES" option, you must also specify the "start-time" and "end-time" parameters. The "BETWEEN_TIMES" range includes the start- time and excludes the end-time.

Yes

duration-in-mins

Query

Specify the duration (in minutes) to return the metric data.

If time-range-type is BEFORE_NOW, BEFORE_TIME, or AFTER_TIME

start-time

Query

Specify the start time (in milliseconds) from which the metric data is returned.

If time-range-type is AFTER_TIME or BETWEEN_TIMES

end-time

Query

Specify the end time (in milliseconds) until which the metric data is returned.

If time-range-type is BEFORE_TIME or BETWEEN_TIMES

event-types

Query

Specify the comma-separated list of event types for which you want to retrieve event information. See the Events Reference for the valid event types.

Yes

severities

Query

Specify the comma-separated list of severities for which you want to retrieve event information.

The severities are:

  • INFO
  • WARN
  • ERROR

Yes

Outputoutput

Query

HTTP Request parameter included as part of the URL to change the output format. Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-id>

URI

Provide either the application name or application id.

Yes

time-range-type

Query

Possible values are: 
BEFORE_NOW  
To use the "BEFORE_NOW" option, you must also specify the "duration-in-mins" parameter. 
BEFORE_TIME 
To use the "BEFORE_TIME" option, you must also specify the "duration-in-mins" and "end-time" parameters. 
AFTER_TIME  
To use the "AFTER_TIME" option, you must also specify the "duration-in-mins" and "start-time" parameters. 
BETWEEN_TIMES 
To use the "BETWEEN_TIMES" option, you must also specify the "start-time" and "end-time" parameters. The "BETWEEN_TIMES" range includes the start- time and excludes the end-time.

Yes

duration-in-mins

Query

Duration (in minutes) to return the data.

If time-range-type is BEFORE_NOW, BEFORE_TIME, or AFTER_TIME

start-time

Query

Start time (in milliseconds) from which the data is returned.

If time-range-type is AFTER_TIME or BETWEEN_TIMES

end-time

Query

End time (in milliseconds) until which the data is returned.

If time-range-type is BEFORE_TIMEor BETWEEN_TIMES

guids

Query

Array of comma-separated guids for the transaction snapshots. If not specified, retrieves all snapshots in the specified time range.

No

archived

Query

True to retrieve archived snapshots. Default is false.

No

deep-dive-policy

Query

Array of comma-separated snapshot policy filters to apply. Valid values are: 

  • SLA_FAILURE
  • TIME_SAMPLING
  • ERROR_SAMPLING
  • OCCURRENCE_SAMPLING 
  • ON_DEMAND
  • HOTSPOT
  • HOTSPOT_LEARN
  • APPLICATION_STARTUP
  • SLOW_DIAGNOSTIC_SESSION
  • ERROR_DIAGNOSTIC_SESSION
  • POLICY_FAILURE_DIAGNOSTIC_SESSION
  • DIAGNOSTIC_SESSION
  • INFLIGHT_SLOW_SESSION

No

application-component-ids

Query

Array of comma-separated tier IDs to filter. Default is all the tiers in the application.

No

application-component-node-ids

Query

Array of comma-separated node ID filters. Default is all the nodes in the application

No

business-transaction-ids

Query

Array of comma-separated business transaction ID filters. Default is all the business transactions in the application.

No

user-experience

Query

Array of comma-separated user experiences filters. Valid values are: 

  • NORMAL
  • SLOW
  • VERY_SLOW
  • STALL
  • ERROR

No

first-in-chain

Query

If true, retrieve only the first request from the chain. Default is false.

No

need-props

Query

If true, the values of the following snapshot properties are included in the output. These values correspond to the values of the data-collector-type parameter.
If false, these values are empty in the REST output.
The default is false. New in 3.7.11.

  • errorDetails
  • errorIDs
  • httpParameters
  • businessData
  • cookies
  • httpHeaders
  • sessionKeys
  • responseHeaders
  • logMessages
  • transactionProperties
  • transactionEvents
  • dotnetProperty

No

 

need-exit-calls

Query

If true, exit calls are included in the result. Default is false.

No

execution-time-in-milis

Query

If set, retrieves only data for requests with execution times greater than this value.

No

session-id

Query

If set, retrieves data only for this session id.

No

user-principal-id

Query

If set, retrieves data only for this user login. 

No

error-ids

Query

Array of comma-separated error codes to filter by. Default is to retrieve all error codes.

No

starting-request-id, ending-request-id

Query

If set, retrieves data only for this range of request IDs.

No

error-occurred

Query

If true, retrieves only error requests. Default is false.

No

diagnostic-snapshot

Query

If true, retrieves only diagnostic snapshots. Default is false.

No

bad-request

Query

If true, retrieves only slow and error requests. Default is false.

No

diagnostic-session-guid

Query

Array of comma-separated diagnostic session guids to filter.

No

data-collector-name

Query

Used with data-collector-value to filter snapshot collection based on the value of a data collector. New in 3.6.1.

No

data-collector-value

Query

Used with data-collector-name to filter snapshot collection based on the value of a data collector. New in 3.6.1.

If data-collector-name is set.

data-collector-type

Query

Used with data-collector-name and data-collector-value to filter snapshot collection based on the value of a data collector. New in 3.6.1. Some of the values contain spaces. All are case-sensitive and where indicated the spaces are required. Valid values are:

  • Error IDs
  • Stack Traces
  • Error Detail
  • Http Parameter
  • Business Data (This type is a method invocation data collector.)
  • Cookie
  • Http Header
  • Session Key
  • Response Header
  • Log Message
  • Transaction Property
  • Transaction Event
  • Dotnet Property
  • isProtoBuf
  • EUM Request GUID

Outputoutput

Query

HTTP Request parameter included as part of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

Outputoutput

Query

HTTP Request parameter included as part
of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

name

Query

Name of the Controller setting to retrieve

Yes

Outputoutput

Query

HTTP Request parameter included as part of the URL to change the output format.
Valid values are "XML" (default) or "JSON".

No

...

Parameter Name

Parameter Type

Value

Mandatory

<application-name | application-id>

URI

Provide either the application name or application id.

Yes

time-range-type

Query

Possible values are:
BEFORE_NOW 
To use the "BEFORE_NOW" option, you must also specify the "duration-in-mins" parameter.
BEFORE_TIME  
To use the "BEFORE_TIME" option, you must also specify the "duration-in-mins" and "end-time" parameters.
AFTER_TIME
To use the "AFTER_TIME" option, you must also specify the "duration-in-mins" and "start-time" parameters.
BETWEEN_TIMES 
To use the "BETWEEN_TIMES" option, you must also specify the "start-time" and "end-time" parameters.

Yes

duration-in-mins

Query

Duration (in minutes) to return the metric data.

If time-range-type is BEFORE_NOW, BEFORE_TIME, or AFTER_TIME

start-time

Query

Start time (in milliseconds) from which the metric data is returned.

If time-range-type is AFTER_TIME or BETWEEN_TIMES

end-time

Query

End time (in milliseconds) until which the metric data is returned.

If time-range-type is BEFORE_TIME or BETWEEN_TIMES

incident-status

Query

If OPEN, retrieve only the policy violations that are open. If RESOLVED, retrieve only the policy violations that are resolved.

No

Outputoutput

Query

HTTP Request parameter included as part of the URL to change the output format. Valid values are "XML" (default) or "JSON".

No

...