Events - Get

Get an event
Gets the data for a single event

GET https://api.applicationinsights.io/v1/apps/{appId}/events/{eventType}/{eventId}
GET https://api.applicationinsights.io/v1/apps/{appId}/events/{eventType}/{eventId}?timespan={timespan}

URI Parameters

Name In Required Type Description
appId
path True

string

ID of the application. This is Application ID from the API Access settings blade in the Azure portal.

eventId
path True

string

ID of event.

eventType
path True

EventType

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.

timespan
query

string

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.

Responses

Name Type Description
200 OK

eventsResults

Successful response

Other Status Codes

errorResponse

An error response object.

Security

oauth2

Connect to Azure Application Insights API

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https%3A%2F%2Fapi.applicationinsights.io

Scopes

Name Description
user_impersonation impersonate your user account

Examples

eventById

Sample request

GET https://api.applicationinsights.io/v1/apps/DEMO_APP/events/traces/dc76df01-0141-11e8-9894-e3e7c1eeabad

Sample response

{
  "@odata.context": "https://api.applicationinsights.io/v1/apps/DEMO_APP/events/traces/$metadata#traces",
  "value": [
    {
      "id": "dc76df01-0141-11e8-9894-e3e7c1eeabad",
      "type": "trace",
      "count": 1,
      "timestamp": "2018-01-24T20:04:32.243Z",
      "customDimensions": null,
      "customMeasurements": null,
      "operation": {
        "name": "GET /FabrikamProd/Employees/Create",
        "id": "HPFy1bNlyQ0=",
        "parentId": "|HPFy1bNlyQ0=.c642e1f1_",
        "syntheticSource": "Application Insights Availability Monitoring"
      },
      "session": {
        "id": "97915c9e-2ba3-4258-82f5-84233de21127"
      },
      "user": {
        "id": "emea-ru-msa-edge_97915c9e-2ba3-4258-82f5-84233de21127",
        "accountId": null,
        "authenticatedId": null
      },
      "cloud": {
        "roleName": null,
        "roleInstance": "AIConnect2"
      },
      "ai": {
        "iKey": "5a2e4e0c-e136-4a15-9824-90ba859b0a89",
        "appName": "fabrikamprod",
        "appId": "cf58dcfd-0683-487c-bc84-048789bca8e5",
        "sdkVersion": "sd:2.4.1-442"
      },
      "trace": {
        "message": "New Request Received",
        "severityLevel": 0
      },
      "application": {
        "version": null
      },
      "client": {
        "model": null,
        "os": null,
        "type": "PC",
        "browser": null,
        "ip": "51.140.105.0",
        "city": "London",
        "stateOrProvince": "England",
        "countryOrRegion": "United Kingdom"
      }
    }
  ]
}

Definitions

Name Description
CustomDimensions

Custom dimensions of the event

CustomMeasurements

Custom measurements of the event

errorDetail

Error details.

errorInfo

The code and message for an error.

errorResponse

Error details.

eventsAiInfo

AI related application info for an event result

eventsApplicationInfo

Application info for an event result

eventsAvailabilityResultInfo

The availability result info

eventsAvailabilityResultResult

An availability result result

eventsBrowserTimingInfo

The browser timing information

eventsBrowserTimingResult

A browser timing result

eventsClientInfo

Client info for an event result

eventsClientPerformanceInfo

Client performance information

eventsCloudInfo

Cloud info for an event result

eventsCustomEventInfo

The custom event information

eventsCustomEventResult

A custom event result

eventsCustomMetricInfo

The custom metric info

eventsCustomMetricResult

A custom metric result

eventsDependencyInfo

The dependency info

eventsDependencyResult

A dependency result

eventsExceptionDetail

Exception details

eventsExceptionDetailsParsedStack

A parsed stack entry

eventsExceptionInfo

The exception info

eventsExceptionResult

An exception result

eventsOperationInfo

Operation info for an event result

eventsPageViewInfo

The page view information

eventsPageViewResult

A page view result

eventsPerformanceCounterInfo

The performance counter info

eventsPerformanceCounterResult

A performance counter result

eventsRequestInfo

The request info

eventsRequestResult

A request result

eventsResults

An events query result.

eventsSessionInfo

Session info for an event result

eventsTraceInfo

The trace information

eventsTraceResult

A trace result

eventsUserInfo

User info for an event result

EventType

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.

CustomDimensions

Custom dimensions of the event

Name Type Description
additionalProperties

object

CustomMeasurements

Custom measurements of the event

Name Type Description
additionalProperties

object

errorDetail

Error details.

Name Type Description
additionalProperties

object

code

string

The error's code.

message

string

A human readable error message.

resources

string[]

Indicates resources which were responsible for the error.

target

string

Indicates which property in the request is responsible for the error.

value

string

Indicates which value in 'target' is responsible for the error.

errorInfo

The code and message for an error.

Name Type Description
additionalProperties

object

code

string

A machine readable error code.

details

errorDetail[]

error details.

innererror

errorInfo

The code and message for an error.
Inner error details if they exist.

message

string

A human readable error message.

errorResponse

Error details.

Name Type Description
error

errorInfo

The code and message for an error.
The error details.

eventsAiInfo

AI related application info for an event result

Name Type Description
appId

string

ID of the application

appName

string

Name of the application

iKey

string

iKey of the app

sdkVersion

string

SDK version of the application

eventsApplicationInfo

Application info for an event result

Name Type Description
version

string

Version of the application

eventsAvailabilityResultInfo

The availability result info

Name Type Description
duration

integer

The duration of the availability result

id

string

The ID of the availability result

location

string

The location of the availability result

message

string

The message of the availability result

name

string

The name of the availability result

performanceBucket

string

The performance bucket of the availability result

size

string

The size of the availability result

success

string

Indicates if the availability result was successful

eventsAvailabilityResultResult

An availability result result

Name Type Description
ai

eventsAiInfo

AI info of the event

application

eventsApplicationInfo

Application info of the event

availabilityResult

eventsAvailabilityResultInfo

The availability result info

client

eventsClientInfo

Client info of the event

cloud

eventsCloudInfo

Cloud info of the event

count

integer

Count of the event

customDimensions

CustomDimensions

Custom dimensions of the event

customMeasurements

CustomMeasurements

Custom measurements of the event

id

string

The unique ID for this event.

operation

eventsOperationInfo

Operation info of the event

session

eventsSessionInfo

Session info of the event

timestamp

string

Timestamp of the event

type string:

availabilityResult

The type of event.

user

eventsUserInfo

User info of the event

eventsBrowserTimingInfo

The browser timing information

Name Type Description
name

string

The name of the page

networkDuration

integer

The network duration of the load

performanceBucket

string

The performance bucket of the load

processingDuration

integer

The processing duration of the load

receiveDuration

integer

The receive duration of the load

sendDuration

integer

The send duration of the load

totalDuration

integer

The total duration of the load

url

string

The url of the page

urlHost

string

The host of the URL

urlPath

string

The path of the URL

eventsBrowserTimingResult

A browser timing result

Name Type Description
ai

eventsAiInfo

AI info of the event

application

eventsApplicationInfo

Application info of the event

browserTiming

eventsBrowserTimingInfo

The browser timing information

client

eventsClientInfo

Client info of the event

clientPerformance

eventsClientPerformanceInfo

Client performance information

cloud

eventsCloudInfo

Cloud info of the event

count

integer

Count of the event

customDimensions

CustomDimensions

Custom dimensions of the event

customMeasurements

CustomMeasurements

Custom measurements of the event

id

string

The unique ID for this event.

operation

eventsOperationInfo

Operation info of the event

session

eventsSessionInfo

Session info of the event

timestamp

string

Timestamp of the event

type string:

browserTiming

The type of event.

user

eventsUserInfo

User info of the event

eventsClientInfo

Client info for an event result

Name Type Description
browser

string

Browser of the client

city

string

City of the client

countryOrRegion

string

Country or region of the client

ip

string

IP address of the client

model

string

Model of the client

os

string

Operating system of the client

stateOrProvince

string

State or province of the client

type

string

Type of the client

eventsClientPerformanceInfo

Client performance information

Name Type Description
name

string

The name of the client performance

eventsCloudInfo

Cloud info for an event result

Name Type Description
roleInstance

string

Role instance of the cloud

roleName

string

Role name of the cloud

eventsCustomEventInfo

The custom event information

Name Type Description
name

string

The name of the custom event

eventsCustomEventResult

A custom event result

Name Type Description
ai

eventsAiInfo

AI info of the event

application

eventsApplicationInfo

Application info of the event

client

eventsClientInfo

Client info of the event

cloud

eventsCloudInfo

Cloud info of the event

count

integer

Count of the event

customDimensions

CustomDimensions

Custom dimensions of the event

customEvent

eventsCustomEventInfo

The custom event information

customMeasurements

CustomMeasurements

Custom measurements of the event

id

string

The unique ID for this event.

operation

eventsOperationInfo

Operation info of the event

session

eventsSessionInfo

Session info of the event

timestamp

string

Timestamp of the event

type string:

customEvent

The type of event.

user

eventsUserInfo

User info of the event

eventsCustomMetricInfo

The custom metric info

Name Type Description
name

string

The name of the custom metric

value

number

The value of the custom metric

valueCount

integer

The count of the custom metric

valueMax

number

The maximum value of the custom metric

valueMin

number

The minimum value of the custom metric

valueStdDev

number

The standard deviation of the custom metric

valueSum

number

The sum of the custom metric

eventsCustomMetricResult

A custom metric result

Name Type Description
ai

eventsAiInfo

AI info of the event

application

eventsApplicationInfo

Application info of the event

client

eventsClientInfo

Client info of the event

cloud

eventsCloudInfo

Cloud info of the event

count

integer

Count of the event

customDimensions

CustomDimensions

Custom dimensions of the event

customMeasurements

CustomMeasurements

Custom measurements of the event

customMetric

eventsCustomMetricInfo

The custom metric info

id

string

The unique ID for this event.

operation

eventsOperationInfo

Operation info of the event

session

eventsSessionInfo

Session info of the event

timestamp

string

Timestamp of the event

type string:

customMetric

The type of event.

user

eventsUserInfo

User info of the event

eventsDependencyInfo

The dependency info

Name Type Description
data

string

The data of the dependency

duration

integer

The duration of the dependency

id

string

The ID of the dependency

name

string

The name of the dependency

performanceBucket

string

The performance bucket of the dependency

resultCode

string

The result code of the dependency

success

string

Indicates if the dependency was successful

target

string

The target of the dependency

type

string

The type of the dependency

eventsDependencyResult

A dependency result

Name Type Description
ai

eventsAiInfo

AI info of the event

application

eventsApplicationInfo

Application info of the event

client

eventsClientInfo

Client info of the event

cloud

eventsCloudInfo

Cloud info of the event

count

integer

Count of the event

customDimensions

CustomDimensions

Custom dimensions of the event

customMeasurements

CustomMeasurements

Custom measurements of the event

dependency

eventsDependencyInfo

The dependency info

id

string

The unique ID for this event.

operation

eventsOperationInfo

Operation info of the event

session

eventsSessionInfo

Session info of the event

timestamp

string

Timestamp of the event

type string:

dependency

The type of event.

user

eventsUserInfo

User info of the event

eventsExceptionDetail

Exception details

Name Type Description
id

string

The ID of the exception detail

message

string

The message of the exception detail

outerId

string

The outer ID of the exception detail

parsedStack

eventsExceptionDetailsParsedStack[]

The parsed stack

severityLevel

string

The severity level of the exception detail

type

string

The type of the exception detail

eventsExceptionDetailsParsedStack

A parsed stack entry

Name Type Description
assembly

string

The assembly of the stack entry

level

integer

The level of the stack entry

line

integer

The line of the stack entry

method

string

The method of the stack entry

eventsExceptionInfo

The exception info

Name Type Description
assembly

string

The assembly which threw the exception

details

eventsExceptionDetail[]

The details of the exception

handledAt

string

Indicates where the exception was handled at

innermostAssembly

string

The inner most assembly of the exception

innermostMessage

string

The inner most message of the exception

innermostMethod

string

The inner most method of the exception

innermostType

string

The inner most type of the exception

message

string

The message of the exception

method

string

The method that threw the exception

outerAssembly

string

The outer assembly of the exception

outerMessage

string

The outer message of the exception

outerMethod

string

The outer method of the exception

outerType

string

The outer type of the exception

problemId

string

The problem ID of the exception

severityLevel

integer

The severity level of the exception

type

string

The type of the exception

eventsExceptionResult

An exception result

Name Type Description
ai

eventsAiInfo

AI info of the event

application

eventsApplicationInfo

Application info of the event

client

eventsClientInfo

Client info of the event

cloud

eventsCloudInfo

Cloud info of the event

count

integer

Count of the event

customDimensions

CustomDimensions

Custom dimensions of the event

customMeasurements

CustomMeasurements

Custom measurements of the event

exception

eventsExceptionInfo

The exception info

id

string

The unique ID for this event.

operation

eventsOperationInfo

Operation info of the event

session

eventsSessionInfo

Session info of the event

timestamp

string

Timestamp of the event

type string:

exception

The type of event.

user

eventsUserInfo

User info of the event

eventsOperationInfo

Operation info for an event result

Name Type Description
id

string

ID of the operation

name

string

Name of the operation

parentId

string

Parent ID of the operation

syntheticSource

string

Synthetic source of the operation

eventsPageViewInfo

The page view information

Name Type Description
duration

string

The duration of the page view

name

string

The name of the page

performanceBucket

string

The performance bucket of the page view

url

string

The URL of the page

eventsPageViewResult

A page view result

Name Type Description
ai

eventsAiInfo

AI info of the event

application

eventsApplicationInfo

Application info of the event

client

eventsClientInfo

Client info of the event

cloud

eventsCloudInfo

Cloud info of the event

count

integer

Count of the event

customDimensions

CustomDimensions

Custom dimensions of the event

customMeasurements

CustomMeasurements

Custom measurements of the event

id

string

The unique ID for this event.

operation

eventsOperationInfo

Operation info of the event

pageView

eventsPageViewInfo

The page view information

session

eventsSessionInfo

Session info of the event

timestamp

string

Timestamp of the event

type string:

pageView

The type of event.

user

eventsUserInfo

User info of the event

eventsPerformanceCounterInfo

The performance counter info

Name Type Description
category

string

The category of the performance counter

counter

string

The counter of the performance counter

instance

string

The instance of the performance counter

instanceName

string

The instance name of the performance counter

name

string

The name of the performance counter

value

number

The value of the performance counter

eventsPerformanceCounterResult

A performance counter result

Name Type Description
ai

eventsAiInfo

AI info of the event

application

eventsApplicationInfo

Application info of the event

client

eventsClientInfo

Client info of the event

cloud

eventsCloudInfo

Cloud info of the event

count

integer

Count of the event

customDimensions

CustomDimensions

Custom dimensions of the event

customMeasurements

CustomMeasurements

Custom measurements of the event

id

string

The unique ID for this event.

operation

eventsOperationInfo

Operation info of the event

performanceCounter

eventsPerformanceCounterInfo

The performance counter info

session

eventsSessionInfo

Session info of the event

timestamp

string

Timestamp of the event

type string:

performanceCounter

The type of event.

user

eventsUserInfo

User info of the event

eventsRequestInfo

The request info

Name Type Description
duration

number

The duration of the request

id

string

The ID of the request

name

string

The name of the request

performanceBucket

string

The performance bucket of the request

resultCode

string

The result code of the request

source

string

The source of the request

success

string

Indicates if the request was successful

url

string

The URL of the request

eventsRequestResult

A request result

Name Type Description
ai

eventsAiInfo

AI info of the event

application

eventsApplicationInfo

Application info of the event

client

eventsClientInfo

Client info of the event

cloud

eventsCloudInfo

Cloud info of the event

count

integer

Count of the event

customDimensions

CustomDimensions

Custom dimensions of the event

customMeasurements

CustomMeasurements

Custom measurements of the event

id

string

The unique ID for this event.

operation

eventsOperationInfo

Operation info of the event

request

eventsRequestInfo

The request info

session

eventsSessionInfo

Session info of the event

timestamp

string

Timestamp of the event

type string:

request

The type of event.

user

eventsUserInfo

User info of the event

eventsResults

An events query result.

Name Type Description
@ai.messages

errorInfo[]

OData messages for this response.

@odata.context

string

OData context metadata endpoint for this response

value eventsResultData[]:

Contents of the events query result.

eventsSessionInfo

Session info for an event result

Name Type Description
id

string

ID of the session

eventsTraceInfo

The trace information

Name Type Description
message

string

The trace message

severityLevel

integer

The trace severity level

eventsTraceResult

A trace result

Name Type Description
ai

eventsAiInfo

AI info of the event

application

eventsApplicationInfo

Application info of the event

client

eventsClientInfo

Client info of the event

cloud

eventsCloudInfo

Cloud info of the event

count

integer

Count of the event

customDimensions

CustomDimensions

Custom dimensions of the event

customMeasurements

CustomMeasurements

Custom measurements of the event

id

string

The unique ID for this event.

operation

eventsOperationInfo

Operation info of the event

session

eventsSessionInfo

Session info of the event

timestamp

string

Timestamp of the event

trace

eventsTraceInfo

The trace information

type string:

trace

The type of event.

user

eventsUserInfo

User info of the event

eventsUserInfo

User info for an event result

Name Type Description
accountId

string

Account ID of the user

authenticatedId

string

Authenticated ID of the user

id

string

ID of the user

EventType

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.

Name Type Description
$all

string

availabilityResults

string

browserTimings

string

customEvents

string

customMetrics

string

dependencies

string

exceptions

string

pageViews

string

performanceCounters

string

requests

string

traces

string