Microsoft Azure Application Insights Data Plane

Microsoft Azure Application Insights Data Plane is a powerful tool that allows users to analyze and gain insights from data collected by their applications. The data plane enables users to track and monitor the performance, usage, and user interactions of their applications in real time. This data can be used to identify and troubleshoot issues, optimize performance, and make informed decisions to improve user experience.

OpenAPI Specification

application-insights-data-plane-openapi-original.yml Raw ↑
swagger: '2.0'
info:
  version: '2018-04-20'
  title: Microsoft Azure Application Insights Data Plane
  description: This API exposes AI metric & event information and associated metadata
  termsOfService: https://dev.applicationinsights.io/tos
  contact:
    name: AIAPI Team
    url: https://dev.applicationinsights.io/support
    email: [email protected]
  license:
    name: Microsoft
    url: https://dev.applicationinsights.io/license
host: management.azure.com
schemes:
  - https
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  azure_auth:
    type: oauth2
    authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
    flow: implicit
    description: Azure Active Directory OAuth2 Flow
    scopes:
      user_impersonation: impersonate your user account
security:
  - azure_auth:
      - user_impersonation
paths:
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/query
  : post:
      operationId: microsoftAzureQueryExecute
      summary: Microsoft Azure Execute An Analytics Query
      description: >-
        Executes an Analytics query for data.
        [Here](https://dev.applicationinsights.io/documentation/Using-the-API/Query)
        is an example for using POST with an Analytics query.
      x-ms-examples:
        queryPost:
          $ref: examples/query-post.json
      parameters:
        - $ref: '#/parameters/subscriptionId'
        - $ref: '#/parameters/resourceGroupName'
        - $ref: '#/parameters/applicationName'
        - $ref: '#/parameters/queryBody'
        - $ref: '#/parameters/apiVersion'
      responses:
        '200':
          description: Successful response
          schema:
            $ref: '#/definitions/queryResults'
        default:
          description: An error response object.
          schema:
            $ref: '#/definitions/errorResponse'
      tags:
        - Subscriptions
    get:
      operationId: microsoftAzureQueryGet
      summary: Microsoft Azure Execute An Analytics Query
      description: Executes an Analytics query for data
      x-ms-examples:
        queryGet:
          $ref: examples/query-get.json
      parameters:
        - $ref: '#/parameters/subscriptionId'
        - $ref: '#/parameters/resourceGroupName'
        - $ref: '#/parameters/applicationName'
        - $ref: '#/parameters/queryParam'
        - $ref: '#/parameters/queryTimespan'
        - $ref: '#/parameters/apiVersion'
      responses:
        '200':
          description: Successful response
          schema:
            $ref: '#/definitions/queryResults'
        default:
          description: An error response object.
          schema:
            $ref: '#/definitions/errorResponse'
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/metadata
  : post:
      operationId: microsoftAzureMetadataPost
      summary: Microsoft Azure Gets Metadata Information
      description: >-
        Retrieve the metadata information for the app, including its schema,
        etc.
      x-ms-examples:
        metadataPost:
          $ref: examples/metadata-post.json
      parameters:
        - $ref: '#/parameters/subscriptionId'
        - $ref: '#/parameters/resourceGroupName'
        - $ref: '#/parameters/applicationName'
        - $ref: '#/parameters/apiVersion'
      responses:
        '200':
          description: Successful response
          schema:
            $ref: '#/definitions/metadataResults'
        default:
          description: An error response object.
          schema:
            $ref: '#/definitions/errorResponse'
      tags:
        - Subscriptions
    get:
      operationId: microsoftAzureMetadataGet
      summary: Microsoft Azure Gets Metadata Information
      description: >-
        Retrieve the metadata information for the app, including its schema,
        etc.
      x-ms-examples:
        metadataGet:
          $ref: examples/metadata-get.json
      parameters:
        - $ref: '#/parameters/subscriptionId'
        - $ref: '#/parameters/resourceGroupName'
        - $ref: '#/parameters/applicationName'
        - $ref: '#/parameters/apiVersion'
      responses:
        '200':
          description: Successful response
          schema:
            $ref: '#/definitions/metadataResults'
        default:
          description: An error response object.
          schema:
            $ref: '#/definitions/errorResponse'
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/metrics/{metricId}
  : get:
      operationId: microsoftAzureMetricsGet
      summary: Microsoft Azure Retrieve Metric Data
      description: Gets metric values for a single metric
      x-ms-examples:
        simpleMetric:
          $ref: examples/metric-get.json
        intervaledMetric:
          $ref: examples/metric-get-full.json
        segmentedIntervaledMetric:
          $ref: examples/metric-get-segmented.json
      parameters:
        - $ref: '#/parameters/subscriptionId'
        - $ref: '#/parameters/resourceGroupName'
        - $ref: '#/parameters/applicationName'
        - $ref: '#/parameters/metricId'
        - $ref: '#/parameters/metricsTimespan'
        - $ref: '#/parameters/metricsInterval'
        - $ref: '#/parameters/metricsAggregation'
        - $ref: '#/parameters/metricsSegment'
        - $ref: '#/parameters/metricsTop'
        - $ref: '#/parameters/metricsOrderBy'
        - $ref: '#/parameters/metricsFilter'
        - $ref: '#/parameters/apiVersion'
      responses:
        '200':
          description: Successful response
          schema:
            $ref: '#/definitions/metricsResult'
        default:
          description: An error response object.
          schema:
            $ref: '#/definitions/errorResponse'
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/metrics/metadata
  : get:
      operationId: microsoftAzureMetricsGetmetadata
      summary: Microsoft Azure Retrieve Metric Metadata
      description: Gets metadata describing the available metrics
      x-ms-examples:
        metricMetadata:
          $ref: examples/metrics-get-metadata.json
      parameters:
        - $ref: '#/parameters/subscriptionId'
        - $ref: '#/parameters/resourceGroupName'
        - $ref: '#/parameters/applicationName'
        - $ref: '#/parameters/apiVersion'
      responses:
        '200':
          description: Successful responses
          schema:
            type: object
        default:
          description: An error response object.
          schema:
            $ref: '#/definitions/errorResponse'
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/events/{eventType}
  : get:
      operationId: microsoftAzureEventsGetbytype
      summary: Microsoft Azure Execute Odata Query
      description: Executes an OData query for events
      x-ms-examples:
        eventByType:
          $ref: examples/events-get-by-type.json
      parameters:
        - $ref: '#/parameters/subscriptionId'
        - $ref: '#/parameters/resourceGroupName'
        - $ref: '#/parameters/applicationName'
        - $ref: '#/parameters/eventType'
        - $ref: '#/parameters/eventsTimespan'
        - $ref: '#/parameters/eventsFilter'
        - $ref: '#/parameters/eventsSearch'
        - $ref: '#/parameters/eventsOrderBy'
        - $ref: '#/parameters/eventsSelect'
        - $ref: '#/parameters/eventsSkip'
        - $ref: '#/parameters/eventsTop'
        - $ref: '#/parameters/eventsFormat'
        - $ref: '#/parameters/eventsCount'
        - $ref: '#/parameters/eventsApply'
        - $ref: '#/parameters/apiVersion'
      responses:
        '200':
          description: Successful response
          schema:
            $ref: '#/definitions/eventsResults'
        default:
          description: An error response object.
          schema:
            $ref: '#/definitions/errorResponse'
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/events/{eventType}/{eventId}
  : get:
      operationId: microsoftAzureEventsGet
      summary: Microsoft Azure Get An Event
      description: Gets the data for a single event
      x-ms-examples:
        eventById:
          $ref: examples/events-get-by-id.json
      parameters:
        - $ref: '#/parameters/subscriptionId'
        - $ref: '#/parameters/resourceGroupName'
        - $ref: '#/parameters/applicationName'
        - $ref: '#/parameters/eventType'
        - $ref: '#/parameters/eventsTimespan'
        - $ref: '#/parameters/eventId'
        - $ref: '#/parameters/apiVersion'
      responses:
        '200':
          description: Successful response
          schema:
            $ref: '#/definitions/eventsResults'
        default:
          description: An error response object.
          schema:
            $ref: '#/definitions/errorResponse'
      tags:
        - Subscriptions
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Insights/components/{applicationName}/events/$metadata
  : get:
      operationId: microsoftAzureEventsGetodatametadata
      summary: Microsoft Azure Get Odata Metadata
      description: Gets OData EDMX metadata describing the event data model
      x-ms-examples:
        eventMetadata:
          $ref: examples/events-get-metadata.json
      parameters:
        - $ref: '#/parameters/subscriptionId'
        - $ref: '#/parameters/resourceGroupName'
        - $ref: '#/parameters/applicationName'
        - $ref: '#/parameters/apiVersion'
      produces:
        - application/xml;charset=utf-8
      responses:
        '200':
          description: Successful response
          schema:
            type: object
        default:
          description: An error response object.
          schema:
            $ref: '#/definitions/errorResponse'
      tags:
        - Subscriptions
parameters:
  metricId:
    name: metricId
    in: path
    required: true
    x-ms-parameter-location: method
    description: >-
      ID of the metric. This is either a standard AI metric, or an
      application-specific custom metric.
    type: string
    enum:
      - requests/count
      - requests/duration
      - requests/failed
      - users/count
      - users/authenticated
      - pageViews/count
      - pageViews/duration
      - client/processingDuration
      - client/receiveDuration
      - client/networkDuration
      - client/sendDuration
      - client/totalDuration
      - dependencies/count
      - dependencies/failed
      - dependencies/duration
      - exceptions/count
      - exceptions/browser
      - exceptions/server
      - sessions/count
      - performanceCounters/requestExecutionTime
      - performanceCounters/requestsPerSecond
      - performanceCounters/requestsInQueue
      - performanceCounters/memoryAvailableBytes
      - performanceCounters/exceptionsPerSecond
      - performanceCounters/processCpuPercentage
      - performanceCounters/processIOBytesPerSecond
      - performanceCounters/processPrivateBytes
      - performanceCounters/processorCpuPercentage
      - availabilityResults/availabilityPercentage
      - availabilityResults/duration
      - billing/telemetryCount
      - customEvents/count
    x-ms-enum:
      name: MetricId
      modelAsString: true
  metricsTimespan:
    name: timespan
    in: query
    required: false
    x-ms-parameter-location: method
    description: >-
      The timespan over which to retrieve metric values. This is an ISO8601 time
      period value. If timespan is omitted, a default time range of `PT12H`
      ("last 12 hours") is used. The actual timespan that is queried may be
      adjusted by the server based. In all cases, the actual time span used for
      the query is included in the response.
    type: string
  metricsAggregation:
    name: aggregation
    in: query
    collectionFormat: csv
    x-ms-parameter-location: method
    description: >-
      The aggregation to use when computing the metric values. To retrieve more
      than one aggregation at a time, separate them with a comma. If no
      aggregation is specified, then the default aggregation for the metric is
      used.
    type: array
    minItems: 1
    items:
      type: string
      enum:
        - min
        - max
        - avg
        - sum
        - count
        - unique
      x-ms-enum:
        name: MetricsAggregation
        modelAsString: true
  metricsInterval:
    name: interval
    in: query
    x-ms-parameter-location: method
    description: >-
      The time interval to use when retrieving metric values. This is an ISO8601
      duration. If interval is omitted, the metric value is aggregated across
      the entire timespan. If interval is supplied, the server may adjust the
      interval to a more appropriate size based on the timespan used for the
      query. In all cases, the actual interval used for the query is included in
      the response.
    type: string
    format: duration
  metricsSegment:
    name: segment
    in: query
    collectionFormat: csv
    x-ms-parameter-location: method
    description: >-
      The name of the dimension to segment the metric values by. This dimension
      must be applicable to the metric you are retrieving. To segment by more
      than one dimension at a time, separate them with a comma (,). In this
      case, the metric data will be segmented in the order the dimensions are
      listed in the parameter.
    type: array
    minItems: 1
    items:
      type: string
      enum:
        - applicationBuild
        - applicationVersion
        - authenticatedOrAnonymousTraffic
        - browser
        - browserVersion
        - city
        - cloudRoleName
        - cloudServiceName
        - continent
        - countryOrRegion
        - deploymentId
        - deploymentUnit
        - deviceType
        - environment
        - hostingLocation
        - instanceName
      x-ms-enum:
        name: MetricsSegment
        modelAsString: true
  metricsTop:
    name: top
    in: query
    x-ms-parameter-location: method
    description: >-
      The number of segments to return.  This value is only valid when segment
      is specified.
    type: integer
    format: int32
  metricsOrderBy:
    name: orderby
    in: query
    x-ms-parameter-location: method
    description: >-
      The aggregation function and direction to sort the segments by.  This
      value is only valid when segment is specified.
    type: string
  metricsFilter:
    name: filter
    in: query
    x-ms-parameter-location: method
    description: >-
      An expression used to filter the results.  This value should be a valid
      OData filter expression where the keys of each clause should be applicable
      dimensions for the metric you are retrieving.
    type: string
  metricsPostBody:
    name: body
    description: The batched metrics query.
    in: body
    required: true
    schema:
      $ref: '#/definitions/metricsPostBody'
    x-ms-parameter-location: method
  eventType:
    name: eventType
    in: path
    required: true
    x-ms-parameter-location: method
    description: >-
      The type of events to query; either a standard event type (`traces`,
      `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`,
      `availabilityResults`) or `$all` to query across all event types.
    type: string
    enum:
      - $all
      - traces
      - customEvents
      - pageViews
      - browserTimings
      - requests
      - dependencies
      - exceptions
      - availabilityResults
      - performanceCounters
      - customMetrics
    x-ms-enum:
      name: EventType
      modelAsString: true
  eventId:
    name: eventId
    in: path
    required: true
    x-ms-parameter-location: method
    description: ID of event.
    type: string
  eventsTimespan:
    name: timespan
    in: query
    required: false
    x-ms-parameter-location: method
    description: >-
      Optional. The timespan over which to retrieve events. This is an ISO8601
      time period value.  This timespan is applied in addition to any that are
      specified in the Odata expression.
    type: string
  eventsFilter:
    name: $filter
    in: query
    required: false
    x-ms-parameter-location: method
    description: An expression used to filter the returned events
    type: string
  eventsSearch:
    name: $search
    in: query
    x-ms-parameter-location: method
    description: >-
      A free-text search expression to match for whether a particular event
      should be returned
    type: string
  eventsOrderBy:
    name: $orderby
    in: query
    x-ms-parameter-location: method
    description: >-
      A comma-separated list of properties with \"asc\" (the default) or
      \"desc\" to control the order of returned events
    type: string
  eventsSelect:
    name: $select
    in: query
    x-ms-parameter-location: method
    description: Limits the properties to just those requested on each returned event
    type: string
  eventsSkip:
    name: $skip
    in: query
    x-ms-parameter-location: method
    description: The number of items to skip over before returning events
    type: integer
    format: int32
  eventsTop:
    name: $top
    in: query
    x-ms-parameter-location: method
    description: The number of events to return
    type: integer
    format: int32
  eventsFormat:
    name: $format
    in: query
    x-ms-parameter-location: method
    description: Format for the returned events
    type: string
  eventsCount:
    name: $count
    in: query
    x-ms-parameter-location: method
    description: Request a count of matching items included with the returned events
    type: boolean
  eventsApply:
    name: $apply
    in: query
    x-ms-parameter-location: method
    description: An expression used for aggregation over returned events
    type: string
  applicationsParam:
    description: A list of applications over which to query.
    name: applications
    in: query
    collectionFormat: csv
    required: false
    default: ''
    x-ms-parameter-location: method
    type: string
  queryTimespan:
    name: timespan
    in: query
    required: false
    x-ms-parameter-location: method
    description: >-
      Optional. The timespan over which to query data. This is an ISO8601 time
      period value.  This timespan is applied in addition to any that are
      specified in the query expression.
    type: string
  queryParam:
    name: query
    in: query
    required: true
    x-ms-parameter-location: method
    description: >-
      The Analytics query. Learn more about the [Analytics query
      syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)
    type: string
  queryBody:
    name: body
    in: body
    description: >-
      The Analytics query. Learn more about the [Analytics query
      syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)
    required: true
    schema:
      $ref: '#/definitions/queryBody'
    x-ms-parameter-location: method
  apiVersion:
    name: apiVersion
    description: Client API version.
    in: query
    required: true
    type: string
    x-ms-parameter-location: method
  subscriptionId:
    name: subscriptionId
    description: >-
      Gets subscription credentials which uniquely identify Microsoft Azure
      subscription. The subscription ID forms part of the URI for every service
      call.
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
  resourceGroupName:
    name: resourceGroupName
    description: The name of the resource group to get. The name is case insensitive.
    in: path
    required: true
    type: string
    pattern: ^[-\w\._\(\)]+$
    minLength: 1
    maxLength: 90
    x-ms-parameter-location: method
  applicationName:
    name: applicationName
    description: Name of the Application Insights application.
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
definitions:
  metricId:
    description: >-
      ID of the metric. This is either a standard AI metric, or an
      application-specific custom metric.
    type: string
    enum:
      - requests/count
      - requests/duration
      - requests/failed
      - users/count
      - users/authenticated
      - pageViews/count
      - pageViews/duration
      - client/processingDuration
      - client/receiveDuration
      - client/networkDuration
      - client/sendDuration
      - client/totalDuration
      - dependencies/count
      - dependencies/failed
      - dependencies/duration
      - exceptions/count
      - exceptions/browser
      - exceptions/server
      - sessions/count
      - performanceCounters/requestExecutionTime
      - performanceCounters/requestsPerSecond
      - performanceCounters/requestsInQueue
      - performanceCounters/memoryAvailableBytes
      - performanceCounters/exceptionsPerSecond
      - performanceCounters/processCpuPercentage
      - performanceCounters/processIOBytesPerSecond
      - performanceCounters/processPrivateBytes
      - performanceCounters/processorCpuPercentage
      - availabilityResults/availabilityPercentage
      - availabilityResults/duration
      - billing/telemetryCount
      - customEvents/count
    x-ms-enum:
      name: MetricId
      modelAsString: true
  metricsTimespan:
    description: >-
      The timespan over which to retrieve metric values. This is an ISO8601 time
      period value. If timespan is omitted, a default time range of `PT12H`
      ("last 12 hours") is used. The actual timespan that is queried may be
      adjusted by the server based. In all cases, the actual time span used for
      the query is included in the response.
    type: string
  metricsAggregation:
    description: >-
      The aggregation to use when computing the metric values. To retrieve more
      than one aggregation at a time, separate them with a comma. If no
      aggregation is specified, then the default aggregation for the metric is
      used.
    type: array
    minItems: 1
    items:
      type: string
      enum:
        - min
        - max
        - avg
        - sum
        - count
        - unique
      x-ms-enum:
        name: MetricsAggregation
        modelAsString: true
  metricsInterval:
    description: >-
      The time interval to use when retrieving metric values. This is an ISO8601
      duration. If interval is omitted, the metric value is aggregated across
      the entire timespan. If interval is supplied, the server may adjust the
      interval to a more appropriate size based on the timespan used for the
      query. In all cases, the actual interval used for the query is included in
      the response.
    type: string
    format: duration
  metricsSegment:
    description: >-
      The name of the dimension to segment the metric values by. This dimension
      must be applicable to the metric you are retrieving. To segment by more
      than one dimension at a time, separate them with a comma (,). In this
      case, the metric data will be segmented in the order the dimensions are
      listed in the parameter.
    type: array
    minItems: 1
    items:
      type: string
      enum:
        - applicationBuild
        - applicationVersion
        - authenticatedOrAnonymousTraffic
        - browser
        - browserVersion
        - city
        - cloudRoleName
        - cloudServiceName
        - continent
        - countryOrRegion
        - deploymentId
        - deploymentUnit
        - deviceType
        - environment
        - hostingLocation
        - instanceName
      x-ms-enum:
        name: MetricsSegment
        modelAsString: true
  metricsTop:
    description: >-
      The number of segments to return.  This value is only valid when segment
      is specified.
    type: integer
    format: int32
  metricsOrderBy:
    description: >-
      The aggregation function and direction to sort the segments by.  This
      value is only valid when segment is specified.
    type: string
  metricsFilter:
    description: >-
      An expression used to filter the results.  This value should be a valid
      OData filter expression where the keys of each clause should be applicable
      dimensions for the metric you are retrieving.
    type: string
  metricsPostBody:
    description: Metrics request body
    type: array
    items:
      $ref: '#/definitions/metricsPostBodySchema'
  metricsPostBodySchema:
    description: A metric request
    properties:
      id:
        type: string
        description: >-
          An identifier for this query.  Must be unique within the post body of
          the request.  This identifier will be the 'id' property of the
          response object representing this query.
      parameters:
        type: object
        description: The parameters for a single metrics query
        properties:
          metricId:
            $ref: '#/definitions/metricId'
          timespan:
            $ref: '#/definitions/metricsTimespan'
          aggregation:
            $ref: '#/definitions/metricsAggregation'
          interval:
            $ref: '#/definitions/metricsInterval'
          segment:
            $ref: '#/definitions/metricsSegment'
          top:
            $ref: '#/definitions/metricsTop'
          orderby:
            $ref: '#/definitions/metricsOrderBy'
          filter:
            $ref: '#/definitions/metricsFilter'
        required:
          - metricId
    required:
      - id
      - parameters
  metricsResults:
    description: A set of metric results.
    type: array
    items:
      properties:
        id:
          description: The specified ID for this metric.
          type: string
        status:
          description: The HTTP status code of this metric query.
          type: integer
          format: int32
        body:
          description: The results of this metric query.
          $ref: '#/definitions/metricsResult'
      required:
        - id
        - status
        - body
  metricsResult:
    description: A metric result.
    properties:
      value:
        $ref: '#/definitions/metricsResultInfo'
  metricsResultInfo:
    description: A metric result data.
    type: object
    properties:
      start:
        description: Start time of the metric.
        type: string
        format: date_time
      end:
        description: Start time of the metric.
        type: string
        format: date_time
      interval:
        description: The interval used to segment the metric data.
        type: string
        format: duration
      segments:
        description: Segmented metric data (if segmented).
        type: array
        items:
          $ref: '#/definitions/metricsSegmentInfo'
    additionalProperties:
      description: Additional properties that can be provided on the metric result info
      type: object
  metricsSegmentInfo:
    description: A metric segment
    type: object
    properties:
      start:
        description: >-
          Start time of the metric segment (only when an interval was
          specified).
        type: string
        format: date_time
      end:
        description: >-
          Start time of the metric segment (only when an interval was
          specified).
        type: string
        format: date_time
      segments:
        description: Segmented metric data (if further segmented).
        type: array
        items:
          $ref: '#/definitions/metricsSegmentInfo'
    additionalProperties: true
  eventType:
    description: >-
      The type of events to query; either a standard event type (`traces`,
      `customEvents`, `pageViews`, `requests`, `dependencies`, `exceptions`,
      `availabilityResults`) or `$all` to query across all event types.
    type: string
    enum:
      - $all
      - traces
      - customEvents
      - pageViews
      - browserTimings
      - requests
      - dependencies
      - exceptions
      - availabilityResults
      - performanceCounters
      - customMetrics
    x-ms-enum:
      name: EventType
      modelAsString: true
  eventId:
    description: ID of event.
    type: string
  eventsTimespan:
    description: >-
      Optional. The timespan over which to retrieve events. This is an ISO8601
      time period value.  This timespan is applied in addition to any that are
      specified in the Odata expression.
    type: string
  eventsFilter:
    description: An expression used to filter the returned events
    type: string
  eventsSearch:
    description: >-
      A free-text search expression to match for whether a particular event
      should be returned
    type: string
  eventsOrderBy:
    description: >-
      A comma-separated list of properties with \"asc\" (the default) or
      \"desc\" to control the order of returned events
    type: string
  eventsSelect:
    description: Limits the properties to just those requested on each returned event
    type: string
  eventsSkip:
    description: The number of items to skip over before returning events
    type: integer
    format: int32
  eventsTop:
    description: The number of events to return
    type: integer
    format: int32
  eventsFormat:
    description: Format for the returned events
    type: string
  eventsCount:
    description: Request a count of matching items included with the returned events
    type: boolean
  eventsApply:
    description: An expression used for aggregation over returned events
    type: string
  eventsResults:
    description: An events query result.
    type: object
    properties:
      '@odata.context':
        description: OData context metadata endpoint for this response
        type: string
      '@ai.messages':
        description: OData messages for this response.
        type: array
        items:
          $ref: '#/definitions/errorInfo'
      value:
        description: Contents of the events query result.
        type: array
        items:
          $ref: '#/definitions/eventsResultData'
  eventsResult:
    description: An event query result.
    type: object
    properties:
      '@ai.messages':
        description: OData messages for this response.
        type: array
        items:
          $ref: '#/definitions/errorInfo'
      value:
        $ref: '#/definitions/eventsResultData'
  eventsResultData:
    description: Events query result data.
    type: object
    discriminator: type
    properties:
      id:
        description: The unique ID for this event.
        type: string
      type:
        description: The type of event.
        $ref: '#/definitions/eventType'
      count:
        description: Count of the event
        type: integer
        format: int64
      timestamp:
        description: Timestamp of the event
        type: string
        format: date-time
      customDimensions:
        description: Custom dimensions of the event
        type: object
        properties:
          additionalProperties:
            type: object
        additionalProperties:
          type: object
      customMeasurements:
        description: Custom measurements of the event
        type: object
        properties:
          additionalProperties:
            type: object
        additionalProperties:
          type: object
      operation:
        description: Operation info of the event
        $ref: '#/definitions/eventsOperationInfo'
      session:
        description: Session info of the event
        $ref: '#/definitions/eventsSessionInfo'
      user:
        description: User info of the event
        $ref: '#/definitions/eventsUserInfo'
      cloud:
        description: Cloud info of the event
        $ref: '#/definitions/eventsCloudInfo'
      ai:
        description: AI info of the event
        $ref: '#/definitions/eventsAiInfo'
      application:
        description: Application info of the event
        $ref: '#/definitions/eventsApplicationInfo'
      client:
        description: Client info of the event
        $ref: '#/definitions/eventsClientInfo'
    required:
      - type
  eventsTraceResult:
    x-ms-discriminator-value: trace
    description: A trace result
    allOf:
      - $ref: '#/definitions/eventsResultData'
      - type: object
        properties:
          trace:
            $ref: '#/definitio

# --- truncated at 32 KB (56 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/application-insights-data-plane-openapi-original.yml