AppDynamics Snapshots API

openapi: 3.2.0
info:
  title: AppDynamics Metric and Snapshot Snapshots API
  description: The AppDynamics Metric and Snapshot API allows developers to retrieve metric data and transaction snapshots from monitored applications. It supports configurable time ranges, data aggregation through rollup parameters, and access to various metric types including response times, error rates, and call volumes. Developers can retrieve request snapshots for detailed transaction analysis and configure metric retention periods to control how long performance data is stored.
  version: 23.x
  contact:
    name: Splunk AppDynamics Support
    url: https://www.appdynamics.com/support
  termsOfService: https://www.cisco.com/c/en/us/about/legal/cloud-and-software.html
servers:
- url: https://{controller-host}/controller
  description: AppDynamics Controller
  variables:
    controller-host:
      default: example.saas.appdynamics.com
      description: The hostname of your AppDynamics Controller instance.
security:
- bearerAuth: []
- basicAuth: []
tags:
- name: Snapshots
  description: Retrieve transaction request snapshots for detailed performance analysis of individual requests.
paths:
  /rest/applications/{applicationId}/request-snapshots:
    get:
      operationId: listRequestSnapshots
      summary: List request snapshots for an application
      description: Returns transaction request snapshots for the specified application and time range. Snapshots capture detailed information about individual request executions including call graphs, data collectors, and error details.
      tags:
      - Snapshots
      parameters:
      - $ref: '#/components/parameters/applicationId'
      - name: time-range-type
        in: query
        required: true
        description: The type of time range for the snapshot query.
        schema:
          type: string
          enum:
          - BEFORE_NOW
          - BEFORE_TIME
          - AFTER_TIME
          - BETWEEN_TIMES
      - name: duration-in-mins
        in: query
        required: false
        description: Duration in minutes for BEFORE_NOW and BEFORE_TIME time range types.
        schema:
          type: integer
          minimum: 1
      - name: start-time
        in: query
        required: false
        description: Start time in Unix epoch milliseconds.
        schema:
          type: integer
          format: int64
      - name: end-time
        in: query
        required: false
        description: End time in Unix epoch milliseconds.
        schema:
          type: integer
          format: int64
      - name: guids
        in: query
        required: false
        description: Comma-separated list of snapshot GUIDs to retrieve specific snapshots.
        schema:
          type: string
      - name: archived
        in: query
        required: false
        description: When true, includes archived snapshots in the results.
        schema:
          type: boolean
      - name: deep-dive-policy
        in: query
        required: false
        description: Filter snapshots by the deep-dive policy that triggered them.
        schema:
          type: string
      - name: application-component-ids
        in: query
        required: false
        description: Comma-separated list of tier IDs to filter snapshots.
        schema:
          type: string
      - name: business-transaction-ids
        in: query
        required: false
        description: Comma-separated list of business transaction IDs to filter snapshots.
        schema:
          type: string
      - name: user-experience
        in: query
        required: false
        description: Filter by user experience classification.
        schema:
          type: string
          enum:
          - NORMAL
          - SLOW
          - VERY_SLOW
          - STALL
          - ERROR
      - name: first-in-chain
        in: query
        required: false
        description: When true, only returns the first snapshot in a cross-application call chain.
        schema:
          type: boolean
      - name: need-props
        in: query
        required: false
        description: When true, includes data collector properties in the response.
        schema:
          type: boolean
      - name: need-exit-calls
        in: query
        required: false
        description: When true, includes exit call details in the response.
        schema:
          type: boolean
      - name: execution-time-in-millis-greater-than
        in: query
        required: false
        description: Filter for snapshots with execution time greater than this value in milliseconds.
        schema:
          type: integer
          minimum: 0
      - name: data-collector-name
        in: query
        required: false
        description: Filter by data collector name.
        schema:
          type: string
      - name: data-collector-type
        in: query
        required: false
        description: Filter by data collector type.
        schema:
          type: string
      - name: data-collector-value
        in: query
        required: false
        description: Filter by data collector value.
        schema:
          type: string
      - $ref: '#/components/parameters/outputFormat'
      responses:
        '200':
          description: Successful retrieval of request snapshots
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/RequestSnapshot'
        '400':
          description: Bad request - invalid time range parameters
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Application not found
components:
  parameters:
    applicationId:
      name: applicationId
      in: path
      required: true
      description: The numeric ID or name of the business application.
      schema:
        type: string
    outputFormat:
      name: output
      in: query
      required: false
      description: The output format for the response. Defaults to XML if not specified.
      schema:
        type: string
        enum:
        - JSON
        - XML
        default: XML
  schemas:
    RequestSnapshot:
      type: object
      description: A transaction request snapshot capturing detailed execution information for a single request.
      properties:
        id:
          type: integer
          format: int64
          description: The internal numeric identifier for the snapshot.
        localID:
          type: integer
          format: int64
          description: The local ID of the snapshot on the originating node.
        requestGUID:
          type: string
          description: The globally unique identifier for this request snapshot.
        summary:
          type: string
          description: A summary description of the snapshot.
        businessTransactionId:
          type: integer
          format: int64
          description: The ID of the business transaction this snapshot belongs to.
        applicationComponentId:
          type: integer
          format: int64
          description: The tier ID where this snapshot was captured.
        applicationComponentNodeId:
          type: integer
          format: int64
          description: The node ID where this snapshot was captured.
        firstInChain:
          type: boolean
          description: Whether this is the first snapshot in a cross-application call chain.
        userExperience:
          type: string
          description: The user experience classification for this request.
          enum:
          - NORMAL
          - SLOW
          - VERY_SLOW
          - STALL
          - ERROR
        timeTakenInMilliSecs:
          type: integer
          format: int64
          description: The total execution time for this request in milliseconds.
        serverStartTime:
          type: integer
          format: int64
          description: The server-side start time in Unix epoch milliseconds.
        archived:
          type: boolean
          description: Whether this snapshot has been archived.
        URL:
          type: string
          description: The URL or entry point for this request.
        errorIDs:
          type: array
          description: List of error IDs associated with this snapshot.
          items:
            type: integer
            format: int64
        errorOccured:
          type: boolean
          description: Whether an error occurred during this request.
        diagnosticSessionGUID:
          type: string
          description: The GUID of the diagnostic session that triggered this snapshot.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 access token obtained from the /controller/api/oauth/access_token endpoint.
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using user@account:password format.
externalDocs:
  description: Metric and Snapshot API Documentation
  url: https://docs.appdynamics.com/appd/23.x/latest/en/extend-appdynamics/appdynamics-apis/metric-and-snapshot-api