From 3c0bc16f788086e207b436c3eb28860e6c539f2b Mon Sep 17 00:00:00 2001 From: Chris Suich Date: Fri, 8 Dec 2017 07:26:05 -0500 Subject: [PATCH 1/6] Adding initial AI Data Plane --- .../microsoft.insights/v1/AppInsights.json | 1979 +++++++++++++++++ .../v1/examples/ai-get-metric-example.json | 39 + .../applicationinsights/data-plane/readme.md | 60 + 3 files changed, 2078 insertions(+) create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/ai-get-metric-example.json create mode 100644 specification/applicationinsights/data-plane/readme.md diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json new file mode 100644 index 000000000000..1731a322a72d --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json @@ -0,0 +1,1979 @@ +{ + "swagger": "2.0", + "info": { + "version": "v1", + "title": "AI public API", + "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": "aiapi@microsoft.com" + }, + "license": { + "name": "Microsoft", + "url": "https://dev.applicationinsights.io/license" + } + }, + "host": "api.applicationinsights.io", + "basePath": "/v1", + "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": { + "/apps/{app-id}/metrics/{metric-id}": { + "get": { + "operationId": "GetMetric", + "summary": "Retrieve metric data", + "description": "Gets metric values for a single metric", + "x-ms-examples": { + "simpleMetric": { + "$ref": "examples/ai-get-metric-example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/app-id" + }, + { + "$ref": "#/parameters/metric-id" + }, + { + "$ref": "#/parameters/metrics-timespan" + }, + { + "$ref": "#/parameters/metrics-interval" + }, + { + "$ref": "#/parameters/metrics-aggregation" + }, + { + "$ref": "#/parameters/metrics-segment" + }, + { + "$ref": "#/parameters/metrics-top" + }, + { + "$ref": "#/parameters/metrics-orderBy" + }, + { + "$ref": "#/parameters/metrics-filter" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/metrics-result" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/error-response" + } + } + } + } + }, + "/apps/{app-id}/metrics": { + "post": { + "operationId": "GetMetrics", + "summary": "Retrieve metric data", + "description": "Gets metric values for multiple metrics", + "parameters": [ + { + "$ref": "#/parameters/app-id" + }, + { + "$ref": "#/parameters/metrics-post-body" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/metrics-results" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/error-response" + } + } + } + } + }, + "/apps/{app-id}/metrics/metadata": { + "get": { + "operationId": "GetMetricsMetadata", + "summary": "Retrieve metric metatadata", + "description": "Gets metadata describing the available metrics", + "parameters": [ + { + "$ref": "#/parameters/app-id" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/error-response" + } + } + } + } + }, + "/apps/{app-id}/events/{event-type}": { + "get": { + "operationId": "GetEvents", + "summary": "Execute OData query", + "description": "Executes an OData query for events", + "parameters": [ + { + "$ref": "#/parameters/app-id" + }, + { + "$ref": "#/parameters/event-type" + }, + { + "$ref": "#/parameters/events-timespan" + }, + { + "$ref": "#/parameters/events-filter" + }, + { + "$ref": "#/parameters/events-search" + }, + { + "$ref": "#/parameters/events-orderby" + }, + { + "$ref": "#/parameters/events-select" + }, + { + "$ref": "#/parameters/events-skip" + }, + { + "$ref": "#/parameters/events-top" + }, + { + "$ref": "#/parameters/events-format" + }, + { + "$ref": "#/parameters/events-count" + }, + { + "$ref": "#/parameters/events-apply" + } + ], + "produces": [ + "application/json;odata=none", + "application/json;odata=minimal", + "application/json;odata=full" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/events-results" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/error-response" + } + } + } + } + }, + "/apps/{app-id}/events/{event-type}/{event-id}": { + "get": { + "operationId": "GetEvent", + "summary": "Get an event", + "description": "Gets the data for a single event", + "parameters": [ + { + "$ref": "#/parameters/app-id" + }, + { + "$ref": "#/parameters/event-type" + }, + { + "$ref": "#/parameters/events-timespan" + }, + { + "$ref": "#/parameters/event-id" + } + ], + "produces": [ + "application/json", + "application/json;odata=none", + "application/json;odata=minimal", + "application/json;odata=full" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/events-results" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/error-response" + } + } + } + } + }, + "/apps/{app-id}/events/$metadata": { + "get": { + "operationId": "GetEventsMetadataOData", + "summary": "Get OData metadata", + "description": "Gets OData EDMX metadata describing the event data model", + "parameters": [ + { + "$ref": "#/parameters/app-id" + } + ], + "produces": [ + "application/xml;charset=utf-8" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/error-response" + } + } + } + } + }, + "/apps/{app-id}/query": { + "get": { + "operationId": "GetQuery", + "summary": "Execute an Analytics query", + "description": "Executes an Analytics query for data", + "parameters": [ + { + "$ref": "#/parameters/app-id" + }, + { + "$ref": "#/parameters/query-param" + }, + { + "$ref": "#/parameters/query-timespan" + }, + { + "$ref": "#/parameters/applications-param" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/query-results" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/error-response" + } + } + } + }, + "post": { + "operationId": "Query", + "summary": "Execute an Analytics query", + "description": "Executes an Analytics query for data. [Here](/documentation/2-Using-the-API/Query) is an example for using POST with an Analytics query.", + "parameters": [ + { + "$ref": "#/parameters/app-id" + }, + { + "$ref": "#/parameters/query-body" + }, + { + "$ref": "#/parameters/query-timespan" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/query-results" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/error-response" + } + } + } + } + }, + "/apps/{app-id}/query/schema": { + "get": { + "operationId": "GetQuerySchema", + "summary": "Get Analytics query metadata", + "description": "Gets Analytics query schema describing the data model", + "parameters": [ + { + "$ref": "#/parameters/app-id" + } + ], + "responses": { + "200": { + "description": "Successful responses", + "schema": { + "type": "object" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/error-response" + } + } + } + } + } + }, + "parameters": { + "app-id": { + "name": "app-id", + "description": "ID of the application. This is Application ID from the API Access settings blade in the Azure portal.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "metric-id": { + "name": "metric-id", + "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" + ] + }, + "metrics-timespan": { + "name": "timespan", + "in": "query", + "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", + "default": "PT12H" + }, + "metrics-aggregation": { + "name": "aggregation", + "in": "query", + "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", + "default": "PT12H" + }, + "metrics-interval": { + "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" + }, + "metrics-segment": { + "name": "segment", + "in": "query", + "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, + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "applicationBuild", + "applicationVersion", + "authenticatedOrAnonymousTraffic", + "browser", + "browserVersion", + "city", + "cloudRoleName", + "cloudServiceName", + "continent", + "countryOrRegion", + "deploymentId", + "deploymentUnit", + "deviceType", + "environment", + "hostingLocation", + "instanceName" + ] + } + }, + "metrics-top": { + "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" + }, + "metrics-orderBy": { + "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" + }, + "metrics-filter": { + "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" + }, + "metrics-post-body": { + "name": "body", + "description": "The batched metrics query.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/metrics-post-body" + }, + "x-ms-parameter-location": "method" + }, + "event-type": { + "name": "event-type", + "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": false + } + }, + "event-id": { + "name": "event-id", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "description": "ID of event.", + "type": "string", + "format": "uuid" + }, + "events-timespan": { + "name": "timespan", + "in": "query", + "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" + }, + "events-filter": { + "name": "$filter", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "description": "An expression used to filter the returned events", + "type": "string" + }, + "events-search": { + "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" + }, + "events-orderby": { + "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" + }, + "events-select": { + "name": "$select", + "in": "query", + "x-ms-parameter-location": "method", + "description": "Limits the properties to just those requested on each returned event", + "type": "string" + }, + "events-skip": { + "name": "$skip", + "in": "query", + "x-ms-parameter-location": "method", + "description": "The number of items to skip over before returning events", + "type": "integer", + "format": "int32" + }, + "events-top": { + "name": "$top", + "in": "query", + "x-ms-parameter-location": "method", + "description": "The number of events to return", + "type": "integer", + "format": "int32" + }, + "events-format": { + "name": "$format", + "in": "query", + "x-ms-parameter-location": "method", + "description": "Format for the returned events", + "type": "string" + }, + "events-count": { + "name": "$count", + "in": "query", + "x-ms-parameter-location": "method", + "description": "Request a count of matching items included with the returned events", + "type": "boolean" + }, + "events-apply": { + "name": "$apply", + "in": "query", + "x-ms-parameter-location": "method", + "description": "An expression used for aggregation over returned events", + "type": "string" + }, + "applications-param": { + "name": "applications", + "in": "query", + "required": false, + "description": "Application IDs to include in cross-application queries.", + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + "query-timespan": { + "name": "timespan", + "in": "query", + "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" + }, + "query-param": { + "name": "query", + "in": "query", + "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" + }, + "query-body": { + "name": "body", + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "in": "body", + "schema": { + "$ref": "#/definitions/query-body" + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "metric-id": { + "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" + ] + }, + "metrics-timespan": { + "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", + "default": "PT12H" + }, + "metrics-aggregation": { + "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", + "collectionFormat": "csv", + "minItems": 1, + "items": { + "type": "string", + "enum": [ + "min", + "max", + "avg", + "sum" + ] + } + }, + "metrics-interval": { + "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" + }, + "metrics-segment": { + "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, + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "applicationBuild", + "applicationVersion", + "authenticatedOrAnonymousTraffic", + "browser", + "browserVersion", + "city", + "cloudRoleName", + "cloudServiceName", + "continent", + "countryOrRegion", + "deploymentId", + "deploymentUnit", + "deviceType", + "environment", + "hostingLocation", + "instanceName" + ] + } + }, + "metrics-top": { + "description": "The number of segments to return. This value is only valid when segment is specified.", + "type": "integer", + "format": "int32" + }, + "metrics-orderBy": { + "description": "The aggregation function and direction to sort the segments by. This value is only valid when segment is specified.", + "type": "string" + }, + "metrics-filter": { + "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" + }, + "metrics-post-body": { + "description": "Metrics request body", + "type": "array", + "items": { + "$ref": "#/definitions/metrics-post-body-schema" + } + }, + "metrics-post-body-schema": { + "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/metric-id" + }, + "timespan": { + "$ref": "#/definitions/metrics-timespan" + }, + "aggregation": { + "$ref": "#/definitions/metrics-aggregation" + }, + "interval": { + "$ref": "#/definitions/metrics-interval" + }, + "segment": { + "$ref": "#/definitions/metrics-segment" + }, + "top": { + "$ref": "#/definitions/metrics-top" + }, + "orderby": { + "$ref": "#/definitions/metrics-orderBy" + }, + "filter": { + "$ref": "#/definitions/metrics-filter" + } + }, + "required": [ + "metricId" + ] + } + }, + "required": [ + "id", + "parameters" + ] + }, + "metrics-results": { + "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/metrics-result" + } + }, + "required": [ + "id", + "status", + "body" + ] + } + }, + "metrics-result": { + "description": "A metric result.", + "properties": { + "value": { + "$ref": "#/definitions/metrics-result-info" + } + } + }, + "metrics-result-info": { + "description": "A metric result data.", + "type": "object", + "properties": { + "start": { + "description": "Start time of the metric.", + "type": "string" + }, + "end": { + "description": "Start time of the metric.", + "type": "string" + }, + "interval": { + "description": "The interval used to segment the metric data.", + "type": "string" + }, + "segments": { + "description": "Segmented metric data (if segmented).", + "type": "array", + "items": { + "$ref": "#/definitions/metrics-segment-info" + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "metrics-segment-info": { + "description": "A metric segment", + "type": "object", + "properties": { + "start": { + "description": "Start time of the metric segment (only when an interval was specified).", + "type": "string" + }, + "end": { + "description": "Start time of the metric segment (only when an interval was specified).", + "type": "string" + }, + "segments": { + "description": "Segmented metric data (if further segmented).", + "type": "array", + "items": { + "$ref": "#/definitions/metrics-segment-info" + } + } + }, + "additionalProperties": { + "type": "object" + } + }, + "event-type": { + "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": false + } + }, + "event-id": { + "description": "ID of event.", + "type": "string", + "format": "uuid" + }, + "events-timespan": { + "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" + }, + "events-filter": { + "description": "An expression used to filter the returned events", + "type": "string" + }, + "events-search": { + "description": "A free-text search expression to match for whether a particular event should be returned", + "type": "string" + }, + "events-orderby": { + "description": "A comma-separated list of properties with \\\"asc\\\" (the default) or \\\"desc\\\" to control the order of returned events", + "type": "string" + }, + "events-select": { + "description": "Limits the properties to just those requested on each returned event", + "type": "string" + }, + "events-skip": { + "description": "The number of items to skip over before returning events", + "type": "integer", + "format": "int32" + }, + "events-top": { + "description": "The number of events to return", + "type": "integer", + "format": "int32" + }, + "events-format": { + "description": "Format for the returned events", + "type": "string" + }, + "events-count": { + "description": "Request a count of matching items included with the returned events", + "type": "boolean" + }, + "events-apply": { + "description": "An expression used for aggregation over returned events", + "type": "string" + }, + "events-results": { + "description": "An events query result.", + "type": "object", + "properties": { + "value": { + "description": "Contents of the events query result.", + "type": "array", + "items": { + "$ref": "#/definitions/events-result-data" + } + } + } + }, + "events-result": { + "description": "An event query result.", + "type": "object", + "properties": { + "value": { + "$ref": "#/definitions/events-result-data" + } + } + }, + "events-result-data": { + "description": "Events query result data.", + "type": "object", + "discriminator": "type", + "properties": { + "id": { + "description": "The unique ID for this event.", + "type": "string", + "format": "uuid" + }, + "type": { + "description": "The type of event.", + "type": "string", + "enum": [ + "trace", + "customEvent", + "pageView", + "browserTiming", + "request", + "dependency", + "exception", + "availabilityResult", + "performanceCounter", + "customMetric" + ] + }, + "count": { + "description": "Count of the event", + "type": "integer" + }, + "timestamp": { + "description": "Timestamp of the event", + "type": "string", + "format": "date-time" + }, + "customDimensions": { + "description": "Custom dimensions of the event", + "type": "object", + "properties": { + "additionalProperties": { + "type": "object" + } + } + }, + "customMeasurements": { + "description": "Custom measurements of the event", + "type": "object", + "properties": { + "additionalProperties": { + "type": "object" + } + } + }, + "operation": { + "description": "Operation info of the event", + "$ref": "#/definitions/events-operation-info" + }, + "session": { + "description": "Session info of the event", + "$ref": "#/definitions/events-session-info" + }, + "user": { + "description": "User info of the event", + "$ref": "#/definitions/events-user-info" + }, + "cloud": { + "description": "Cloud info of the event", + "$ref": "#/definitions/events-cloud-info" + }, + "ai": { + "description": "AI info of the event", + "$ref": "#/definitions/events-ai-info" + }, + "application": { + "description": "Application info of the event", + "$ref": "#/definitions/events-application-info" + }, + "client": { + "description": "Client info of the event", + "$ref": "#/definitions/events-client-info" + } + } + }, + "events-trace-result": { + "x-ms-discriminator-value": "trace", + "description": "A trace result", + "allOf": [ + { + "$ref": "#/definitions/events-result-data" + }, + { + "type": "object", + "properties": { + "trace": { + "$ref": "#/definitions/events-trace-info" + } + } + } + ] + }, + "events-trace-info": { + "description": "The trace information", + "type": "object", + "properties": { + "message": { + "description": "The trace message", + "type": "string" + }, + "severityLevel": { + "description": "The trace severity level", + "type": "integer" + } + } + }, + "events-customEvent-result": { + "x-ms-discriminator-value": "customEvent", + "description": "A custom event result", + "allOf": [ + { + "$ref": "#/definitions/events-result-data" + }, + { + "type": "object", + "properties": { + "customEvent": { + "$ref": "#/definitions/events-customEvent-info" + } + } + } + ] + }, + "events-customEvent-info": { + "description": "The custom event information", + "type": "object", + "properties": { + "name": { + "description": "The name of the custom event", + "type": "string" + } + } + }, + "events-pageView-result": { + "x-ms-discriminator-value": "pageView", + "description": "A page view result", + "allOf": [ + { + "$ref": "#/definitions/events-result-data" + }, + { + "type": "object", + "properties": { + "pageView": { + "$ref": "#/definitions/events-pageView-info" + } + } + } + ] + }, + "events-pageView-info": { + "description": "The page view information", + "type": "object", + "properties": { + "name": { + "description": "The name of the page", + "type": "string" + }, + "url": { + "description": "The URL of the page", + "type": "string" + }, + "duration": { + "description": "The duration of the page view", + "type": "string" + }, + "performanceBucket": { + "description": "The performance bucket of the page view", + "type": "string" + } + } + }, + "events-browserTiming-result": { + "x-ms-discriminator-value": "browserTiming", + "description": "A browser timing result", + "allOf": [ + { + "$ref": "#/definitions/events-result-data" + }, + { + "type": "object", + "properties": { + "browserTiming": { + "$ref": "#/definitions/events-browserTiming-info" + }, + "clientPerformance": { + "$ref": "#/definitions/events-clientPerformance-info" + } + } + } + ] + }, + "events-browserTiming-info": { + "description": "The browser timing information", + "type": "object", + "properties": { + "urlPath": { + "description": "The path of the URL", + "type": "string" + }, + "urlHost": { + "description": "The host of the URL", + "type": "string" + }, + "name": { + "description": "The name of the page", + "type": "string" + }, + "url": { + "description": "The url of the page", + "type": "string" + }, + "totalDuration": { + "description": "The total duration of the load", + "type": "integer" + }, + "performanceBucket": { + "description": "The performance bucket of the load", + "type": "string" + }, + "networkDuration": { + "description": "The network duration of the load", + "type": "integer" + }, + "sendDuration": { + "description": "The send duration of the load", + "type": "integer" + }, + "receiveDuration": { + "description": "The receive duration of the load", + "type": "integer" + }, + "processingDuration": { + "description": "The processing duration of the load", + "type": "integer" + } + } + }, + "events-clientPerformance-info": { + "description": "Client performance information", + "type": "object", + "properties": { + "name": { + "description": "The name of the client performance", + "type": "string" + } + } + }, + "events-request-result": { + "x-ms-discriminator-value": "request", + "description": "A request result", + "allOf": [ + { + "$ref": "#/definitions/events-result-data" + }, + { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/events-request-info" + } + } + } + ] + }, + "events-request-info": { + "description": "The request info", + "type": "object", + "properties": { + "name": { + "description": "The name of the request", + "type": "string" + }, + "url": { + "description": "The URL of the request", + "type": "string" + }, + "success": { + "description": "Indicates if the request was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the request", + "type": "number", + "format": "float" + }, + "performanceBucket": { + "description": "The performance bucket of the request", + "type": "string" + }, + "resultCode": { + "description": "The result code of the request", + "type": "string" + }, + "source": { + "description": "The source of the request", + "type": "string" + }, + "id": { + "description": "The ID of the request", + "type": "string" + } + } + }, + "events-dependency-result": { + "x-ms-discriminator-value": "dependency", + "description": "A dependency result", + "allOf": [ + { + "$ref": "#/definitions/events-result-data" + }, + { + "type": "object", + "properties": { + "dependency": { + "$ref": "#/definitions/events-dependency-info" + } + } + } + ] + }, + "events-dependency-info": { + "description": "The dependency info", + "type": "object", + "properties": { + "target": { + "description": "The target of the dependency", + "type": "string" + }, + "data": { + "description": "The data of the dependency", + "type": "string" + }, + "success": { + "description": "Indicates if the dependency was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the dependency", + "type": "integer" + }, + "performanceBucket": { + "description": "The performance bucket of the dependency", + "type": "string" + }, + "resultCode": { + "description": "The result code of the dependency", + "type": "string" + }, + "type": { + "description": "The type of the dependency", + "type": "string" + }, + "name": { + "description": "The name of the dependency", + "type": "string" + }, + "id": { + "description": "The ID of the dependency", + "type": "string" + } + } + }, + "events-exception-result": { + "x-ms-discriminator-value": "exception", + "description": "An exception result", + "allOf": [ + { + "$ref": "#/definitions/events-result-data" + }, + { + "type": "object", + "properties": { + "exception": { + "$ref": "#/definitions/events-exception-info" + } + } + } + ] + }, + "events-exception-info": { + "description": "The exception info", + "type": "object", + "properties": { + "severityLevel": { + "description": "The severity level of the exception", + "type": "integer" + }, + "problemId": { + "description": "The problem ID of the exception", + "type": "string" + }, + "handledAt": { + "description": "Indicates where the exception was handled at", + "type": "string" + }, + "assembly": { + "description": "The assembly which threw the exception", + "type": "string" + }, + "method": { + "description": "The method that threw the exception", + "type": "string" + }, + "message": { + "description": "The message of the exception", + "type": "string" + }, + "type": { + "description": "The type of the exception", + "type": "string" + }, + "outerType": { + "description": "The outer type of the exception", + "type": "string" + }, + "outerMethod": { + "description": "The outer method of the exception", + "type": "string" + }, + "outerAssembly": { + "description": "The outer assmebly of the exception", + "type": "string" + }, + "outerMessage": { + "description": "The outer message of the exception", + "type": "string" + }, + "innermostType": { + "description": "The inner most type of the exception", + "type": "string" + }, + "innermostMessage": { + "description": "The inner most message of the exception", + "type": "string" + }, + "innermostMethod": { + "description": "The inner most method of the exception", + "type": "string" + }, + "innermostAssembly": { + "description": "The inner most assembly of the exception", + "type": "string" + }, + "details": { + "description": "The details of the exception", + "type": "array", + "items": { + "$ref": "#/definitions/events-exception-detail" + } + } + } + }, + "events-exception-detail": { + "description": "Exception details", + "type": "object", + "properties": { + "severityLevel": { + "description": "The severity level of the exception detail", + "type": "string" + }, + "outerId": { + "description": "The outer ID of the exception detail", + "type": "string" + }, + "message": { + "description": "The message of the exception detail", + "type": "string" + }, + "type": { + "description": "The type of the exception detail", + "type": "string" + }, + "id": { + "description": "The ID of the exception detail", + "type": "string" + }, + "parsedStack": { + "description": "The parsed stack", + "type": "array", + "items": { + "$ref": "#/definitions/events-exception-details-parsedStack" + } + } + } + }, + "events-exception-details-parsedStack": { + "description": "A parsed stack entry", + "type": "object", + "properties": { + "assembly": { + "description": "The assembly of the stack entry", + "type": "string" + }, + "method": { + "description": "The method of the stack entry", + "type": "string" + }, + "level": { + "description": "The level of the stack entry", + "type": "integer" + }, + "line": { + "description": "The line of the stack entry", + "type": "integer" + } + } + }, + "events-availabilityResult-result": { + "x-ms-discriminator-value": "availabilityResult", + "description": "An availability result result", + "allOf": [ + { + "$ref": "#/definitions/events-result-data" + }, + { + "type": "object", + "properties": { + "availabilityResult": { + "$ref": "#/definitions/events-availabilityResult-info" + } + } + } + ] + }, + "events-availabilityResult-info": { + "description": "The availability result info", + "type": "object", + "properties": { + "name": { + "description": "The name of the availability result", + "type": "string" + }, + "success": { + "description": "Indicates if the availability result was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the availability result", + "type": "integer" + }, + "performanceBucket": { + "description": "The performance bucket of the availability result", + "type": "string" + }, + "message": { + "description": "The message of the availability result", + "type": "string" + }, + "location": { + "description": "The location of the availability result", + "type": "string" + }, + "id": { + "description": "The ID of the availability result", + "type": "string" + }, + "size": { + "description": "The size of the availability result", + "type": "string" + } + } + }, + "events-performanceCounter-result": { + "x-ms-discriminator-value": "performanceCounter", + "description": "A performance counter result", + "allOf": [ + { + "$ref": "#/definitions/events-result-data" + }, + { + "type": "object", + "properties": { + "performanceCounter": { + "$ref": "#/definitions/events-performanceCounter-info" + } + } + } + ] + }, + "events-performanceCounter-info": { + "description": "The performance counter info", + "type": "object", + "properties": { + "value": { + "description": "The value of the performance counter", + "type": "integer" + }, + "name": { + "description": "The name of the performance counter", + "type": "string" + }, + "category": { + "description": "The category of the performance counter", + "type": "string" + }, + "counter": { + "description": "The counter of the performance counter", + "type": "string" + }, + "instanceName": { + "description": "The instance name of the performance counter", + "type": "string" + }, + "instance": { + "description": "The instance of the performance counter", + "type": "string" + } + } + }, + "events-customMetric-result": { + "x-ms-discriminator-value": "customMetric", + "description": "A custom metric result", + "allOf": [ + { + "$ref": "#/definitions/events-result-data" + }, + { + "type": "object", + "properties": { + "customMetric": { + "$ref": "#/definitions/events-customMetric-info" + } + } + } + ] + }, + "events-customMetric-info": { + "description": "The custom metric info", + "type": "object", + "properties": { + "name": { + "description": "The name of the custom metric", + "type": "string" + }, + "value": { + "description": "The value of the custom metric", + "type": "integer" + }, + "valueSum": { + "description": "The sum of the custom metric", + "type": "integer" + }, + "valueCount": { + "description": "The count of the custom metric", + "type": "integer" + }, + "valueMin": { + "description": "The minimum value of the custom metric", + "type": "integer" + }, + "valueMax": { + "description": "The maximum value of the custom metric", + "type": "integer" + }, + "valueStdDev": { + "description": "The standard deviation of the custom metric", + "type": "integer" + } + } + }, + "events-operation-info": { + "description": "Operation info for an event result", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "id": { + "description": "ID of the operation", + "type": "string" + }, + "parentId": { + "description": "Parent ID of the operation", + "type": "string" + }, + "syntheticSource": { + "description": "Synthetic source of the operation", + "type": "string" + } + } + }, + "events-session-info": { + "description": "Session info for an event result", + "type": "object", + "properties": { + "id": { + "description": "ID of the session", + "type": "string" + } + } + }, + "events-user-info": { + "description": "User info for an event result", + "type": "object", + "properties": { + "id": { + "description": "ID of the user", + "type": "string" + }, + "accountId": { + "description": "Account ID of the user", + "type": "string" + }, + "authenticatedId": { + "description": "Authenticated ID of the user", + "type": "string" + } + } + }, + "events-cloud-info": { + "description": "Cloud info for an event result", + "type": "object", + "properties": { + "roleName": { + "description": "Role name of the cloud", + "type": "string" + }, + "roleInstance": { + "description": "Role instance of the cloud", + "type": "string" + } + } + }, + "events-ai-info": { + "description": "AI related application info for an event result", + "type": "object", + "properties": { + "iKey": { + "description": "iKey of the app", + "type": "string" + }, + "appName": { + "description": "Name of the application", + "type": "string" + }, + "appId": { + "description": "ID of the application", + "type": "string" + }, + "sdkVersion": { + "description": "SDK version of the application", + "type": "string" + } + } + }, + "events-application-info": { + "description": "Application info for an event result", + "type": "object", + "properties": { + "version": { + "description": "Version of the application", + "type": "string" + } + } + }, + "events-client-info": { + "description": "Client info for an event result", + "type": "object", + "properties": { + "model": { + "description": "Model of the client", + "type": "string" + }, + "os": { + "description": "Operating system of the client", + "type": "string" + }, + "type": { + "description": "Type of the client", + "type": "string" + }, + "browser": { + "description": "Browser of the client", + "type": "string" + }, + "ip": { + "description": "IP address of the client", + "type": "string" + }, + "city": { + "description": "City of the client", + "type": "string" + }, + "stateOrProvince": { + "description": "State or province of the client", + "type": "string" + }, + "countryOrRegion": { + "description": "Country or region of the client", + "type": "string" + } + } + }, + "query-param": { + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "string" + }, + "query-timespan": { + "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" + }, + "applications-param": { + "description": "Application IDs to include in cross-application queries.", + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string" + } + }, + "query-body": { + "description": "Query request body", + "type": "object", + "properties": { + "query": { + "$ref": "#/definitions/query-param" + }, + "timespan": { + "$ref": "#/definitions/query-timespan" + }, + "applications": { + "$ref": "#/definitions/applications-param" + } + }, + "required": [ + "query" + ] + }, + "query-results": { + "title": "A query response.", + "description": "Contains the tables, columns & rows resulting from a query.", + "type": "object", + "properties": { + "tables": { + "description": "The list of tables, columns and rows.", + "type": "array", + "items": { + "$ref": "#/definitions/table" + } + } + }, + "required": [ + "tables" + ] + }, + "table": { + "title": "A query response table.", + "description": "Contains the columns and rows for one table in a query response.", + "type": "object", + "properties": { + "name": { + "description": "The name of the table.", + "type": "string" + }, + "columns": { + "description": "The list of columns in this table.", + "type": "array", + "items": { + "$ref": "#/definitions/column" + } + }, + "rows": { + "description": "The resulting rows from this query.", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "required": [ + "name", + "columns", + "rows" + ] + }, + "column": { + "title": "A table column.", + "description": "A column in a table.", + "type": "object", + "properties": { + "name": { + "description": "The name of this column.", + "type": "string" + }, + "type": { + "description": "The data type of this column.", + "type": "string" + } + } + }, + "error-detail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + }, + "value": { + "description": "Indicates which value in 'target' is responsible for the error.", + "type": "string" + }, + "resources": { + "description": "Indicates resources which were responsible for the error.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "error-info": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/error-detail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "$ref": "#/definitions/error-info" + }, + "additionalProperties": { + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "error-response": { + "title": "Error details.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/error-info" + } + }, + "required": [ + "error" + ] + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/ai-get-metric-example.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/ai-get-metric-example.json new file mode 100644 index 000000000000..3a26e1ec8ce0 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/ai-get-metric-example.json @@ -0,0 +1,39 @@ +{ + "title": "Get Metric", + "description": "Gets data for a metric.", + "parameters": { + "app-id": "DEMO_APP", + "metric-id": "requests/failed", + "timespan": "P2D", + "interval": "P1D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "start": "2016-01-01T02:00:00.000Z", + "end": "2016-01-03T02:00:00.000Z", + "interval": "P1D", + "segments": [ + { + "start": "2016-01-01T02:00:00.000Z", + "end": "2016-01-02T02:00:00.000Z", + "requests/failed": { + "sum": 23 + } + }, + { + "start": "2016-01-02T02:00:00.000Z", + "end": "2016-01-03T02:00:00.000Z", + "requests/failed": { + "sum": 19 + } + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/readme.md b/specification/applicationinsights/data-plane/readme.md new file mode 100644 index 000000000000..40122a1dc9f3 --- /dev/null +++ b/specification/applicationinsights/data-plane/readme.md @@ -0,0 +1,60 @@ +# ApplicationInsights + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ApplicationInsightsDataPlane. + + + +--- +## Getting Started +To build the SDK for ApplicationInsightsDataPlane, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +### Basic Information + +These are the global settings for the ApplicationInsights API. + +``` yaml +title: ApplicationInsightsDataClient +description: Composite Swagger for Application Insights Data Client +add-credentials: true +openapi-type: data-plane +tag: v1 +``` + +### Tag: v1 + +These settings apply only when `--tag=v1` is specified on the command line. + +``` yaml $(tag) == 'v1' +input-file: +- microsoft.insights/v1/AppInsights.json +``` + +# Code Generation + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Microsoft.Azure.ApplicationInsights + output-folder: $(csharp-sdks-folder)/ApplicationInsights/Data.ApplicationInsights/Generated + clear-output-folder: true + payload-flattening-threshold: 3 +directive: + - reason: Don't expose the GET endpoint since it's behavior is more limited than POST + remove-operation: GetQuery +``` \ No newline at end of file From 39b1e95be12dc400bd67f1bb50960d7f8af291c9 Mon Sep 17 00:00:00 2001 From: Chris Suich Date: Tue, 23 Jan 2018 16:24:10 -0500 Subject: [PATCH 2/6] Cleanup & polish to AI Data Plane --- .../microsoft.insights/v1/AppInsights.json | 3865 +++++++++-------- 1 file changed, 1955 insertions(+), 1910 deletions(-) diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json index 1731a322a72d..3c109b5ec76b 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json @@ -1,1979 +1,2024 @@ { - "swagger": "2.0", - "info": { - "version": "v1", - "title": "AI public API", - "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": "aiapi@microsoft.com" - }, - "license": { - "name": "Microsoft", - "url": "https://dev.applicationinsights.io/license" - } + "swagger": "2.0", + "info": { + "version": "v1", + "title": "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": "aiapi@microsoft.com" }, - "host": "api.applicationinsights.io", - "basePath": "/v1", - "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" + "license": { + "name": "Microsoft", + "url": "https://dev.applicationinsights.io/license" + } + }, + "host": "api.applicationinsights.io", + "basePath": "/v1", + "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": { + "/apps/{app-id}/metrics/{metric-id}": { + "get": { + "operationId": "GetMetric", + "summary": "Retrieve metric data", + "description": "Gets metric values for a single metric", + "x-ms-examples": { + "simpleMetric": { + "$ref": "examples/ai-get-metric-example.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/metricId" + }, + { + "$ref": "#/parameters/metricsTimespan" + }, + { + "$ref": "#/parameters/metricsInterval" + }, + { + "$ref": "#/parameters/metricsAggregation" + }, + { + "$ref": "#/parameters/metricsSegment" + }, + { + "$ref": "#/parameters/metricsTop" + }, + { + "$ref": "#/parameters/metricsOrderBy" + }, + { + "$ref": "#/parameters/metricsFilter" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/metricsResult" } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } } + } }, - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] + "/apps/{app-id}/metrics": { + "post": { + "operationId": "GetMetrics", + "summary": "Retrieve metric data", + "description": "Gets metric values for multiple metrics", + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/metricsPostBody" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/metricsResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } } - ], - "paths": { - "/apps/{app-id}/metrics/{metric-id}": { - "get": { - "operationId": "GetMetric", - "summary": "Retrieve metric data", - "description": "Gets metric values for a single metric", - "x-ms-examples": { - "simpleMetric": { - "$ref": "examples/ai-get-metric-example.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/app-id" - }, - { - "$ref": "#/parameters/metric-id" - }, - { - "$ref": "#/parameters/metrics-timespan" - }, - { - "$ref": "#/parameters/metrics-interval" - }, - { - "$ref": "#/parameters/metrics-aggregation" - }, - { - "$ref": "#/parameters/metrics-segment" - }, - { - "$ref": "#/parameters/metrics-top" - }, - { - "$ref": "#/parameters/metrics-orderBy" - }, - { - "$ref": "#/parameters/metrics-filter" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/metrics-result" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } + } + }, + "/apps/{app-id}/metrics/metadata": { + "get": { + "operationId": "GetMetricsMetadata", + "summary": "Retrieve metric metatadata", + "description": "Gets metadata describing the available metrics", + "parameters": [ + { + "$ref": "#/parameters/appId" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object" } - }, - "/apps/{app-id}/metrics": { - "post": { - "operationId": "GetMetrics", - "summary": "Retrieve metric data", - "description": "Gets metric values for multiple metrics", - "parameters": [ - { - "$ref": "#/parameters/app-id" - }, - { - "$ref": "#/parameters/metrics-post-body" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/metrics-results" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" } - }, - "/apps/{app-id}/metrics/metadata": { - "get": { - "operationId": "GetMetricsMetadata", - "summary": "Retrieve metric metatadata", - "description": "Gets metadata describing the available metrics", - "parameters": [ - { - "$ref": "#/parameters/app-id" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "type": "object" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } + } + } + } + }, + "/apps/{app-id}/events/{event-type}": { + "get": { + "operationId": "GetEvents", + "summary": "Execute OData query", + "description": "Executes an OData query for events", + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$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" + } + ], + "produces": [ + "application/json;odata=none", + "application/json;odata=minimal", + "application/json;odata=full" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/eventsResults" } - }, - "/apps/{app-id}/events/{event-type}": { - "get": { - "operationId": "GetEvents", - "summary": "Execute OData query", - "description": "Executes an OData query for events", - "parameters": [ - { - "$ref": "#/parameters/app-id" - }, - { - "$ref": "#/parameters/event-type" - }, - { - "$ref": "#/parameters/events-timespan" - }, - { - "$ref": "#/parameters/events-filter" - }, - { - "$ref": "#/parameters/events-search" - }, - { - "$ref": "#/parameters/events-orderby" - }, - { - "$ref": "#/parameters/events-select" - }, - { - "$ref": "#/parameters/events-skip" - }, - { - "$ref": "#/parameters/events-top" - }, - { - "$ref": "#/parameters/events-format" - }, - { - "$ref": "#/parameters/events-count" - }, - { - "$ref": "#/parameters/events-apply" - } - ], - "produces": [ - "application/json;odata=none", - "application/json;odata=minimal", - "application/json;odata=full" - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/events-results" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" } - }, - "/apps/{app-id}/events/{event-type}/{event-id}": { - "get": { - "operationId": "GetEvent", - "summary": "Get an event", - "description": "Gets the data for a single event", - "parameters": [ - { - "$ref": "#/parameters/app-id" - }, - { - "$ref": "#/parameters/event-type" - }, - { - "$ref": "#/parameters/events-timespan" - }, - { - "$ref": "#/parameters/event-id" - } - ], - "produces": [ - "application/json", - "application/json;odata=none", - "application/json;odata=minimal", - "application/json;odata=full" - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/events-results" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } + } + } + } + }, + "/apps/{app-id}/events/{event-type}/{event-id}": { + "get": { + "operationId": "GetEvent", + "summary": "Get an event", + "description": "Gets the data for a single event", + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/eventType" + }, + { + "$ref": "#/parameters/eventsTimespan" + }, + { + "$ref": "#/parameters/eventId" + } + ], + "produces": [ + "application/json", + "application/json;odata=none", + "application/json;odata=minimal", + "application/json;odata=full" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/eventsResults" } - }, - "/apps/{app-id}/events/$metadata": { - "get": { - "operationId": "GetEventsMetadataOData", - "summary": "Get OData metadata", - "description": "Gets OData EDMX metadata describing the event data model", - "parameters": [ - { - "$ref": "#/parameters/app-id" - } - ], - "produces": [ - "application/xml;charset=utf-8" - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "type": "object" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" } - }, - "/apps/{app-id}/query": { - "get": { - "operationId": "GetQuery", - "summary": "Execute an Analytics query", - "description": "Executes an Analytics query for data", - "parameters": [ - { - "$ref": "#/parameters/app-id" - }, - { - "$ref": "#/parameters/query-param" - }, - { - "$ref": "#/parameters/query-timespan" - }, - { - "$ref": "#/parameters/applications-param" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/query-results" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } - }, - "post": { - "operationId": "Query", - "summary": "Execute an Analytics query", - "description": "Executes an Analytics query for data. [Here](/documentation/2-Using-the-API/Query) is an example for using POST with an Analytics query.", - "parameters": [ - { - "$ref": "#/parameters/app-id" - }, - { - "$ref": "#/parameters/query-body" - }, - { - "$ref": "#/parameters/query-timespan" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/query-results" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } + } + } + } + }, + "/apps/{app-id}/events/$metadata": { + "get": { + "operationId": "GetEventsMetadataOData", + "summary": "Get OData metadata", + "description": "Gets OData EDMX metadata describing the event data model", + "parameters": [ + { + "$ref": "#/parameters/appId" + } + ], + "produces": [ + "application/xml;charset=utf-8" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object" } - }, - "/apps/{app-id}/query/schema": { - "get": { - "operationId": "GetQuerySchema", - "summary": "Get Analytics query metadata", - "description": "Gets Analytics query schema describing the data model", - "parameters": [ - { - "$ref": "#/parameters/app-id" - } - ], - "responses": { - "200": { - "description": "Successful responses", - "schema": { - "type": "object" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/error-response" - } - } - } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" } + } } + } }, - "parameters": { - "app-id": { - "name": "app-id", - "description": "ID of the application. This is Application ID from the API Access settings blade in the Azure portal.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "metric-id": { - "name": "metric-id", - "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" - ] - }, - "metrics-timespan": { - "name": "timespan", - "in": "query", - "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", - "default": "PT12H" - }, - "metrics-aggregation": { - "name": "aggregation", - "in": "query", - "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", - "default": "PT12H" - }, - "metrics-interval": { - "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" - }, - "metrics-segment": { - "name": "segment", - "in": "query", - "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, - "collectionFormat": "csv", - "items": { - "type": "string", - "enum": [ - "applicationBuild", - "applicationVersion", - "authenticatedOrAnonymousTraffic", - "browser", - "browserVersion", - "city", - "cloudRoleName", - "cloudServiceName", - "continent", - "countryOrRegion", - "deploymentId", - "deploymentUnit", - "deviceType", - "environment", - "hostingLocation", - "instanceName" - ] + "/apps/{app-id}/query": { + "get": { + "operationId": "GetQuery", + "summary": "Execute an Analytics query", + "description": "Executes an Analytics query for data", + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/queryParam" + }, + { + "$ref": "#/parameters/queryTimespan" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/queryResults" } - }, - "metrics-top": { - "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" - }, - "metrics-orderBy": { - "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" - }, - "metrics-filter": { - "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" - }, - "metrics-post-body": { - "name": "body", - "description": "The batched metrics query.", - "in": "body", - "required": true, + }, + "default": { + "description": "An error response object.", "schema": { - "$ref": "#/definitions/metrics-post-body" - }, - "x-ms-parameter-location": "method" - }, - "event-type": { - "name": "event-type", - "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": false + "$ref": "#/definitions/errorResponse" } - }, - "event-id": { - "name": "event-id", - "in": "path", - "required": true, - "x-ms-parameter-location": "method", - "description": "ID of event.", - "type": "string", - "format": "uuid" - }, - "events-timespan": { - "name": "timespan", - "in": "query", - "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" - }, - "events-filter": { - "name": "$filter", - "in": "query", - "required": false, - "x-ms-parameter-location": "method", - "description": "An expression used to filter the returned events", - "type": "string" - }, - "events-search": { - "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" - }, - "events-orderby": { - "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" - }, - "events-select": { - "name": "$select", - "in": "query", - "x-ms-parameter-location": "method", - "description": "Limits the properties to just those requested on each returned event", - "type": "string" - }, - "events-skip": { - "name": "$skip", - "in": "query", - "x-ms-parameter-location": "method", - "description": "The number of items to skip over before returning events", - "type": "integer", - "format": "int32" - }, - "events-top": { - "name": "$top", - "in": "query", - "x-ms-parameter-location": "method", - "description": "The number of events to return", - "type": "integer", - "format": "int32" - }, - "events-format": { - "name": "$format", - "in": "query", - "x-ms-parameter-location": "method", - "description": "Format for the returned events", - "type": "string" - }, - "events-count": { - "name": "$count", - "in": "query", - "x-ms-parameter-location": "method", - "description": "Request a count of matching items included with the returned events", - "type": "boolean" - }, - "events-apply": { - "name": "$apply", - "in": "query", - "x-ms-parameter-location": "method", - "description": "An expression used for aggregation over returned events", - "type": "string" - }, - "applications-param": { - "name": "applications", - "in": "query", - "required": false, - "description": "Application IDs to include in cross-application queries.", - "type": "array", - "collectionFormat": "csv", - "items": { - "type": "string" + } + } + }, + "post": { + "operationId": "Query", + "summary": "Execute an Analytics query", + "description": "Executes an Analytics query for data. [Here](/documentation/2-Using-the-API/Query) is an example for using POST with an Analytics query.", + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/queryBody" + }, + { + "$ref": "#/parameters/queryTimespan" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/queryResults" } - }, - "query-timespan": { - "name": "timespan", - "in": "query", - "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" - }, - "query-param": { - "name": "query", - "in": "query", - "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" - }, - "query-body": { - "name": "body", - "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", - "in": "body", + }, + "default": { + "description": "An error response object.", "schema": { - "$ref": "#/definitions/query-body" - }, - "x-ms-parameter-location": "method" + "$ref": "#/definitions/errorResponse" + } + } } + } }, - "definitions": { - "metric-id": { - "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" - ] - }, - "metrics-timespan": { - "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", - "default": "PT12H" - }, - "metrics-aggregation": { - "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", - "collectionFormat": "csv", - "minItems": 1, - "items": { - "type": "string", - "enum": [ - "min", - "max", - "avg", - "sum" - ] - } - }, - "metrics-interval": { - "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" - }, - "metrics-segment": { - "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, - "collectionFormat": "csv", - "items": { - "type": "string", - "enum": [ - "applicationBuild", - "applicationVersion", - "authenticatedOrAnonymousTraffic", - "browser", - "browserVersion", - "city", - "cloudRoleName", - "cloudServiceName", - "continent", - "countryOrRegion", - "deploymentId", - "deploymentUnit", - "deviceType", - "environment", - "hostingLocation", - "instanceName" - ] + "/apps/{app-id}/query/schema": { + "get": { + "operationId": "GetQuerySchema", + "summary": "Get Analytics query metadata", + "description": "Gets Analytics query schema describing the data model", + "parameters": [ + { + "$ref": "#/parameters/appId" + } + ], + "responses": { + "200": { + "description": "Successful responses", + "schema": { + "type": "object" } - }, - "metrics-top": { - "description": "The number of segments to return. This value is only valid when segment is specified.", - "type": "integer", - "format": "int32" - }, - "metrics-orderBy": { - "description": "The aggregation function and direction to sort the segments by. This value is only valid when segment is specified.", - "type": "string" - }, - "metrics-filter": { - "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" - }, - "metrics-post-body": { - "description": "Metrics request body", - "type": "array", - "items": { - "$ref": "#/definitions/metrics-post-body-schema" + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" } - }, - "metrics-post-body-schema": { - "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/metric-id" - }, - "timespan": { - "$ref": "#/definitions/metrics-timespan" - }, - "aggregation": { - "$ref": "#/definitions/metrics-aggregation" - }, - "interval": { - "$ref": "#/definitions/metrics-interval" - }, - "segment": { - "$ref": "#/definitions/metrics-segment" - }, - "top": { - "$ref": "#/definitions/metrics-top" - }, - "orderby": { - "$ref": "#/definitions/metrics-orderBy" - }, - "filter": { - "$ref": "#/definitions/metrics-filter" - } - }, - "required": [ - "metricId" - ] - } + } + } + } + } + }, + "parameters": { + "appId": { + "name": "app-id", + "description": "ID of the application. This is Application ID from the API Access settings blade in the Azure portal.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "metricId": { + "name": "metric-id", + "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" + ] + }, + "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", + "format": "duration" + }, + "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" + ] + } + }, + "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" + ] + } + }, + "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": "event-type", + "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": false + } + }, + "eventId": { + "name": "event-id", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "description": "ID of event.", + "type": "string", + "format": "uuid" + }, + "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", + "format": "duration" + }, + "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" + }, + "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", + "format": "duration" + }, + "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" + } + }, + "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" + ] + }, + "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", + "format": "duration" + }, + "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" + ] + } + }, + "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" + ] + } + }, + "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" }, - "required": [ - "id", - "parameters" - ] - }, - "metrics-results": { - "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/metrics-result" - } - }, - "required": [ - "id", - "status", - "body" - ] - } - }, - "metrics-result": { - "description": "A metric result.", - "properties": { - "value": { - "$ref": "#/definitions/metrics-result-info" - } - } - }, - "metrics-result-info": { - "description": "A metric result data.", - "type": "object", - "properties": { - "start": { - "description": "Start time of the metric.", - "type": "string" - }, - "end": { - "description": "Start time of the metric.", - "type": "string" - }, - "interval": { - "description": "The interval used to segment the metric data.", - "type": "string" - }, - "segments": { - "description": "Segmented metric data (if segmented).", - "type": "array", - "items": { - "$ref": "#/definitions/metrics-segment-info" - } - } + "timespan": { + "$ref": "#/definitions/metricsTimespan" }, - "additionalProperties": { - "type": "object" - } - }, - "metrics-segment-info": { - "description": "A metric segment", - "type": "object", - "properties": { - "start": { - "description": "Start time of the metric segment (only when an interval was specified).", - "type": "string" - }, - "end": { - "description": "Start time of the metric segment (only when an interval was specified).", - "type": "string" - }, - "segments": { - "description": "Segmented metric data (if further segmented).", - "type": "array", - "items": { - "$ref": "#/definitions/metrics-segment-info" - } - } + "aggregation": { + "$ref": "#/definitions/metricsAggregation" }, - "additionalProperties": { - "type": "object" - } - }, - "event-type": { - "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": false + "interval": { + "$ref": "#/definitions/metricsInterval" + }, + "segment": { + "$ref": "#/definitions/metricsSegment" + }, + "top": { + "$ref": "#/definitions/metricsTop" + }, + "orderby": { + "$ref": "#/definitions/metricsOrderBy" + }, + "filter": { + "$ref": "#/definitions/metricsFilter" } - }, - "event-id": { - "description": "ID of event.", - "type": "string", - "format": "uuid" - }, - "events-timespan": { - "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" - }, - "events-filter": { - "description": "An expression used to filter the returned events", - "type": "string" - }, - "events-search": { - "description": "A free-text search expression to match for whether a particular event should be returned", - "type": "string" - }, - "events-orderby": { - "description": "A comma-separated list of properties with \\\"asc\\\" (the default) or \\\"desc\\\" to control the order of returned events", - "type": "string" - }, - "events-select": { - "description": "Limits the properties to just those requested on each returned event", + }, + "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" - }, - "events-skip": { - "description": "The number of items to skip over before returning events", - "type": "integer", - "format": "int32" - }, - "events-top": { - "description": "The number of events to return", + }, + "status": { + "description": "The HTTP status code of this metric query.", "type": "integer", "format": "int32" - }, - "events-format": { - "description": "Format for the returned events", - "type": "string" - }, - "events-count": { - "description": "Request a count of matching items included with the returned events", - "type": "boolean" - }, - "events-apply": { - "description": "An expression used for aggregation over returned events", - "type": "string" - }, - "events-results": { - "description": "An events query result.", - "type": "object", - "properties": { - "value": { - "description": "Contents of the events query result.", - "type": "array", - "items": { - "$ref": "#/definitions/events-result-data" - } - } - } - }, - "events-result": { - "description": "An event query result.", - "type": "object", - "properties": { - "value": { - "$ref": "#/definitions/events-result-data" - } - } - }, - "events-result-data": { - "description": "Events query result data.", - "type": "object", - "discriminator": "type", - "properties": { - "id": { - "description": "The unique ID for this event.", - "type": "string", - "format": "uuid" - }, - "type": { - "description": "The type of event.", - "type": "string", - "enum": [ - "trace", - "customEvent", - "pageView", - "browserTiming", - "request", - "dependency", - "exception", - "availabilityResult", - "performanceCounter", - "customMetric" - ] - }, - "count": { - "description": "Count of the event", - "type": "integer" - }, - "timestamp": { - "description": "Timestamp of the event", - "type": "string", - "format": "date-time" - }, - "customDimensions": { - "description": "Custom dimensions of the event", - "type": "object", - "properties": { - "additionalProperties": { - "type": "object" - } - } - }, - "customMeasurements": { - "description": "Custom measurements of the event", - "type": "object", - "properties": { - "additionalProperties": { - "type": "object" - } - } - }, - "operation": { - "description": "Operation info of the event", - "$ref": "#/definitions/events-operation-info" - }, - "session": { - "description": "Session info of the event", - "$ref": "#/definitions/events-session-info" - }, - "user": { - "description": "User info of the event", - "$ref": "#/definitions/events-user-info" - }, - "cloud": { - "description": "Cloud info of the event", - "$ref": "#/definitions/events-cloud-info" - }, - "ai": { - "description": "AI info of the event", - "$ref": "#/definitions/events-ai-info" - }, - "application": { - "description": "Application info of the event", - "$ref": "#/definitions/events-application-info" - }, - "client": { - "description": "Client info of the event", - "$ref": "#/definitions/events-client-info" - } - } - }, - "events-trace-result": { - "x-ms-discriminator-value": "trace", - "description": "A trace result", - "allOf": [ - { - "$ref": "#/definitions/events-result-data" - }, - { - "type": "object", - "properties": { - "trace": { - "$ref": "#/definitions/events-trace-info" - } - } - } - ] - }, - "events-trace-info": { - "description": "The trace information", - "type": "object", - "properties": { - "message": { - "description": "The trace message", - "type": "string" - }, - "severityLevel": { - "description": "The trace severity level", - "type": "integer" - } - } - }, - "events-customEvent-result": { - "x-ms-discriminator-value": "customEvent", - "description": "A custom event result", - "allOf": [ - { - "$ref": "#/definitions/events-result-data" - }, - { - "type": "object", - "properties": { - "customEvent": { - "$ref": "#/definitions/events-customEvent-info" - } - } - } - ] - }, - "events-customEvent-info": { - "description": "The custom event information", - "type": "object", - "properties": { - "name": { - "description": "The name of the custom event", - "type": "string" - } + }, + "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": { + "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": { + "type": "object" + } + }, + "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": false + } + }, + "eventId": { + "description": "ID of event.", + "type": "string", + "format": "uuid" + }, + "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", + "format": "duration" + }, + "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": { + "@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", + "format": "uuid" + }, + "type": { + "description": "The type of event.", + "type": "string", + "enum": [ + "trace", + "customEvent", + "pageView", + "browserTiming", + "request", + "dependency", + "exception", + "availabilityResult", + "performanceCounter", + "customMetric" + ] + }, + "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" } + } }, - "events-pageView-result": { - "x-ms-discriminator-value": "pageView", - "description": "A page view result", - "allOf": [ - { - "$ref": "#/definitions/events-result-data" - }, - { - "type": "object", - "properties": { - "pageView": { - "$ref": "#/definitions/events-pageView-info" - } - } - } - ] - }, - "events-pageView-info": { - "description": "The page view information", - "type": "object", - "properties": { - "name": { - "description": "The name of the page", - "type": "string" - }, - "url": { - "description": "The URL of the page", - "type": "string" - }, - "duration": { - "description": "The duration of the page view", - "type": "string" - }, - "performanceBucket": { - "description": "The performance bucket of the page view", - "type": "string" - } + "customMeasurements": { + "description": "Custom measurements of the event", + "type": "object", + "properties": { + "additionalProperties": { + "type": "object" } + } }, - "events-browserTiming-result": { - "x-ms-discriminator-value": "browserTiming", - "description": "A browser timing result", - "allOf": [ - { - "$ref": "#/definitions/events-result-data" - }, - { - "type": "object", - "properties": { - "browserTiming": { - "$ref": "#/definitions/events-browserTiming-info" - }, - "clientPerformance": { - "$ref": "#/definitions/events-clientPerformance-info" - } - } - } - ] - }, - "events-browserTiming-info": { - "description": "The browser timing information", - "type": "object", - "properties": { - "urlPath": { - "description": "The path of the URL", - "type": "string" - }, - "urlHost": { - "description": "The host of the URL", - "type": "string" - }, - "name": { - "description": "The name of the page", - "type": "string" - }, - "url": { - "description": "The url of the page", - "type": "string" - }, - "totalDuration": { - "description": "The total duration of the load", - "type": "integer" - }, - "performanceBucket": { - "description": "The performance bucket of the load", - "type": "string" - }, - "networkDuration": { - "description": "The network duration of the load", - "type": "integer" - }, - "sendDuration": { - "description": "The send duration of the load", - "type": "integer" - }, - "receiveDuration": { - "description": "The receive duration of the load", - "type": "integer" - }, - "processingDuration": { - "description": "The processing duration of the load", - "type": "integer" - } - } + "operation": { + "description": "Operation info of the event", + "$ref": "#/definitions/eventsOperationInfo" }, - "events-clientPerformance-info": { - "description": "Client performance information", - "type": "object", - "properties": { - "name": { - "description": "The name of the client performance", - "type": "string" - } - } + "session": { + "description": "Session info of the event", + "$ref": "#/definitions/eventsSessionInfo" }, - "events-request-result": { - "x-ms-discriminator-value": "request", - "description": "A request result", - "allOf": [ - { - "$ref": "#/definitions/events-result-data" - }, - { - "type": "object", - "properties": { - "request": { - "$ref": "#/definitions/events-request-info" - } - } - } - ] - }, - "events-request-info": { - "description": "The request info", - "type": "object", - "properties": { - "name": { - "description": "The name of the request", - "type": "string" - }, - "url": { - "description": "The URL of the request", - "type": "string" - }, - "success": { - "description": "Indicates if the request was successful", - "type": "string" - }, - "duration": { - "description": "The duration of the request", - "type": "number", - "format": "float" - }, - "performanceBucket": { - "description": "The performance bucket of the request", - "type": "string" - }, - "resultCode": { - "description": "The result code of the request", - "type": "string" - }, - "source": { - "description": "The source of the request", - "type": "string" - }, - "id": { - "description": "The ID of the request", - "type": "string" - } - } + "user": { + "description": "User info of the event", + "$ref": "#/definitions/eventsUserInfo" }, - "events-dependency-result": { - "x-ms-discriminator-value": "dependency", - "description": "A dependency result", - "allOf": [ - { - "$ref": "#/definitions/events-result-data" - }, - { - "type": "object", - "properties": { - "dependency": { - "$ref": "#/definitions/events-dependency-info" - } - } - } - ] - }, - "events-dependency-info": { - "description": "The dependency info", - "type": "object", - "properties": { - "target": { - "description": "The target of the dependency", - "type": "string" - }, - "data": { - "description": "The data of the dependency", - "type": "string" - }, - "success": { - "description": "Indicates if the dependency was successful", - "type": "string" - }, - "duration": { - "description": "The duration of the dependency", - "type": "integer" - }, - "performanceBucket": { - "description": "The performance bucket of the dependency", - "type": "string" - }, - "resultCode": { - "description": "The result code of the dependency", - "type": "string" - }, - "type": { - "description": "The type of the dependency", - "type": "string" - }, - "name": { - "description": "The name of the dependency", - "type": "string" - }, - "id": { - "description": "The ID of the dependency", - "type": "string" - } - } + "cloud": { + "description": "Cloud info of the event", + "$ref": "#/definitions/eventsCloudInfo" }, - "events-exception-result": { - "x-ms-discriminator-value": "exception", - "description": "An exception result", - "allOf": [ - { - "$ref": "#/definitions/events-result-data" - }, - { - "type": "object", - "properties": { - "exception": { - "$ref": "#/definitions/events-exception-info" - } - } - } - ] - }, - "events-exception-info": { - "description": "The exception info", - "type": "object", - "properties": { - "severityLevel": { - "description": "The severity level of the exception", - "type": "integer" - }, - "problemId": { - "description": "The problem ID of the exception", - "type": "string" - }, - "handledAt": { - "description": "Indicates where the exception was handled at", - "type": "string" - }, - "assembly": { - "description": "The assembly which threw the exception", - "type": "string" - }, - "method": { - "description": "The method that threw the exception", - "type": "string" - }, - "message": { - "description": "The message of the exception", - "type": "string" - }, - "type": { - "description": "The type of the exception", - "type": "string" - }, - "outerType": { - "description": "The outer type of the exception", - "type": "string" - }, - "outerMethod": { - "description": "The outer method of the exception", - "type": "string" - }, - "outerAssembly": { - "description": "The outer assmebly of the exception", - "type": "string" - }, - "outerMessage": { - "description": "The outer message of the exception", - "type": "string" - }, - "innermostType": { - "description": "The inner most type of the exception", - "type": "string" - }, - "innermostMessage": { - "description": "The inner most message of the exception", - "type": "string" - }, - "innermostMethod": { - "description": "The inner most method of the exception", - "type": "string" - }, - "innermostAssembly": { - "description": "The inner most assembly of the exception", - "type": "string" - }, - "details": { - "description": "The details of the exception", - "type": "array", - "items": { - "$ref": "#/definitions/events-exception-detail" - } - } - } + "ai": { + "description": "AI info of the event", + "$ref": "#/definitions/eventsAiInfo" }, - "events-exception-detail": { - "description": "Exception details", - "type": "object", - "properties": { - "severityLevel": { - "description": "The severity level of the exception detail", - "type": "string" - }, - "outerId": { - "description": "The outer ID of the exception detail", - "type": "string" - }, - "message": { - "description": "The message of the exception detail", - "type": "string" - }, - "type": { - "description": "The type of the exception detail", - "type": "string" - }, - "id": { - "description": "The ID of the exception detail", - "type": "string" - }, - "parsedStack": { - "description": "The parsed stack", - "type": "array", - "items": { - "$ref": "#/definitions/events-exception-details-parsedStack" - } - } - } + "application": { + "description": "Application info of the event", + "$ref": "#/definitions/eventsApplicationInfo" }, - "events-exception-details-parsedStack": { - "description": "A parsed stack entry", - "type": "object", - "properties": { - "assembly": { - "description": "The assembly of the stack entry", - "type": "string" - }, - "method": { - "description": "The method of the stack entry", - "type": "string" - }, - "level": { - "description": "The level of the stack entry", - "type": "integer" - }, - "line": { - "description": "The line of the stack entry", - "type": "integer" - } - } + "client": { + "description": "Client info of the event", + "$ref": "#/definitions/eventsClientInfo" + } + } + }, + "eventsTraceResult": { + "x-ms-discriminator-value": "trace", + "description": "A trace result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" }, - "events-availabilityResult-result": { - "x-ms-discriminator-value": "availabilityResult", - "description": "An availability result result", - "allOf": [ - { - "$ref": "#/definitions/events-result-data" - }, - { - "type": "object", - "properties": { - "availabilityResult": { - "$ref": "#/definitions/events-availabilityResult-info" - } - } - } - ] - }, - "events-availabilityResult-info": { - "description": "The availability result info", - "type": "object", - "properties": { - "name": { - "description": "The name of the availability result", - "type": "string" - }, - "success": { - "description": "Indicates if the availability result was successful", - "type": "string" - }, - "duration": { - "description": "The duration of the availability result", - "type": "integer" - }, - "performanceBucket": { - "description": "The performance bucket of the availability result", - "type": "string" - }, - "message": { - "description": "The message of the availability result", - "type": "string" - }, - "location": { - "description": "The location of the availability result", - "type": "string" - }, - "id": { - "description": "The ID of the availability result", - "type": "string" - }, - "size": { - "description": "The size of the availability result", - "type": "string" - } + { + "type": "object", + "properties": { + "trace": { + "$ref": "#/definitions/eventsTraceInfo" } + } + } + ] + }, + "eventsTraceInfo": { + "description": "The trace information", + "type": "object", + "properties": { + "message": { + "description": "The trace message", + "type": "string" + }, + "severityLevel": { + "description": "The trace severity level", + "type": "integer" + } + } + }, + "eventsCustomEventResult": { + "x-ms-discriminator-value": "customEvent", + "description": "A custom event result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" }, - "events-performanceCounter-result": { - "x-ms-discriminator-value": "performanceCounter", - "description": "A performance counter result", - "allOf": [ - { - "$ref": "#/definitions/events-result-data" - }, - { - "type": "object", - "properties": { - "performanceCounter": { - "$ref": "#/definitions/events-performanceCounter-info" - } - } - } - ] - }, - "events-performanceCounter-info": { - "description": "The performance counter info", - "type": "object", - "properties": { - "value": { - "description": "The value of the performance counter", - "type": "integer" - }, - "name": { - "description": "The name of the performance counter", - "type": "string" - }, - "category": { - "description": "The category of the performance counter", - "type": "string" - }, - "counter": { - "description": "The counter of the performance counter", - "type": "string" - }, - "instanceName": { - "description": "The instance name of the performance counter", - "type": "string" - }, - "instance": { - "description": "The instance of the performance counter", - "type": "string" - } + { + "type": "object", + "properties": { + "customEvent": { + "$ref": "#/definitions/eventsCustomEventInfo" } + } + } + ] + }, + "eventsCustomEventInfo": { + "description": "The custom event information", + "type": "object", + "properties": { + "name": { + "description": "The name of the custom event", + "type": "string" + } + } + }, + "eventsPageViewResult": { + "x-ms-discriminator-value": "pageView", + "description": "A page view result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" }, - "events-customMetric-result": { - "x-ms-discriminator-value": "customMetric", - "description": "A custom metric result", - "allOf": [ - { - "$ref": "#/definitions/events-result-data" - }, - { - "type": "object", - "properties": { - "customMetric": { - "$ref": "#/definitions/events-customMetric-info" - } - } - } - ] - }, - "events-customMetric-info": { - "description": "The custom metric info", - "type": "object", - "properties": { - "name": { - "description": "The name of the custom metric", - "type": "string" - }, - "value": { - "description": "The value of the custom metric", - "type": "integer" - }, - "valueSum": { - "description": "The sum of the custom metric", - "type": "integer" - }, - "valueCount": { - "description": "The count of the custom metric", - "type": "integer" - }, - "valueMin": { - "description": "The minimum value of the custom metric", - "type": "integer" - }, - "valueMax": { - "description": "The maximum value of the custom metric", - "type": "integer" - }, - "valueStdDev": { - "description": "The standard deviation of the custom metric", - "type": "integer" - } + { + "type": "object", + "properties": { + "pageView": { + "$ref": "#/definitions/eventsPageViewInfo" } + } + } + ] + }, + "eventsPageViewInfo": { + "description": "The page view information", + "type": "object", + "properties": { + "name": { + "description": "The name of the page", + "type": "string" + }, + "url": { + "description": "The URL of the page", + "type": "string" + }, + "duration": { + "description": "The duration of the page view", + "type": "string" + }, + "performanceBucket": { + "description": "The performance bucket of the page view", + "type": "string" + } + } + }, + "eventsBrowserTimingResult": { + "x-ms-discriminator-value": "browserTiming", + "description": "A browser timing result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" }, - "events-operation-info": { - "description": "Operation info for an event result", - "type": "object", - "properties": { - "name": { - "description": "Name of the operation", - "type": "string" - }, - "id": { - "description": "ID of the operation", - "type": "string" - }, - "parentId": { - "description": "Parent ID of the operation", - "type": "string" - }, - "syntheticSource": { - "description": "Synthetic source of the operation", - "type": "string" - } + { + "type": "object", + "properties": { + "browserTiming": { + "$ref": "#/definitions/eventsBrowserTimingInfo" + }, + "clientPerformance": { + "$ref": "#/definitions/eventsClientPerformanceInfo" } + } + } + ] + }, + "eventsBrowserTimingInfo": { + "description": "The browser timing information", + "type": "object", + "properties": { + "urlPath": { + "description": "The path of the URL", + "type": "string" + }, + "urlHost": { + "description": "The host of the URL", + "type": "string" + }, + "name": { + "description": "The name of the page", + "type": "string" + }, + "url": { + "description": "The url of the page", + "type": "string" + }, + "totalDuration": { + "description": "The total duration of the load", + "type": "integer", + "format": "int64" + }, + "performanceBucket": { + "description": "The performance bucket of the load", + "type": "string" + }, + "networkDuration": { + "description": "The network duration of the load", + "type": "integer", + "format": "int64" + }, + "sendDuration": { + "description": "The send duration of the load", + "type": "integer", + "format": "int64" + }, + "receiveDuration": { + "description": "The receive duration of the load", + "type": "integer", + "format": "int64" + }, + "processingDuration": { + "description": "The processing duration of the load", + "type": "integer", + "format": "int64" + } + } + }, + "eventsClientPerformanceInfo": { + "description": "Client performance information", + "type": "object", + "properties": { + "name": { + "description": "The name of the client performance", + "type": "string" + } + } + }, + "eventsRequestResult": { + "x-ms-discriminator-value": "request", + "description": "A request result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" }, - "events-session-info": { - "description": "Session info for an event result", - "type": "object", - "properties": { - "id": { - "description": "ID of the session", - "type": "string" - } + { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/eventsRequestInfo" } + } + } + ] + }, + "eventsRequestInfo": { + "description": "The request info", + "type": "object", + "properties": { + "name": { + "description": "The name of the request", + "type": "string" + }, + "url": { + "description": "The URL of the request", + "type": "string" + }, + "success": { + "description": "Indicates if the request was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the request", + "type": "number", + "format": "double" + }, + "performanceBucket": { + "description": "The performance bucket of the request", + "type": "string" + }, + "resultCode": { + "description": "The result code of the request", + "type": "string" + }, + "source": { + "description": "The source of the request", + "type": "string" + }, + "id": { + "description": "The ID of the request", + "type": "string" + } + } + }, + "eventsDependencyResult": { + "x-ms-discriminator-value": "dependency", + "description": "A dependency result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" }, - "events-user-info": { - "description": "User info for an event result", - "type": "object", - "properties": { - "id": { - "description": "ID of the user", - "type": "string" - }, - "accountId": { - "description": "Account ID of the user", - "type": "string" - }, - "authenticatedId": { - "description": "Authenticated ID of the user", - "type": "string" - } + { + "type": "object", + "properties": { + "dependency": { + "$ref": "#/definitions/eventsDependencyInfo" } + } + } + ] + }, + "eventsDependencyInfo": { + "description": "The dependency info", + "type": "object", + "properties": { + "target": { + "description": "The target of the dependency", + "type": "string" + }, + "data": { + "description": "The data of the dependency", + "type": "string" + }, + "success": { + "description": "Indicates if the dependency was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the dependency", + "type": "integer", + "format": "int64" + }, + "performanceBucket": { + "description": "The performance bucket of the dependency", + "type": "string" + }, + "resultCode": { + "description": "The result code of the dependency", + "type": "string" + }, + "type": { + "description": "The type of the dependency", + "type": "string" + }, + "name": { + "description": "The name of the dependency", + "type": "string" + }, + "id": { + "description": "The ID of the dependency", + "type": "string" + } + } + }, + "eventsExceptionResult": { + "x-ms-discriminator-value": "exception", + "description": "An exception result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" }, - "events-cloud-info": { - "description": "Cloud info for an event result", - "type": "object", - "properties": { - "roleName": { - "description": "Role name of the cloud", - "type": "string" - }, - "roleInstance": { - "description": "Role instance of the cloud", - "type": "string" - } + { + "type": "object", + "properties": { + "exception": { + "$ref": "#/definitions/eventsExceptionInfo" } + } + } + ] + }, + "eventsExceptionInfo": { + "description": "The exception info", + "type": "object", + "properties": { + "severityLevel": { + "description": "The severity level of the exception", + "type": "integer" + }, + "problemId": { + "description": "The problem ID of the exception", + "type": "string" + }, + "handledAt": { + "description": "Indicates where the exception was handled at", + "type": "string" + }, + "assembly": { + "description": "The assembly which threw the exception", + "type": "string" + }, + "method": { + "description": "The method that threw the exception", + "type": "string" + }, + "message": { + "description": "The message of the exception", + "type": "string" + }, + "type": { + "description": "The type of the exception", + "type": "string" + }, + "outerType": { + "description": "The outer type of the exception", + "type": "string" + }, + "outerMethod": { + "description": "The outer method of the exception", + "type": "string" + }, + "outerAssembly": { + "description": "The outer assmebly of the exception", + "type": "string" + }, + "outerMessage": { + "description": "The outer message of the exception", + "type": "string" + }, + "innermostType": { + "description": "The inner most type of the exception", + "type": "string" + }, + "innermostMessage": { + "description": "The inner most message of the exception", + "type": "string" + }, + "innermostMethod": { + "description": "The inner most method of the exception", + "type": "string" + }, + "innermostAssembly": { + "description": "The inner most assembly of the exception", + "type": "string" + }, + "details": { + "description": "The details of the exception", + "type": "array", + "items": { + "$ref": "#/definitions/eventsExceptionDetail" + } + } + } + }, + "eventsExceptionDetail": { + "description": "Exception details", + "type": "object", + "properties": { + "severityLevel": { + "description": "The severity level of the exception detail", + "type": "string" + }, + "outerId": { + "description": "The outer ID of the exception detail", + "type": "string" + }, + "message": { + "description": "The message of the exception detail", + "type": "string" + }, + "type": { + "description": "The type of the exception detail", + "type": "string" + }, + "id": { + "description": "The ID of the exception detail", + "type": "string" + }, + "parsedStack": { + "description": "The parsed stack", + "type": "array", + "items": { + "$ref": "#/definitions/eventsExceptionDetailsParsedStack" + } + } + } + }, + "eventsExceptionDetailsParsedStack": { + "description": "A parsed stack entry", + "type": "object", + "properties": { + "assembly": { + "description": "The assembly of the stack entry", + "type": "string" + }, + "method": { + "description": "The method of the stack entry", + "type": "string" + }, + "level": { + "description": "The level of the stack entry", + "type": "integer", + "format": "int64" + }, + "line": { + "description": "The line of the stack entry", + "type": "integer", + "format": "int64" + } + } + }, + "eventsAvailabilityResultResult": { + "x-ms-discriminator-value": "availabilityResult", + "description": "An availability result result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" }, - "events-ai-info": { - "description": "AI related application info for an event result", - "type": "object", - "properties": { - "iKey": { - "description": "iKey of the app", - "type": "string" - }, - "appName": { - "description": "Name of the application", - "type": "string" - }, - "appId": { - "description": "ID of the application", - "type": "string" - }, - "sdkVersion": { - "description": "SDK version of the application", - "type": "string" - } + { + "type": "object", + "properties": { + "availabilityResult": { + "$ref": "#/definitions/eventsAvailabilityResultInfo" } + } + } + ] + }, + "eventsAvailabilityResultInfo": { + "description": "The availability result info", + "type": "object", + "properties": { + "name": { + "description": "The name of the availability result", + "type": "string" + }, + "success": { + "description": "Indicates if the availability result was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the availability result", + "type": "integer", + "format": "int64" + }, + "performanceBucket": { + "description": "The performance bucket of the availability result", + "type": "string" + }, + "message": { + "description": "The message of the availability result", + "type": "string" + }, + "location": { + "description": "The location of the availability result", + "type": "string" + }, + "id": { + "description": "The ID of the availability result", + "type": "string" + }, + "size": { + "description": "The size of the availability result", + "type": "string" + } + } + }, + "eventsPerformanceCounterResult": { + "x-ms-discriminator-value": "performanceCounter", + "description": "A performance counter result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" }, - "events-application-info": { - "description": "Application info for an event result", - "type": "object", - "properties": { - "version": { - "description": "Version of the application", - "type": "string" - } + { + "type": "object", + "properties": { + "performanceCounter": { + "$ref": "#/definitions/eventsPerformanceCounterInfo" } + } + } + ] + }, + "eventsPerformanceCounterInfo": { + "description": "The performance counter info", + "type": "object", + "properties": { + "value": { + "description": "The value of the performance counter", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the performance counter", + "type": "string" + }, + "category": { + "description": "The category of the performance counter", + "type": "string" + }, + "counter": { + "description": "The counter of the performance counter", + "type": "string" + }, + "instanceName": { + "description": "The instance name of the performance counter", + "type": "string" + }, + "instance": { + "description": "The instance of the performance counter", + "type": "string" + } + } + }, + "eventsCustomMetricResult": { + "x-ms-discriminator-value": "customMetric", + "description": "A custom metric result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" }, - "events-client-info": { - "description": "Client info for an event result", - "type": "object", - "properties": { - "model": { - "description": "Model of the client", - "type": "string" - }, - "os": { - "description": "Operating system of the client", - "type": "string" - }, - "type": { - "description": "Type of the client", - "type": "string" - }, - "browser": { - "description": "Browser of the client", - "type": "string" - }, - "ip": { - "description": "IP address of the client", - "type": "string" - }, - "city": { - "description": "City of the client", - "type": "string" - }, - "stateOrProvince": { - "description": "State or province of the client", - "type": "string" - }, - "countryOrRegion": { - "description": "Country or region of the client", - "type": "string" - } + { + "type": "object", + "properties": { + "customMetric": { + "$ref": "#/definitions/eventsCustomMetricInfo" } - }, - "query-param": { - "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", - "type": "string" - }, - "query-timespan": { - "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" - }, - "applications-param": { - "description": "Application IDs to include in cross-application queries.", + } + } + ] + }, + "eventsCustomMetricInfo": { + "description": "The custom metric info", + "type": "object", + "properties": { + "name": { + "description": "The name of the custom metric", + "type": "string" + }, + "value": { + "description": "The value of the custom metric", + "type": "number", + "format": "double" + }, + "valueSum": { + "description": "The sum of the custom metric", + "type": "number", + "format": "double" + }, + "valueCount": { + "description": "The count of the custom metric", + "type": "number", + "format": "double" + }, + "valueMin": { + "description": "The minimum value of the custom metric", + "type": "number", + "format": "double" + }, + "valueMax": { + "description": "The maximum value of the custom metric", + "type": "number", + "format": "double" + }, + "valueStdDev": { + "description": "The standard deviation of the custom metric", + "type": "number", + "format": "double" + } + } + }, + "eventsOperationInfo": { + "description": "Operation info for an event result", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "id": { + "description": "ID of the operation", + "type": "string" + }, + "parentId": { + "description": "Parent ID of the operation", + "type": "string" + }, + "syntheticSource": { + "description": "Synthetic source of the operation", + "type": "string" + } + } + }, + "eventsSessionInfo": { + "description": "Session info for an event result", + "type": "object", + "properties": { + "id": { + "description": "ID of the session", + "type": "string" + } + } + }, + "eventsUserInfo": { + "description": "User info for an event result", + "type": "object", + "properties": { + "id": { + "description": "ID of the user", + "type": "string" + }, + "accountId": { + "description": "Account ID of the user", + "type": "string" + }, + "authenticatedId": { + "description": "Authenticated ID of the user", + "type": "string" + } + } + }, + "eventsCloudInfo": { + "description": "Cloud info for an event result", + "type": "object", + "properties": { + "roleName": { + "description": "Role name of the cloud", + "type": "string" + }, + "roleInstance": { + "description": "Role instance of the cloud", + "type": "string" + } + } + }, + "eventsAiInfo": { + "description": "AI related application info for an event result", + "type": "object", + "properties": { + "iKey": { + "description": "iKey of the app", + "type": "string" + }, + "appName": { + "description": "Name of the application", + "type": "string" + }, + "appId": { + "description": "ID of the application", + "type": "string" + }, + "sdkVersion": { + "description": "SDK version of the application", + "type": "string" + } + } + }, + "eventsApplicationInfo": { + "description": "Application info for an event result", + "type": "object", + "properties": { + "version": { + "description": "Version of the application", + "type": "string" + } + } + }, + "eventsClientInfo": { + "description": "Client info for an event result", + "type": "object", + "properties": { + "model": { + "description": "Model of the client", + "type": "string" + }, + "os": { + "description": "Operating system of the client", + "type": "string" + }, + "type": { + "description": "Type of the client", + "type": "string" + }, + "browser": { + "description": "Browser of the client", + "type": "string" + }, + "ip": { + "description": "IP address of the client", + "type": "string" + }, + "city": { + "description": "City of the client", + "type": "string" + }, + "stateOrProvince": { + "description": "State or province of the client", + "type": "string" + }, + "countryOrRegion": { + "description": "Country or region of the client", + "type": "string" + } + } + }, + "queryParam": { + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "string" + }, + "queryTimespan": { + "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", + "format": "duration" + }, + "applicationsParam": { + "description": "Application IDs to include in cross-application queries.", + "type": "array", + "items": { + "type": "string" + } + }, + "queryBody": { + "description": "Query request body", + "type": "object", + "properties": { + "query": { + "description": "The query to execute.", + "$ref": "#/definitions/queryParam" + }, + "timespan": { + "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.", + "$ref": "#/definitions/queryTimespan" + }, + "applications": { + "description": "A list of applications that are included in the query.", + "$ref": "#/definitions/applicationsParam" + } + }, + "required": [ + "query" + ] + }, + "queryResults": { + "title": "A query response.", + "description": "Contains the tables, columns & rows resulting from a query.", + "type": "object", + "properties": { + "tables": { + "description": "The list of tables, columns and rows.", + "type": "array", + "items": { + "$ref": "#/definitions/table" + } + } + }, + "required": [ + "tables" + ] + }, + "table": { + "title": "A query response table.", + "description": "Contains the columns and rows for one table in a query response.", + "type": "object", + "properties": { + "name": { + "description": "The name of the table.", + "type": "string" + }, + "columns": { + "description": "The list of columns in this table.", + "type": "array", + "items": { + "$ref": "#/definitions/column" + } + }, + "rows": { + "description": "The resulting rows from this query.", + "type": "array", + "items": { "type": "array", - "collectionFormat": "csv", "items": { - "type": "string" - } - }, - "query-body": { - "description": "Query request body", - "type": "object", - "properties": { - "query": { - "$ref": "#/definitions/query-param" - }, - "timespan": { - "$ref": "#/definitions/query-timespan" - }, - "applications": { - "$ref": "#/definitions/applications-param" - } - }, - "required": [ - "query" - ] - }, - "query-results": { - "title": "A query response.", - "description": "Contains the tables, columns & rows resulting from a query.", - "type": "object", - "properties": { - "tables": { - "description": "The list of tables, columns and rows.", - "type": "array", - "items": { - "$ref": "#/definitions/table" - } - } - }, - "required": [ - "tables" - ] - }, - "table": { - "title": "A query response table.", - "description": "Contains the columns and rows for one table in a query response.", - "type": "object", - "properties": { - "name": { - "description": "The name of the table.", - "type": "string" - }, - "columns": { - "description": "The list of columns in this table.", - "type": "array", - "items": { - "$ref": "#/definitions/column" - } - }, - "rows": { - "description": "The resulting rows from this query.", - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "required": [ - "name", - "columns", - "rows" - ] - }, - "column": { - "title": "A table column.", - "description": "A column in a table.", - "type": "object", - "properties": { - "name": { - "description": "The name of this column.", - "type": "string" - }, - "type": { - "description": "The data type of this column.", - "type": "string" - } + "type": "string" } + } + } + }, + "required": [ + "name", + "columns", + "rows" + ] + }, + "column": { + "title": "A table column.", + "description": "A column in a table.", + "type": "object", + "properties": { + "name": { + "description": "The name of this column.", + "type": "string" + }, + "type": { + "description": "The data type of this column.", + "type": "string" + } + } + }, + "errorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + }, + "value": { + "description": "Indicates which value in 'target' is responsible for the error.", + "type": "string" + }, + "resources": { + "description": "Indicates resources which were responsible for the error.", + "type": "array", + "items": { + "type": "string" + } }, - "error-detail": { - "title": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error's code.", - "type": "string" - }, - "message": { - "description": "A human readable error message.", - "type": "string" - }, - "target": { - "description": "Indicates which property in the request is responsible for the error.", - "type": "string" - }, - "value": { - "description": "Indicates which value in 'target' is responsible for the error.", - "type": "string" - }, - "resources": { - "description": "Indicates resources which were responsible for the error.", - "type": "array", - "items": { - "type": "string" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "required": [ - "code", - "message" - ] - }, - "error-info": { - "title": "The code and message for an error.", - "type": "object", - "properties": { - "code": { - "description": "A machine readable error code.", - "type": "string" - }, - "message": { - "description": "A human readable error message.", - "type": "string" - }, - "details": { - "description": "error details.", - "type": "array", - "items": { - "$ref": "#/definitions/error-detail" - } - }, - "innererror": { - "description": "Inner error details if they exist.", - "$ref": "#/definitions/error-info" - }, - "additionalProperties": { - "type": "object" - } - }, - "required": [ - "code", - "message" - ] - }, - "error-response": { - "title": "Error details.", - "description": "Contains details when the response code indicates an error.", - "type": "object", - "properties": { - "error": { - "description": "The error details.", - "$ref": "#/definitions/error-info" - } - }, - "required": [ - "error" - ] + "additionalProperties": { + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "errorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/errorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "$ref": "#/definitions/errorInfo" + }, + "additionalProperties": { + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "errorResponse": { + "title": "Error details.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/errorInfo" } + }, + "required": [ + "error" + ] } + } } \ No newline at end of file From 3f272600338c3861125908107973e4e3985b79fc Mon Sep 17 00:00:00 2001 From: Ace Eldeib Date: Fri, 2 Feb 2018 02:00:30 -0800 Subject: [PATCH 3/6] Update examples --- .../v1/examples/ai-get-metric-example.json | 39 - .../v1/examples/events-get-by-id.json | 67 + .../v1/examples/events-get-by-type.json | 269 ++ .../v1/examples/events-get-metadata.json | 12 + .../v1/examples/metric-get.json | 39 + .../v1/examples/metric-post.json | 101 + .../v1/examples/metrics-get-metadata.json | 2827 +++++++++++++++++ 7 files changed, 3315 insertions(+), 39 deletions(-) delete mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/ai-get-metric-example.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-id.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-type.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-metadata.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metrics-get-metadata.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/ai-get-metric-example.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/ai-get-metric-example.json deleted file mode 100644 index 3a26e1ec8ce0..000000000000 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/ai-get-metric-example.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "title": "Get Metric", - "description": "Gets data for a metric.", - "parameters": { - "app-id": "DEMO_APP", - "metric-id": "requests/failed", - "timespan": "P2D", - "interval": "P1D" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "start": "2016-01-01T02:00:00.000Z", - "end": "2016-01-03T02:00:00.000Z", - "interval": "P1D", - "segments": [ - { - "start": "2016-01-01T02:00:00.000Z", - "end": "2016-01-02T02:00:00.000Z", - "requests/failed": { - "sum": 23 - } - }, - { - "start": "2016-01-02T02:00:00.000Z", - "end": "2016-01-03T02:00:00.000Z", - "requests/failed": { - "sum": 19 - } - } - ] - } - ] - } - } - } -} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-id.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-id.json new file mode 100644 index 000000000000..95bba3026085 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-id.json @@ -0,0 +1,67 @@ +{ + "title": "Get A Specific Events By Type & ID", + "description": "Gets a specific event by type and id.", + "parameters": { + "app-id": "DEMO_APP", + "event-type": "traces", + "event-id": "dc76df01-0141-11e8-9894-e3e7c1eeabad" + }, + "responses": { + "200": { + "body": { + "@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" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-type.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-type.json new file mode 100644 index 000000000000..e2032fae5958 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-type.json @@ -0,0 +1,269 @@ +{ + "title": "Get Events By Type", + "description": "Gets events of a specific type", + "parameters": { + "app-id": "DEMO_APP", + "event-type": "traces", + "event-top": 5 + }, + "responses": { + "200": { + "body": { + "@odata.context": "https://api.applicationinsights.io/v1/apps/DEMO_APP/events/$metadata#traces", + "@ai.messages": [ + { + "code": "AddedLimitToQuery", + "message": "The query was limited to last 12 hours, since no other limit for timestamp field was specified" + } + ], + "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": "", + "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": "" + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "51.140.105.0", + "city": "London", + "stateOrProvince": "England", + "countryOrRegion": "United Kingdom" + } + }, + { + "id": "ca54b09b-0141-11e8-8c76-4de3c2c29f12", + "type": "trace", + "count": 1, + "timestamp": "2018-01-24T20:04:22.799Z", + "customDimensions": null, + "customMeasurements": null, + "operation": { + "name": "GET /FabrikamProd/Employees/Create", + "id": "fYhtYFzAYv4=", + "parentId": "|fYhtYFzAYv4=.c642e1f0_", + "syntheticSource": "Application Insights Availability Monitoring" + }, + "session": { + "id": "e0aca036-2ef0-4c41-adb9-5875625901ee" + }, + "user": { + "id": "us-fl-mia-edge_e0aca036-2ef0-4c41-adb9-5875625901ee", + "accountId": null, + "authenticatedId": null + }, + "cloud": { + "roleName": "", + "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": "" + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "52.173.244.0", + "city": "Des Moines", + "stateOrProvince": "Iowa", + "countryOrRegion": "United States" + } + }, + { + "id": "caf07b61-0141-11e8-bb21-bb0d564a046f", + "type": "trace", + "count": 1, + "timestamp": "2018-01-24T20:04:02.106Z", + "customDimensions": null, + "customMeasurements": null, + "operation": { + "name": "GET /", + "id": "EfIqgW6eLWQ=", + "parentId": "|EfIqgW6eLWQ=.1eb73a79_", + "syntheticSource": "Application Insights Availability Monitoring" + }, + "session": { + "id": "323ab959-4c64-4de4-95e9-04334fbd7749" + }, + "user": { + "id": "apac-hk-hkn-azr_323ab959-4c64-4de4-95e9-04334fbd7749", + "accountId": null, + "authenticatedId": null + }, + "cloud": { + "roleName": "fabrikamfiberapp", + "roleInstance": "RD00155D467E8D" + }, + "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": "AutoGen_49c3aea0-4641-4675-93b5-55f7a62d22d3" + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "52.175.39.0", + "city": "Hong Kong", + "stateOrProvince": "Central and Western District", + "countryOrRegion": "Hong Kong" + } + }, + { + "id": "b8599222-0141-11e8-99cf-07437267f251", + "type": "trace", + "count": 1, + "timestamp": "2018-01-24T20:03:55.554Z", + "customDimensions": null, + "customMeasurements": null, + "operation": { + "name": "GET /", + "id": "7j5dSPYFB5A=", + "parentId": "|7j5dSPYFB5A=.1eb73a78_", + "syntheticSource": "Application Insights Availability Monitoring" + }, + "session": { + "id": "b82a2630-5598-4291-a3db-976117f07490" + }, + "user": { + "id": "us-il-ch1-azr_b82a2630-5598-4291-a3db-976117f07490", + "accountId": null, + "authenticatedId": null + }, + "cloud": { + "roleName": "fabrikamfiberapp", + "roleInstance": "RD00155D467E8D" + }, + "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": "AutoGen_49c3aea0-4641-4675-93b5-55f7a62d22d3" + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "52.237.156.0", + "city": "Chicago", + "stateOrProvince": "Illinois", + "countryOrRegion": "United States" + } + }, + { + "id": "b8599221-0141-11e8-99cf-07437267f251", + "type": "trace", + "count": 1, + "timestamp": "2018-01-24T20:03:37.437Z", + "customDimensions": null, + "customMeasurements": null, + "operation": { + "name": "GET /", + "id": "xoAJ+fhhQQE=", + "parentId": "|xoAJ+fhhQQE=.1eb73a77_", + "syntheticSource": "Application Insights Availability Monitoring" + }, + "session": { + "id": "b2066202-e8cd-47de-8c4c-d4d55f3653a4" + }, + "user": { + "id": "emea-ru-msa-edge_b2066202-e8cd-47de-8c4c-d4d55f3653a4", + "accountId": null, + "authenticatedId": null + }, + "cloud": { + "roleName": "fabrikamfiberapp", + "roleInstance": "RD00155D467E8D" + }, + "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": "AutoGen_49c3aea0-4641-4675-93b5-55f7a62d22d3" + }, + "client": { + "model": null, + "os": null, + "type": "PC", + "browser": null, + "ip": "51.140.79.0", + "city": "London", + "stateOrProvince": "England", + "countryOrRegion": "United Kingdom" + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-metadata.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-metadata.json new file mode 100644 index 000000000000..d7eac414c793 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-metadata.json @@ -0,0 +1,12 @@ +{ + "title": "Get Events Metadata", + "description": "Gets event metadata", + "parameters": { + "app-id": "DEMO_APP" + }, + "responses": { + "200": { + "body": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get.json new file mode 100644 index 000000000000..5f551c8782ee --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get.json @@ -0,0 +1,39 @@ +{ + "title": "Get Metric", + "description": "Gets data for a metric.", + "parameters": { + "app-id": "DEMO_APP", + "metric-id": "requests/failed", + "timespan": "P2D", + "interval": "P1D" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "start": "2016-01-01T02:00:00.000Z", + "end": "2016-01-03T02:00:00.000Z", + "interval": "P1D", + "segments": [ + { + "start": "2016-01-01T02:00:00.000Z", + "end": "2016-01-02T02:00:00.000Z", + "requests/failed": { + "sum": 23 + } + }, + { + "start": "2016-01-02T02:00:00.000Z", + "end": "2016-01-03T02:00:00.000Z", + "requests/failed": { + "sum": 19 + } + } + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json new file mode 100644 index 000000000000..16a02cef2608 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json @@ -0,0 +1,101 @@ +{ + "title": "Get Metric", + "description": "Gets data for a metric.", + "parameters": { + "app-id": "DEMO_APP", + "metricsPostBody": [ + { + "id": "failed", + "parameters": { + "metricId": "requests/failed", + "timespan": "P2D", + "interval": "P1D" + } + }, + { + "id": "count", + "parameters": { + "metricId": "requests/count", + "timespan": "P2D", + "interval": "P1D" + } + } + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "failed", + "status": 200, + "body": { + "value": { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-24T19:59:12.488Z", + "interval": "P1D", + "segments": [ + { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-23T00:00:00.000Z", + "requests/failed": { + "sum": 277 + } + }, + { + "start": "2018-01-23T00:00:00.000Z", + "end": "2018-01-24T00:00:00.000Z", + "requests/failed": { + "sum": 1599 + } + }, + { + "start": "2018-01-24T00:00:00.000Z", + "end": "2018-01-24T19:59:12.488Z", + "requests/failed": { + "sum": 1392 + } + } + ] + } + } + }, + { + "id": "count", + "status": 200, + "body": { + "value": { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-24T19:59:12.488Z", + "interval": "P1D", + "segments": [ + { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-23T00:00:00.000Z", + "requests/count": { + "sum": 1225 + } + }, + { + "start": "2018-01-23T00:00:00.000Z", + "end": "2018-01-24T00:00:00.000Z", + "requests/count": { + "sum": 7382 + } + }, + { + "start": "2018-01-24T00:00:00.000Z", + "end": "2018-01-24T19:59:12.488Z", + "requests/count": { + "sum": 6674 + } + } + ] + } + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metrics-get-metadata.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metrics-get-metadata.json new file mode 100644 index 000000000000..2d997a12bf15 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metrics-get-metadata.json @@ -0,0 +1,2827 @@ +{ + "title": "Get Metric Metadata", + "description": "Gets metadata data for metrics.", + "parameters": { + "app-id": "DEMO_APP" + }, + "responses": { + "200": { + "body": { + "metrics": { + "requests/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Server requests", + "supportedGroupBy": { + "all": [ + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/DeveloperMode" + ] + }, + "defaultAggregation": "sum" + }, + "requests/duration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Server response time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/DeveloperMode" + ] + }, + "defaultAggregation": "avg" + }, + "requests/failed": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Failed requests", + "supportedGroupBy": { + "all": [ + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/DeveloperMode" + ] + }, + "defaultAggregation": "sum" + }, + "pageViews/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Page views", + "supportedGroupBy": { + "all": [ + "pageView/name", + "pageView/urlPath", + "pageView/urlHost", + "pageView/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "sum" + }, + "pageViews/duration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Page view load time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "pageView/name", + "pageView/urlPath", + "pageView/urlHost", + "pageView/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "browserTimings/networkDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Page load network connect time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "browserTimings/sendDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Send request time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "browserTimings/receiveDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Receiving response time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "browserTimings/processingDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Client processing time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "browserTimings/totalDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Browser page load time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "users/count": { + "supportedAggregations": [ + "unique" + ], + "displayName": "Users", + "supportedGroupBy": { + "all": [ + "trace/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "type", + "customDimensions/AgentSession", + "customDimensions/AgentVersion", + "customDimensions/MachineName", + "customDimensions/RunningMode", + "customDimensions/Source", + "customDimensions/AgentAssemblyVersion", + "customDimensions/AgentProcessSession", + "customDimensions/HashedMachineName", + "customDimensions/DataCube", + "customDimensions/DeveloperMode", + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "user/authenticated", + "customDimensions/_MS.ProcessedByMetricExtractors", + "pageView/name", + "pageView/urlPath", + "pageView/urlHost", + "pageView/performanceBucket", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "customDimensions/Container", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customEvent/name", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName", + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "customDimensions/FullTestResultAvailable", + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type", + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket" + ] + }, + "defaultAggregation": "unique" + }, + "users/authenticated": { + "supportedAggregations": [ + "unique" + ], + "displayName": "Users, authenticated", + "supportedGroupBy": { + "all": [ + "trace/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "type", + "customDimensions/AgentSession", + "customDimensions/AgentVersion", + "customDimensions/MachineName", + "customDimensions/RunningMode", + "customDimensions/Source", + "customDimensions/AgentAssemblyVersion", + "customDimensions/AgentProcessSession", + "customDimensions/HashedMachineName", + "customDimensions/DataCube", + "customDimensions/DeveloperMode", + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "user/authenticated", + "customDimensions/_MS.ProcessedByMetricExtractors", + "pageView/name", + "pageView/urlPath", + "pageView/urlHost", + "pageView/performanceBucket", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "customDimensions/Container", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customEvent/name", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName", + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "customDimensions/FullTestResultAvailable", + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type", + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket" + ] + }, + "defaultAggregation": "unique" + }, + "sessions/count": { + "supportedAggregations": [ + "unique" + ], + "displayName": "Sessions", + "supportedGroupBy": { + "all": [ + "trace/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "type", + "customDimensions/AgentSession", + "customDimensions/AgentVersion", + "customDimensions/MachineName", + "customDimensions/RunningMode", + "customDimensions/Source", + "customDimensions/AgentAssemblyVersion", + "customDimensions/AgentProcessSession", + "customDimensions/HashedMachineName", + "customDimensions/DataCube", + "customDimensions/DeveloperMode", + "request/source", + "request/name", + "request/urlHost", + "request/urlPath", + "request/success", + "request/resultCode", + "request/performanceBucket", + "user/authenticated", + "customDimensions/_MS.ProcessedByMetricExtractors", + "pageView/name", + "pageView/urlPath", + "pageView/urlHost", + "pageView/performanceBucket", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "customDimensions/Container", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customEvent/name", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName", + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "customDimensions/FullTestResultAvailable", + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type", + "browserTiming/name", + "browserTiming/urlHost", + "browserTiming/urlPath", + "browserTiming/performanceBucket" + ] + }, + "defaultAggregation": "unique" + }, + "customEvents/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Events", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "sum" + }, + "dependencies/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Dependency calls", + "supportedGroupBy": { + "all": [ + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/Container", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "sum" + }, + "dependencies/failed": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Dependency failures", + "supportedGroupBy": { + "all": [ + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/Container", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "sum" + }, + "dependencies/duration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Dependency duration", + "units": "ms", + "supportedGroupBy": { + "all": [ + "dependency/target", + "dependency/type", + "dependency/name", + "dependency/success", + "dependency/resultCode", + "dependency/performanceBucket", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/Container", + "customDimensions/_MS.ProcessedByMetricExtractors", + "customDimensions/Blob", + "customDimensions/ErrorMessage", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance" + ] + }, + "defaultAggregation": "avg" + }, + "exceptions/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Exceptions", + "supportedGroupBy": { + "all": [ + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/_MS.ProcessedByMetricExtractors" + ] + }, + "defaultAggregation": "sum" + }, + "exceptions/browser": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Browser exceptions", + "supportedGroupBy": { + "all": [ + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/_MS.ProcessedByMetricExtractors" + ] + }, + "defaultAggregation": "sum" + }, + "exceptions/server": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Server exceptions", + "supportedGroupBy": { + "all": [ + "exception/problemId", + "exception/handledAt", + "exception/type", + "exception/assembly", + "exception/method", + "exception/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/url", + "customDimensions/ai.snapshot.stampid", + "customDimensions/ai.snapshot.id", + "customDimensions/ai.snapshot.version", + "customDimensions/DeveloperMode", + "customDimensions/IbizaSessionId", + "customDimensions/PartInstance", + "customDimensions/ai.snapshot.planid", + "customDimensions/_MS.Example", + "customDimensions/_MS.ProcessedByMetricExtractors" + ] + }, + "defaultAggregation": "sum" + }, + "availabilityResults/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Availability test results count", + "supportedGroupBy": { + "all": [ + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/FullTestResultAvailable" + ] + }, + "defaultAggregation": "sum" + }, + "availabilityResults/duration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "Test duration", + "units": "ms", + "supportedGroupBy": { + "all": [ + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/FullTestResultAvailable" + ] + }, + "defaultAggregation": "avg" + }, + "availabilityResults/availabilityPercentage": { + "supportedAggregations": [ + "avg", + "count" + ], + "displayName": "Availability", + "units": "percent", + "supportedGroupBy": { + "all": [ + "availabilityResult/name", + "availabilityResult/location", + "availabilityResult/success", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/FullTestResultAvailable" + ] + }, + "defaultAggregation": "avg" + }, + "billingMeters/telemetryCount": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Data point count", + "supportedGroupBy": { + "all": [ + "billing/telemetryItemSource", + "billing/telemetryItemType" + ] + }, + "defaultAggregation": "sum" + }, + "billingMeters/telemetrySize": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Data point volume", + "units": "bytes", + "supportedGroupBy": { + "all": [ + "billing/telemetryItemSource", + "billing/telemetryItemType" + ] + }, + "defaultAggregation": "sum" + }, + "performanceCounters/requestExecutionTime": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count" + ], + "displayName": "ASP.NET request execution time", + "units": "ms", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/requestsPerSecond": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "ASP.NET request rate", + "units": "perSec", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/requestsInQueue": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "ASP.NET requests in application queue", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/memoryAvailableBytes": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Available memory", + "units": "bytes", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/exceptionsPerSecond": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Exception rate", + "units": "perSec", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/processCpuPercentage": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Process CPU", + "units": "percent", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/processCpuPercentageTotal": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Process CPU (all cores)", + "units": "percent", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/processIOBytesPerSecond": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Process IO rate", + "units": "bytesPerSec", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/processPrivateBytes": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Process private bytes", + "units": "bytes", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/processorCpuPercentage": { + "supportedAggregations": [ + "avg", + "min", + "max", + "count" + ], + "displayName": "Processor time", + "units": "percent", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "traces/count": { + "supportedAggregations": [ + "sum" + ], + "displayName": "Traces", + "supportedGroupBy": { + "all": [ + "trace/severityLevel", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/AgentSession", + "customDimensions/AgentVersion", + "customDimensions/MachineName", + "customDimensions/RunningMode", + "customDimensions/Source", + "customDimensions/AgentAssemblyVersion", + "customDimensions/AgentProcessSession", + "customDimensions/HashedMachineName", + "customDimensions/DataCube", + "customDimensions/DeveloperMode" + ] + }, + "defaultAggregation": "sum" + }, + "customMetrics/Dependency duration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Dependency duration", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/Exceptions thrown": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Exceptions thrown", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/Server response time": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Server response time", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/AzureDependencyFailureRate5Min": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "AzureDependencyFailureRate5Min", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/AzureBlobSuccessRate": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "AzureBlobSuccessRate", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/Customer Lead Time": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Customer Lead Time", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/ChrisRequestDuration": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "ChrisRequestDuration", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/AvgResponseTime": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "AvgResponseTime", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/CriticalOperationFailureRate": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "CriticalOperationFailureRate", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/CritFailureRate2": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "CritFailureRate2", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/Blah": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Blah", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/SyntheticExceptions": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "SyntheticExceptions", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/test01": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "test01", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/PredictedPerformanceOnNextHour": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "PredictedPerformanceOnNextHour", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customMetrics/HeartbeatState": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "HeartbeatState", + "supportedGroupBy": { + "all": [ + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/SA_OriginAppId", + "customDimensions/baseSdkTargetFramework", + "customDimensions/runtimeFramework", + "customDimensions/DeveloperMode", + "customDimensions/_MS.AggregationIntervalMs", + "customDimensions/problemId", + "customDimensions/operationName", + "customDimensions/Request.Success", + "customDimensions/_MS.MetricId", + "customDimensions/Dependency.Success", + "customDimensions/_MS.IsAutocollected", + "customDimensions/Dependency.Type" + ] + }, + "defaultAggregation": "avg" + }, + "customEvents/custom/ProcessPagedMemoryInMB": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "ProcessPagedMemoryInMB", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "avg" + }, + "customEvents/custom/ProcessWorkingSetInMB": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "ProcessWorkingSetInMB", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "avg" + }, + "customEvents/custom/DurationInSeconds": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "DurationInSeconds", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "avg" + }, + "customEvents/custom/sizeInMB": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "sizeInMB", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "avg" + }, + "customEvents/custom/Completion Time": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "Completion Time", + "supportedGroupBy": { + "all": [ + "customEvent/name", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/EventName", + "customDimensions/Page Title", + "customDimensions/ServiceProfilerContent", + "customDimensions/ExecutingAssemblyFileVersion", + "customDimensions/ServiceProfilerVersion", + "customDimensions/DeveloperMode", + "customDimensions/ProcessId", + "customDimensions/RequestId", + "customDimensions/RunningSession", + "customDimensions/ProblemId", + "customDimensions/SnapshotContext", + "customDimensions/SnapshotVersion", + "customDimensions/Duration", + "customDimensions/SnapshotId", + "customDimensions/StampId", + "customDimensions/DeOptimizationId", + "customDimensions/Method", + "customDimensions/parentProcessId", + "customDimensions/Section", + "customDimensions/Configuration", + "customDimensions/dumpFolder", + "customDimensions/Reason", + "customDimensions/ExtensionVersion", + "customDimensions/SiteName" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/\\Process(??APP_WIN32_PROC??)\\% Processor Time Normalized": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "\\Process(??APP_WIN32_PROC??)\\% Processor Time Normalized", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + }, + "performanceCounters/% Processor Time Normalized": { + "supportedAggregations": [ + "avg", + "min", + "max", + "sum", + "count", + "unique" + ], + "displayName": "% Processor Time Normalized", + "supportedGroupBy": { + "all": [ + "performanceCounter/name", + "performanceCounter/category", + "performanceCounter/counter", + "performanceCounter/instance", + "operation/name", + "operation/synthetic", + "operation/syntheticSource", + "user/authenticated", + "application/version", + "client/type", + "client/model", + "client/os", + "client/city", + "client/stateOrProvince", + "client/countryOrRegion", + "client/browser", + "cloud/roleName", + "cloud/roleInstance", + "customDimensions/CounterInstanceName", + "customDimensions/CustomPerfCounter" + ] + }, + "defaultAggregation": "avg" + } + }, + "dimensions": { + "request/source": { + "displayName": "Request source" + }, + "request/name": { + "displayName": "Request name" + }, + "request/urlHost": { + "displayName": "Request URL host" + }, + "request/urlPath": { + "displayName": "Request URL path" + }, + "request/success": { + "displayName": "Successful request" + }, + "request/resultCode": { + "displayName": "Response code" + }, + "request/performanceBucket": { + "displayName": "Performance" + }, + "operation/name": { + "displayName": "Operation name" + }, + "operation/synthetic": { + "displayName": "Real or synthetic traffic" + }, + "operation/syntheticSource": { + "displayName": "Source of synthetic traffic" + }, + "user/authenticated": { + "displayName": "Authenticated user" + }, + "application/version": { + "displayName": "Application version" + }, + "client/type": { + "displayName": "Device type" + }, + "client/model": { + "displayName": "Device model" + }, + "client/os": { + "displayName": "Operating system" + }, + "client/city": { + "displayName": "City" + }, + "client/stateOrProvince": { + "displayName": "State or province" + }, + "client/countryOrRegion": { + "displayName": "Country or region" + }, + "client/browser": { + "displayName": "Browser version" + }, + "cloud/roleName": { + "displayName": "Cloud role name" + }, + "cloud/roleInstance": { + "displayName": "Cloud role instance" + }, + "customDimensions/_MS.ProcessedByMetricExtractors": { + "displayName": "_MS.ProcessedByMetricExtractors" + }, + "customDimensions/DeveloperMode": { + "displayName": "DeveloperMode" + }, + "pageView/name": { + "displayName": "View page name" + }, + "pageView/urlPath": { + "displayName": "Page view URL path" + }, + "pageView/urlHost": { + "displayName": "Page view URL host" + }, + "pageView/performanceBucket": { + "displayName": "Performance" + }, + "customDimensions/IbizaSessionId": { + "displayName": "IbizaSessionId" + }, + "customDimensions/PartInstance": { + "displayName": "PartInstance" + }, + "browserTiming/name": { + "displayName": "Name" + }, + "browserTiming/urlHost": { + "displayName": "Url host" + }, + "browserTiming/urlPath": { + "displayName": "Url path" + }, + "browserTiming/performanceBucket": { + "displayName": "Performance Bucket" + }, + "trace/severityLevel": { + "displayName": "Severity level" + }, + "type": { + "displayName": "Telemetry type" + }, + "customDimensions/AgentSession": { + "displayName": "AgentSession" + }, + "customDimensions/AgentVersion": { + "displayName": "AgentVersion" + }, + "customDimensions/MachineName": { + "displayName": "MachineName" + }, + "customDimensions/RunningMode": { + "displayName": "RunningMode" + }, + "customDimensions/Source": { + "displayName": "Source" + }, + "customDimensions/AgentAssemblyVersion": { + "displayName": "AgentAssemblyVersion" + }, + "customDimensions/AgentProcessSession": { + "displayName": "AgentProcessSession" + }, + "customDimensions/HashedMachineName": { + "displayName": "HashedMachineName" + }, + "customDimensions/DataCube": { + "displayName": "DataCube" + }, + "dependency/target": { + "displayName": "Base name" + }, + "dependency/type": { + "displayName": "Dependency type" + }, + "dependency/name": { + "displayName": "Remote dependency name" + }, + "dependency/success": { + "displayName": "Dependency call status" + }, + "dependency/resultCode": { + "displayName": "Result code" + }, + "dependency/performanceBucket": { + "displayName": "Performance" + }, + "customDimensions/Container": { + "displayName": "Container" + }, + "customDimensions/Blob": { + "displayName": "Blob" + }, + "customDimensions/ErrorMessage": { + "displayName": "ErrorMessage" + }, + "customEvent/name": { + "displayName": "Event name" + }, + "customDimensions/EventName": { + "displayName": "EventName" + }, + "customDimensions/Page Title": { + "displayName": "Page Title" + }, + "customDimensions/ServiceProfilerContent": { + "displayName": "ServiceProfilerContent" + }, + "customDimensions/ExecutingAssemblyFileVersion": { + "displayName": "ExecutingAssemblyFileVersion" + }, + "customDimensions/ServiceProfilerVersion": { + "displayName": "ServiceProfilerVersion" + }, + "customDimensions/ProcessId": { + "displayName": "ProcessId" + }, + "customDimensions/RequestId": { + "displayName": "RequestId" + }, + "customDimensions/RunningSession": { + "displayName": "RunningSession" + }, + "customDimensions/ProblemId": { + "displayName": "ProblemId" + }, + "customDimensions/SnapshotContext": { + "displayName": "SnapshotContext" + }, + "customDimensions/SnapshotVersion": { + "displayName": "SnapshotVersion" + }, + "customDimensions/Duration": { + "displayName": "Duration" + }, + "customDimensions/SnapshotId": { + "displayName": "SnapshotId" + }, + "customDimensions/StampId": { + "displayName": "StampId" + }, + "customDimensions/DeOptimizationId": { + "displayName": "DeOptimizationId" + }, + "customDimensions/Method": { + "displayName": "Method" + }, + "customDimensions/parentProcessId": { + "displayName": "parentProcessId" + }, + "customDimensions/Section": { + "displayName": "Section" + }, + "customDimensions/Configuration": { + "displayName": "Configuration" + }, + "customDimensions/dumpFolder": { + "displayName": "dumpFolder" + }, + "customDimensions/Reason": { + "displayName": "Reason" + }, + "customDimensions/ExtensionVersion": { + "displayName": "ExtensionVersion" + }, + "customDimensions/SiteName": { + "displayName": "SiteName" + }, + "availabilityResult/name": { + "displayName": "Test name" + }, + "availabilityResult/location": { + "displayName": "Run location" + }, + "availabilityResult/success": { + "displayName": "Test result" + }, + "customDimensions/FullTestResultAvailable": { + "displayName": "FullTestResultAvailable" + }, + "exception/problemId": { + "displayName": "Problem Id" + }, + "exception/handledAt": { + "displayName": "Handled at" + }, + "exception/type": { + "displayName": "Exception type" + }, + "exception/assembly": { + "displayName": "Assembly" + }, + "exception/method": { + "displayName": "Failed method" + }, + "exception/severityLevel": { + "displayName": "Severity level" + }, + "customDimensions/url": { + "displayName": "url" + }, + "customDimensions/ai.snapshot.stampid": { + "displayName": "ai.snapshot.stampid" + }, + "customDimensions/ai.snapshot.id": { + "displayName": "ai.snapshot.id" + }, + "customDimensions/ai.snapshot.version": { + "displayName": "ai.snapshot.version" + }, + "customDimensions/ai.snapshot.planid": { + "displayName": "ai.snapshot.planid" + }, + "customDimensions/_MS.Example": { + "displayName": "_MS.Example" + }, + "customDimensions/SA_OriginAppId": { + "displayName": "SA_OriginAppId" + }, + "customDimensions/baseSdkTargetFramework": { + "displayName": "baseSdkTargetFramework" + }, + "customDimensions/runtimeFramework": { + "displayName": "runtimeFramework" + }, + "customDimensions/_MS.AggregationIntervalMs": { + "displayName": "_MS.AggregationIntervalMs" + }, + "customDimensions/problemId": { + "displayName": "problemId" + }, + "customDimensions/operationName": { + "displayName": "operationName" + }, + "customDimensions/Request.Success": { + "displayName": "Request.Success" + }, + "customDimensions/_MS.MetricId": { + "displayName": "_MS.MetricId" + }, + "customDimensions/Dependency.Success": { + "displayName": "Dependency.Success" + }, + "customDimensions/_MS.IsAutocollected": { + "displayName": "_MS.IsAutocollected" + }, + "customDimensions/Dependency.Type": { + "displayName": "Dependency.Type" + }, + "billing/telemetryItemSource": { + "displayName": "Telemetry item source" + }, + "billing/telemetryItemType": { + "displayName": "Telemetry item type" + }, + "performanceCounter/name": { + "displayName": "Name" + }, + "performanceCounter/category": { + "displayName": "Category name" + }, + "performanceCounter/counter": { + "displayName": "Counter" + }, + "performanceCounter/instance": { + "displayName": "Instance name" + }, + "customDimensions/CounterInstanceName": { + "displayName": "CounterInstanceName" + }, + "customDimensions/CustomPerfCounter": { + "displayName": "CustomPerfCounter" + } + } + } + } + } +} \ No newline at end of file From b45ccbeab92dbf75a5237d34007d7d91c8bd07f8 Mon Sep 17 00:00:00 2001 From: Ace Eldeib Date: Fri, 2 Feb 2018 06:31:35 -0800 Subject: [PATCH 4/6] Fixing validation errors --- .../microsoft.insights/v1/AppInsights.json | 101 +- .../v1/examples/metric-post.json | 4 +- .../v1/examples/query-get.json | 254 +++ .../v1/examples/query-post.json | 90 + .../v1/examples/query-schema.json | 1938 ++++++++++++++++ .../data-plane/microsoft.insights/v1/tmp.json | 2024 +++++++++++++++++ 6 files changed, 4389 insertions(+), 22 deletions(-) create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-get.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-post.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-schema.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/tmp.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json index 3c109b5ec76b..8081c325fe7c 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json @@ -52,7 +52,7 @@ "description": "Gets metric values for a single metric", "x-ms-examples": { "simpleMetric": { - "$ref": "examples/ai-get-metric-example.json" + "$ref": "examples/metric-get.json" } }, "parameters": [ @@ -105,6 +105,11 @@ "operationId": "GetMetrics", "summary": "Retrieve metric data", "description": "Gets metric values for multiple metrics", + "x-ms-examples": { + "postMetric": { + "$ref": "examples/metric-post.json" + } + }, "parameters": [ { "$ref": "#/parameters/appId" @@ -134,6 +139,11 @@ "operationId": "GetMetricsMetadata", "summary": "Retrieve metric metatadata", "description": "Gets metadata describing the available metrics", + "x-ms-examples": { + "metricMetadata": { + "$ref": "examples/metrics-get-metadata.json" + } + }, "parameters": [ { "$ref": "#/parameters/appId" @@ -160,6 +170,11 @@ "operationId": "GetEvents", "summary": "Execute OData query", "description": "Executes an OData query for events", + "x-ms-examples": { + "eventByType": { + "$ref": "examples/events-get-by-type.json" + } + }, "parameters": [ { "$ref": "#/parameters/appId" @@ -224,6 +239,11 @@ "operationId": "GetEvent", "summary": "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/appId" @@ -265,6 +285,11 @@ "operationId": "GetEventsMetadataOData", "summary": "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/appId" @@ -294,6 +319,11 @@ "operationId": "GetQuery", "summary": "Execute an Analytics query", "description": "Executes an Analytics query for data", + "x-ms-examples": { + "queryGet": { + "$ref": "examples/query-get.json" + } + }, "parameters": [ { "$ref": "#/parameters/appId" @@ -324,6 +354,11 @@ "operationId": "Query", "summary": "Execute an Analytics query", "description": "Executes an Analytics query for data. [Here](/documentation/2-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/appId" @@ -356,6 +391,11 @@ "operationId": "GetQuerySchema", "summary": "Get Analytics query metadata", "description": "Gets Analytics query schema describing the data model", + "x-ms-examples": { + "querySchema": { + "$ref": "examples/query-schema.json" + } + }, "parameters": [ { "$ref": "#/parameters/appId" @@ -365,7 +405,7 @@ "200": { "description": "Successful responses", "schema": { - "type": "object" + "$ref": "#/definitions/queryResults" } }, "default": { @@ -558,8 +598,7 @@ "required": true, "x-ms-parameter-location": "method", "description": "ID of event.", - "type": "string", - "format": "uuid" + "type": "string" }, "eventsTimespan": { "name": "timespan", @@ -934,8 +973,7 @@ }, "eventId": { "description": "ID of event.", - "type": "string", - "format": "uuid" + "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.", @@ -1023,24 +1061,47 @@ "properties": { "id": { "description": "The unique ID for this event.", - "type": "string", - "format": "uuid" + "type": "string" }, "type": { "description": "The type of event.", "type": "string", - "enum": [ - "trace", - "customEvent", - "pageView", - "browserTiming", - "request", - "dependency", - "exception", - "availabilityResult", - "performanceCounter", - "customMetric" - ] + "x-ms-enum": { + "name": "EventType", + "modelAsString": true, + "values": [ + { + "value": "trace" + }, + { + "value": "customEvent" + }, + { + "value": "pageView" + }, + { + "value": "browserTiming" + }, + { + "value": "request" + }, + { + "value": "dependency" + }, + { + "value": "exception" + }, + { + "value": "availabilityResult" + }, + { + "value": "performanceCounter" + }, + { + "value": "customMetric" + } + ] + } }, "count": { "description": "Count of the event", diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json index 16a02cef2608..a6bf8752cda0 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json @@ -1,6 +1,6 @@ { - "title": "Get Metric", - "description": "Gets data for a metric.", + "title": "Post Metric", + "description": "Posts data for a metric.", "parameters": { "app-id": "DEMO_APP", "metricsPostBody": [ diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-get.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-get.json new file mode 100644 index 000000000000..29a368de9a45 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-get.json @@ -0,0 +1,254 @@ +{ + "title": "Get Query", + "description": "A simple query that returns query results.", + "parameters": { + "app-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "query": "requests | take 10", + "timespan": "PT12H" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5", + "x-ms-correlation-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5" + }, + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "timestamp", + "type": "datetime" + }, + { + "name": "id", + "type": "string" + }, + { + "name": "source", + "type": "string" + }, + { + "name": "name", + "type": "string" + }, + { + "name": "url", + "type": "string" + }, + { + "name": "success", + "type": "string" + }, + { + "name": "resultCode", + "type": "string" + }, + { + "name": "duration", + "type": "real" + }, + { + "name": "performanceBucket", + "type": "string" + }, + { + "name": "customDimensions", + "type": "dynamic" + }, + { + "name": "customMeasurements", + "type": "dynamic" + }, + { + "name": "operation_Name", + "type": "string" + }, + { + "name": "operation_Id", + "type": "string" + }, + { + "name": "operation_ParentId", + "type": "string" + }, + { + "name": "operation_SyntheticSource", + "type": "string" + }, + { + "name": "session_Id", + "type": "string" + }, + { + "name": "user_Id", + "type": "string" + }, + { + "name": "user_AuthenticatedId", + "type": "string" + }, + { + "name": "user_AccountId", + "type": "string" + }, + { + "name": "application_Version", + "type": "string" + }, + { + "name": "client_Type", + "type": "string" + }, + { + "name": "client_Model", + "type": "string" + }, + { + "name": "client_OS", + "type": "string" + }, + { + "name": "client_IP", + "type": "string" + }, + { + "name": "client_City", + "type": "string" + }, + { + "name": "client_StateOrProvince", + "type": "string" + }, + { + "name": "client_CountryOrRegion", + "type": "string" + }, + { + "name": "client_Browser", + "type": "string" + }, + { + "name": "cloud_RoleName", + "type": "string" + }, + { + "name": "cloud_RoleInstance", + "type": "string" + }, + { + "name": "appId", + "type": "string" + }, + { + "name": "appName", + "type": "string" + }, + { + "name": "iKey", + "type": "string" + }, + { + "name": "sdkVersion", + "type": "string" + }, + { + "name": "itemId", + "type": "string" + }, + { + "name": "itemType", + "type": "string" + }, + { + "name": "itemCount", + "type": "int" + } + ], + "rows": [ + [ + "2018-02-01T17:33:09.788Z", + "|0qRud6jz3k0=.c32c2659_", + null, + "GET Reports/Index", + "http://fabrikamfiberapp.azurewebsites.net/Reports", + "True", + "200", + 3.3833, + "<250ms", + "{\"_MS.ProcessedByMetricExtractors\":\"(Name:'Requests', Ver:'1.0')\"}", + null, + "GET Reports/Index", + "0qRud6jz3k0=", + "0qRud6jz3k0=", + "Application Insights Availability Monitoring", + "9fc6738d-7e26-44f0-b88e-6fae8ccb6b26", + "us-va-ash-azr_9fc6738d-7e26-44f0-b88e-6fae8ccb6b26", + null, + null, + "AutoGen_49c3aea0-4641-4675-93b5-55f7a62d22d3", + "PC", + null, + null, + "52.168.8.0", + "Boydton", + "Virginia", + "United States", + null, + "fabrikamfiberapp", + "RD00155D5053D1", + "cf58dcfd-0683-487c-bc84-048789bca8e5", + "fabrikamprod", + "5a2e4e0c-e136-4a15-9824-90ba859b0a89", + "web:2.5.0-33031", + "051ad4ef-0776-11e8-ac6e-e30599af6943", + "request", + 1 + ], + [ + "2018-02-01T17:33:15.786Z", + "|x/Ysh+M1TfU=.c32c265a_", + null, + "GET Home/Index", + "http://fabrikamfiberapp.azurewebsites.net/", + "True", + "200", + 716.2912, + "500ms-1sec", + "{\"_MS.ProcessedByMetricExtractors\":\"(Name:'Requests', Ver:'1.0')\"}", + null, + "GET Home/Index", + "x/Ysh+M1TfU=", + "x/Ysh+M1TfU=", + "Application Insights Availability Monitoring", + "58b15be6-d1e6-4d89-9919-52f63b840913", + "emea-se-sto-edge_58b15be6-d1e6-4d89-9919-52f63b840913", + null, + null, + "AutoGen_49c3aea0-4641-4675-93b5-55f7a62d22d3", + "PC", + null, + null, + "51.141.32.0", + "Cardiff", + "Cardiff", + "United Kingdom", + null, + "fabrikamfiberapp", + "RD00155D5053D1", + "cf58dcfd-0683-487c-bc84-048789bca8e5", + "fabrikamprod", + "5a2e4e0c-e136-4a15-9824-90ba859b0a89", + "web:2.5.0-33031", + "051ad4f0-0776-11e8-ac6e-e30599af6943", + "request", + 1 + ] + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-post.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-post.json new file mode 100644 index 000000000000..bb731b028d2f --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-post.json @@ -0,0 +1,90 @@ +{ + "title": "Get Query", + "description": "A simple query that returns query results.", + "parameters": { + "app-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "body": { + "timespan": "PT12H", + "query": "requests | summarize count() by bin(timestamp, 1h)" + } + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5", + "x-ms-correlation-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5" + }, + "body": { + "tables": [ + { + "name": "PrimaryResult", + "columns": [ + { + "name": "timestamp", + "type": "datetime" + }, + { + "name": "count_", + "type": "long" + } + ], + "rows": [ + [ + "2018-02-02T05:00:00Z", + 255 + ], + [ + "2018-02-01T17:00:00Z", + 148 + ], + [ + "2018-02-01T18:00:00Z", + 453 + ], + [ + "2018-02-01T19:00:00Z", + 404 + ], + [ + "2018-02-01T20:00:00Z", + 403 + ], + [ + "2018-02-01T21:00:00Z", + 405 + ], + [ + "2018-02-01T22:00:00Z", + 438 + ], + [ + "2018-02-01T23:00:00Z", + 403 + ], + [ + "2018-02-02T00:00:00Z", + 423 + ], + [ + "2018-02-02T01:00:00Z", + 403 + ], + [ + "2018-02-02T02:00:00Z", + 425 + ], + [ + "2018-02-02T03:00:00Z", + 437 + ], + [ + "2018-02-02T04:00:00Z", + 420 + ] + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-schema.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-schema.json new file mode 100644 index 000000000000..1a79593a8ed0 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-schema.json @@ -0,0 +1,1938 @@ +{ + "title": "Get Query", + "description": "A simple query that returns query results.", + "parameters": { + "app-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5", + "x-ms-correlation-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5" + }, + "body": { + "Tables": [ + { + "TableName": "Table_0", + "Columns": [ + { + "ColumnName": "TableName", + "DataType": "String" + }, + { + "ColumnName": "ColumnName", + "DataType": "String" + }, + { + "ColumnName": "ColumnType", + "DataType": "String" + } + ], + "Rows": [ + [ + "traces", + "timestamp", + "System.DateTime" + ], + [ + "traces", + "message", + "System.String" + ], + [ + "traces", + "severityLevel", + "System.Int32" + ], + [ + "traces", + "customDimensions", + "System.Object" + ], + [ + "traces", + "customMeasurements", + "System.Object" + ], + [ + "traces", + "operation_Name", + "System.String" + ], + [ + "traces", + "operation_Id", + "System.String" + ], + [ + "traces", + "operation_ParentId", + "System.String" + ], + [ + "traces", + "operation_SyntheticSource", + "System.String" + ], + [ + "traces", + "session_Id", + "System.String" + ], + [ + "traces", + "user_Id", + "System.String" + ], + [ + "traces", + "user_AuthenticatedId", + "System.String" + ], + [ + "traces", + "user_AccountId", + "System.String" + ], + [ + "traces", + "application_Version", + "System.String" + ], + [ + "traces", + "client_Type", + "System.String" + ], + [ + "traces", + "client_Model", + "System.String" + ], + [ + "traces", + "client_OS", + "System.String" + ], + [ + "traces", + "client_IP", + "System.String" + ], + [ + "traces", + "client_City", + "System.String" + ], + [ + "traces", + "client_StateOrProvince", + "System.String" + ], + [ + "traces", + "client_CountryOrRegion", + "System.String" + ], + [ + "traces", + "client_Browser", + "System.String" + ], + [ + "traces", + "cloud_RoleName", + "System.String" + ], + [ + "traces", + "cloud_RoleInstance", + "System.String" + ], + [ + "traces", + "appId", + "System.String" + ], + [ + "traces", + "appName", + "System.String" + ], + [ + "traces", + "iKey", + "System.String" + ], + [ + "traces", + "sdkVersion", + "System.String" + ], + [ + "traces", + "itemId", + "System.String" + ], + [ + "traces", + "itemType", + "System.String" + ], + [ + "traces", + "itemCount", + "System.Double" + ], + [ + "customEvents", + "timestamp", + "System.DateTime" + ], + [ + "customEvents", + "name", + "System.String" + ], + [ + "customEvents", + "customDimensions", + "System.Object" + ], + [ + "customEvents", + "customMeasurements", + "System.Object" + ], + [ + "customEvents", + "operation_Name", + "System.String" + ], + [ + "customEvents", + "operation_Id", + "System.String" + ], + [ + "customEvents", + "operation_ParentId", + "System.String" + ], + [ + "customEvents", + "operation_SyntheticSource", + "System.String" + ], + [ + "customEvents", + "session_Id", + "System.String" + ], + [ + "customEvents", + "user_Id", + "System.String" + ], + [ + "customEvents", + "user_AuthenticatedId", + "System.String" + ], + [ + "customEvents", + "user_AccountId", + "System.String" + ], + [ + "customEvents", + "application_Version", + "System.String" + ], + [ + "customEvents", + "client_Type", + "System.String" + ], + [ + "customEvents", + "client_Model", + "System.String" + ], + [ + "customEvents", + "client_OS", + "System.String" + ], + [ + "customEvents", + "client_IP", + "System.String" + ], + [ + "customEvents", + "client_City", + "System.String" + ], + [ + "customEvents", + "client_StateOrProvince", + "System.String" + ], + [ + "customEvents", + "client_CountryOrRegion", + "System.String" + ], + [ + "customEvents", + "client_Browser", + "System.String" + ], + [ + "customEvents", + "cloud_RoleName", + "System.String" + ], + [ + "customEvents", + "cloud_RoleInstance", + "System.String" + ], + [ + "customEvents", + "appId", + "System.String" + ], + [ + "customEvents", + "appName", + "System.String" + ], + [ + "customEvents", + "iKey", + "System.String" + ], + [ + "customEvents", + "sdkVersion", + "System.String" + ], + [ + "customEvents", + "itemId", + "System.String" + ], + [ + "customEvents", + "itemType", + "System.String" + ], + [ + "customEvents", + "itemCount", + "System.Double" + ], + [ + "pageViews", + "timestamp", + "System.DateTime" + ], + [ + "pageViews", + "name", + "System.String" + ], + [ + "pageViews", + "url", + "System.String" + ], + [ + "pageViews", + "duration", + "System.Double" + ], + [ + "pageViews", + "performanceBucket", + "System.String" + ], + [ + "pageViews", + "customDimensions", + "System.Object" + ], + [ + "pageViews", + "customMeasurements", + "System.Object" + ], + [ + "pageViews", + "operation_Name", + "System.String" + ], + [ + "pageViews", + "operation_Id", + "System.String" + ], + [ + "pageViews", + "operation_ParentId", + "System.String" + ], + [ + "pageViews", + "operation_SyntheticSource", + "System.String" + ], + [ + "pageViews", + "session_Id", + "System.String" + ], + [ + "pageViews", + "user_Id", + "System.String" + ], + [ + "pageViews", + "user_AuthenticatedId", + "System.String" + ], + [ + "pageViews", + "user_AccountId", + "System.String" + ], + [ + "pageViews", + "application_Version", + "System.String" + ], + [ + "pageViews", + "client_Type", + "System.String" + ], + [ + "pageViews", + "client_Model", + "System.String" + ], + [ + "pageViews", + "client_OS", + "System.String" + ], + [ + "pageViews", + "client_IP", + "System.String" + ], + [ + "pageViews", + "client_City", + "System.String" + ], + [ + "pageViews", + "client_StateOrProvince", + "System.String" + ], + [ + "pageViews", + "client_CountryOrRegion", + "System.String" + ], + [ + "pageViews", + "client_Browser", + "System.String" + ], + [ + "pageViews", + "cloud_RoleName", + "System.String" + ], + [ + "pageViews", + "cloud_RoleInstance", + "System.String" + ], + [ + "pageViews", + "appId", + "System.String" + ], + [ + "pageViews", + "appName", + "System.String" + ], + [ + "pageViews", + "iKey", + "System.String" + ], + [ + "pageViews", + "sdkVersion", + "System.String" + ], + [ + "pageViews", + "itemId", + "System.String" + ], + [ + "pageViews", + "itemType", + "System.String" + ], + [ + "pageViews", + "itemCount", + "System.Double" + ], + [ + "requests", + "timestamp", + "System.DateTime" + ], + [ + "requests", + "id", + "System.String" + ], + [ + "requests", + "source", + "System.String" + ], + [ + "requests", + "name", + "System.String" + ], + [ + "requests", + "url", + "System.String" + ], + [ + "requests", + "success", + "System.String" + ], + [ + "requests", + "resultCode", + "System.String" + ], + [ + "requests", + "duration", + "System.Double" + ], + [ + "requests", + "performanceBucket", + "System.String" + ], + [ + "requests", + "customDimensions", + "System.Object" + ], + [ + "requests", + "customMeasurements", + "System.Object" + ], + [ + "requests", + "operation_Name", + "System.String" + ], + [ + "requests", + "operation_Id", + "System.String" + ], + [ + "requests", + "operation_ParentId", + "System.String" + ], + [ + "requests", + "operation_SyntheticSource", + "System.String" + ], + [ + "requests", + "session_Id", + "System.String" + ], + [ + "requests", + "user_Id", + "System.String" + ], + [ + "requests", + "user_AuthenticatedId", + "System.String" + ], + [ + "requests", + "user_AccountId", + "System.String" + ], + [ + "requests", + "application_Version", + "System.String" + ], + [ + "requests", + "client_Type", + "System.String" + ], + [ + "requests", + "client_Model", + "System.String" + ], + [ + "requests", + "client_OS", + "System.String" + ], + [ + "requests", + "client_IP", + "System.String" + ], + [ + "requests", + "client_City", + "System.String" + ], + [ + "requests", + "client_StateOrProvince", + "System.String" + ], + [ + "requests", + "client_CountryOrRegion", + "System.String" + ], + [ + "requests", + "client_Browser", + "System.String" + ], + [ + "requests", + "cloud_RoleName", + "System.String" + ], + [ + "requests", + "cloud_RoleInstance", + "System.String" + ], + [ + "requests", + "appId", + "System.String" + ], + [ + "requests", + "appName", + "System.String" + ], + [ + "requests", + "iKey", + "System.String" + ], + [ + "requests", + "sdkVersion", + "System.String" + ], + [ + "requests", + "itemId", + "System.String" + ], + [ + "requests", + "itemType", + "System.String" + ], + [ + "requests", + "itemCount", + "System.Double" + ], + [ + "dependencies", + "timestamp", + "System.DateTime" + ], + [ + "dependencies", + "id", + "System.String" + ], + [ + "dependencies", + "target", + "System.String" + ], + [ + "dependencies", + "type", + "System.String" + ], + [ + "dependencies", + "name", + "System.String" + ], + [ + "dependencies", + "data", + "System.String" + ], + [ + "dependencies", + "success", + "System.String" + ], + [ + "dependencies", + "resultCode", + "System.String" + ], + [ + "dependencies", + "duration", + "System.Double" + ], + [ + "dependencies", + "performanceBucket", + "System.String" + ], + [ + "dependencies", + "customDimensions", + "System.Object" + ], + [ + "dependencies", + "customMeasurements", + "System.Object" + ], + [ + "dependencies", + "operation_Name", + "System.String" + ], + [ + "dependencies", + "operation_Id", + "System.String" + ], + [ + "dependencies", + "operation_ParentId", + "System.String" + ], + [ + "dependencies", + "operation_SyntheticSource", + "System.String" + ], + [ + "dependencies", + "session_Id", + "System.String" + ], + [ + "dependencies", + "user_Id", + "System.String" + ], + [ + "dependencies", + "user_AuthenticatedId", + "System.String" + ], + [ + "dependencies", + "user_AccountId", + "System.String" + ], + [ + "dependencies", + "application_Version", + "System.String" + ], + [ + "dependencies", + "client_Type", + "System.String" + ], + [ + "dependencies", + "client_Model", + "System.String" + ], + [ + "dependencies", + "client_OS", + "System.String" + ], + [ + "dependencies", + "client_IP", + "System.String" + ], + [ + "dependencies", + "client_City", + "System.String" + ], + [ + "dependencies", + "client_StateOrProvince", + "System.String" + ], + [ + "dependencies", + "client_CountryOrRegion", + "System.String" + ], + [ + "dependencies", + "client_Browser", + "System.String" + ], + [ + "dependencies", + "cloud_RoleName", + "System.String" + ], + [ + "dependencies", + "cloud_RoleInstance", + "System.String" + ], + [ + "dependencies", + "appId", + "System.String" + ], + [ + "dependencies", + "appName", + "System.String" + ], + [ + "dependencies", + "iKey", + "System.String" + ], + [ + "dependencies", + "sdkVersion", + "System.String" + ], + [ + "dependencies", + "itemId", + "System.String" + ], + [ + "dependencies", + "itemType", + "System.String" + ], + [ + "dependencies", + "itemCount", + "System.Double" + ], + [ + "exceptions", + "timestamp", + "System.DateTime" + ], + [ + "exceptions", + "problemId", + "System.String" + ], + [ + "exceptions", + "handledAt", + "System.String" + ], + [ + "exceptions", + "type", + "System.String" + ], + [ + "exceptions", + "message", + "System.String" + ], + [ + "exceptions", + "assembly", + "System.String" + ], + [ + "exceptions", + "method", + "System.String" + ], + [ + "exceptions", + "outerType", + "System.String" + ], + [ + "exceptions", + "outerMessage", + "System.String" + ], + [ + "exceptions", + "outerAssembly", + "System.String" + ], + [ + "exceptions", + "outerMethod", + "System.String" + ], + [ + "exceptions", + "innermostType", + "System.String" + ], + [ + "exceptions", + "innermostMessage", + "System.String" + ], + [ + "exceptions", + "innermostAssembly", + "System.String" + ], + [ + "exceptions", + "innermostMethod", + "System.String" + ], + [ + "exceptions", + "severityLevel", + "System.Int32" + ], + [ + "exceptions", + "details", + "System.Object" + ], + [ + "exceptions", + "customDimensions", + "System.Object" + ], + [ + "exceptions", + "customMeasurements", + "System.Object" + ], + [ + "exceptions", + "operation_Name", + "System.String" + ], + [ + "exceptions", + "operation_Id", + "System.String" + ], + [ + "exceptions", + "operation_ParentId", + "System.String" + ], + [ + "exceptions", + "operation_SyntheticSource", + "System.String" + ], + [ + "exceptions", + "session_Id", + "System.String" + ], + [ + "exceptions", + "user_Id", + "System.String" + ], + [ + "exceptions", + "user_AuthenticatedId", + "System.String" + ], + [ + "exceptions", + "user_AccountId", + "System.String" + ], + [ + "exceptions", + "application_Version", + "System.String" + ], + [ + "exceptions", + "client_Type", + "System.String" + ], + [ + "exceptions", + "client_Model", + "System.String" + ], + [ + "exceptions", + "client_OS", + "System.String" + ], + [ + "exceptions", + "client_IP", + "System.String" + ], + [ + "exceptions", + "client_City", + "System.String" + ], + [ + "exceptions", + "client_StateOrProvince", + "System.String" + ], + [ + "exceptions", + "client_CountryOrRegion", + "System.String" + ], + [ + "exceptions", + "client_Browser", + "System.String" + ], + [ + "exceptions", + "cloud_RoleName", + "System.String" + ], + [ + "exceptions", + "cloud_RoleInstance", + "System.String" + ], + [ + "exceptions", + "appId", + "System.String" + ], + [ + "exceptions", + "appName", + "System.String" + ], + [ + "exceptions", + "iKey", + "System.String" + ], + [ + "exceptions", + "sdkVersion", + "System.String" + ], + [ + "exceptions", + "itemId", + "System.String" + ], + [ + "exceptions", + "itemType", + "System.String" + ], + [ + "exceptions", + "itemCount", + "System.Double" + ], + [ + "availabilityResults", + "timestamp", + "System.DateTime" + ], + [ + "availabilityResults", + "id", + "System.String" + ], + [ + "availabilityResults", + "name", + "System.String" + ], + [ + "availabilityResults", + "location", + "System.String" + ], + [ + "availabilityResults", + "success", + "System.String" + ], + [ + "availabilityResults", + "message", + "System.String" + ], + [ + "availabilityResults", + "size", + "System.Double" + ], + [ + "availabilityResults", + "duration", + "System.Double" + ], + [ + "availabilityResults", + "performanceBucket", + "System.String" + ], + [ + "availabilityResults", + "customDimensions", + "System.Object" + ], + [ + "availabilityResults", + "customMeasurements", + "System.Object" + ], + [ + "availabilityResults", + "operation_Name", + "System.String" + ], + [ + "availabilityResults", + "operation_Id", + "System.String" + ], + [ + "availabilityResults", + "operation_ParentId", + "System.String" + ], + [ + "availabilityResults", + "operation_SyntheticSource", + "System.String" + ], + [ + "availabilityResults", + "session_Id", + "System.String" + ], + [ + "availabilityResults", + "user_Id", + "System.String" + ], + [ + "availabilityResults", + "user_AuthenticatedId", + "System.String" + ], + [ + "availabilityResults", + "user_AccountId", + "System.String" + ], + [ + "availabilityResults", + "application_Version", + "System.String" + ], + [ + "availabilityResults", + "client_Type", + "System.String" + ], + [ + "availabilityResults", + "client_Model", + "System.String" + ], + [ + "availabilityResults", + "client_OS", + "System.String" + ], + [ + "availabilityResults", + "client_IP", + "System.String" + ], + [ + "availabilityResults", + "client_City", + "System.String" + ], + [ + "availabilityResults", + "client_StateOrProvince", + "System.String" + ], + [ + "availabilityResults", + "client_CountryOrRegion", + "System.String" + ], + [ + "availabilityResults", + "client_Browser", + "System.String" + ], + [ + "availabilityResults", + "cloud_RoleName", + "System.String" + ], + [ + "availabilityResults", + "cloud_RoleInstance", + "System.String" + ], + [ + "availabilityResults", + "appId", + "System.String" + ], + [ + "availabilityResults", + "appName", + "System.String" + ], + [ + "availabilityResults", + "iKey", + "System.String" + ], + [ + "availabilityResults", + "sdkVersion", + "System.String" + ], + [ + "availabilityResults", + "itemId", + "System.String" + ], + [ + "availabilityResults", + "itemType", + "System.String" + ], + [ + "availabilityResults", + "itemCount", + "System.Double" + ], + [ + "customMetrics", + "timestamp", + "System.DateTime" + ], + [ + "customMetrics", + "name", + "System.String" + ], + [ + "customMetrics", + "value", + "System.Double" + ], + [ + "customMetrics", + "valueCount", + "System.Int32" + ], + [ + "customMetrics", + "valueSum", + "System.Double" + ], + [ + "customMetrics", + "valueMin", + "System.Double" + ], + [ + "customMetrics", + "valueMax", + "System.Double" + ], + [ + "customMetrics", + "valueStdDev", + "System.Double" + ], + [ + "customMetrics", + "customDimensions", + "System.Object" + ], + [ + "customMetrics", + "operation_Name", + "System.String" + ], + [ + "customMetrics", + "operation_Id", + "System.String" + ], + [ + "customMetrics", + "operation_ParentId", + "System.String" + ], + [ + "customMetrics", + "operation_SyntheticSource", + "System.String" + ], + [ + "customMetrics", + "session_Id", + "System.String" + ], + [ + "customMetrics", + "user_Id", + "System.String" + ], + [ + "customMetrics", + "user_AuthenticatedId", + "System.String" + ], + [ + "customMetrics", + "user_AccountId", + "System.String" + ], + [ + "customMetrics", + "application_Version", + "System.String" + ], + [ + "customMetrics", + "client_Type", + "System.String" + ], + [ + "customMetrics", + "client_Model", + "System.String" + ], + [ + "customMetrics", + "client_OS", + "System.String" + ], + [ + "customMetrics", + "client_IP", + "System.String" + ], + [ + "customMetrics", + "client_City", + "System.String" + ], + [ + "customMetrics", + "client_StateOrProvince", + "System.String" + ], + [ + "customMetrics", + "client_CountryOrRegion", + "System.String" + ], + [ + "customMetrics", + "client_Browser", + "System.String" + ], + [ + "customMetrics", + "cloud_RoleName", + "System.String" + ], + [ + "customMetrics", + "cloud_RoleInstance", + "System.String" + ], + [ + "customMetrics", + "appId", + "System.String" + ], + [ + "customMetrics", + "appName", + "System.String" + ], + [ + "customMetrics", + "iKey", + "System.String" + ], + [ + "customMetrics", + "sdkVersion", + "System.String" + ], + [ + "customMetrics", + "itemId", + "System.String" + ], + [ + "customMetrics", + "itemType", + "System.String" + ], + [ + "performanceCounters", + "timestamp", + "System.DateTime" + ], + [ + "performanceCounters", + "name", + "System.String" + ], + [ + "performanceCounters", + "category", + "System.String" + ], + [ + "performanceCounters", + "counter", + "System.String" + ], + [ + "performanceCounters", + "instance", + "System.String" + ], + [ + "performanceCounters", + "value", + "System.String" + ], + [ + "performanceCounters", + "customDimensions", + "System.Object" + ], + [ + "performanceCounters", + "operation_Name", + "System.String" + ], + [ + "performanceCounters", + "operation_Id", + "System.String" + ], + [ + "performanceCounters", + "operation_ParentId", + "System.String" + ], + [ + "performanceCounters", + "operation_SyntheticSource", + "System.String" + ], + [ + "performanceCounters", + "session_Id", + "System.String" + ], + [ + "performanceCounters", + "user_Id", + "System.String" + ], + [ + "performanceCounters", + "user_AuthenticatedId", + "System.String" + ], + [ + "performanceCounters", + "user_AccountId", + "System.String" + ], + [ + "performanceCounters", + "application_Version", + "System.String" + ], + [ + "performanceCounters", + "client_Type", + "System.String" + ], + [ + "performanceCounters", + "client_Model", + "System.String" + ], + [ + "performanceCounters", + "client_OS", + "System.String" + ], + [ + "performanceCounters", + "client_IP", + "System.String" + ], + [ + "performanceCounters", + "client_City", + "System.String" + ], + [ + "performanceCounters", + "client_StateOrProvince", + "System.String" + ], + [ + "performanceCounters", + "client_CountryOrRegion", + "System.String" + ], + [ + "performanceCounters", + "client_Browser", + "System.String" + ], + [ + "performanceCounters", + "cloud_RoleName", + "System.String" + ], + [ + "performanceCounters", + "cloud_RoleInstance", + "System.String" + ], + [ + "performanceCounters", + "appId", + "System.String" + ], + [ + "performanceCounters", + "appName", + "System.String" + ], + [ + "performanceCounters", + "iKey", + "System.String" + ], + [ + "performanceCounters", + "sdkVersion", + "System.String" + ], + [ + "performanceCounters", + "itemId", + "System.String" + ], + [ + "performanceCounters", + "itemType", + "System.String" + ], + [ + "browserTimings", + "timestamp", + "System.DateTime" + ], + [ + "browserTimings", + "name", + "System.String" + ], + [ + "browserTimings", + "url", + "System.String" + ], + [ + "browserTimings", + "networkDuration", + "System.Double" + ], + [ + "browserTimings", + "sendDuration", + "System.Double" + ], + [ + "browserTimings", + "receiveDuration", + "System.Double" + ], + [ + "browserTimings", + "processingDuration", + "System.Double" + ], + [ + "browserTimings", + "totalDuration", + "System.Double" + ], + [ + "browserTimings", + "performanceBucket", + "System.String" + ], + [ + "browserTimings", + "customDimensions", + "System.Object" + ], + [ + "browserTimings", + "customMeasurements", + "System.Object" + ], + [ + "browserTimings", + "operation_Name", + "System.String" + ], + [ + "browserTimings", + "operation_Id", + "System.String" + ], + [ + "browserTimings", + "operation_ParentId", + "System.String" + ], + [ + "browserTimings", + "operation_SyntheticSource", + "System.String" + ], + [ + "browserTimings", + "session_Id", + "System.String" + ], + [ + "browserTimings", + "user_Id", + "System.String" + ], + [ + "browserTimings", + "user_AuthenticatedId", + "System.String" + ], + [ + "browserTimings", + "user_AccountId", + "System.String" + ], + [ + "browserTimings", + "application_Version", + "System.String" + ], + [ + "browserTimings", + "client_Type", + "System.String" + ], + [ + "browserTimings", + "client_Model", + "System.String" + ], + [ + "browserTimings", + "client_OS", + "System.String" + ], + [ + "browserTimings", + "client_IP", + "System.String" + ], + [ + "browserTimings", + "client_City", + "System.String" + ], + [ + "browserTimings", + "client_StateOrProvince", + "System.String" + ], + [ + "browserTimings", + "client_CountryOrRegion", + "System.String" + ], + [ + "browserTimings", + "client_Browser", + "System.String" + ], + [ + "browserTimings", + "cloud_RoleName", + "System.String" + ], + [ + "browserTimings", + "cloud_RoleInstance", + "System.String" + ], + [ + "browserTimings", + "appId", + "System.String" + ], + [ + "browserTimings", + "appName", + "System.String" + ], + [ + "browserTimings", + "iKey", + "System.String" + ], + [ + "browserTimings", + "sdkVersion", + "System.String" + ], + [ + "browserTimings", + "itemId", + "System.String" + ], + [ + "browserTimings", + "itemType", + "System.String" + ], + [ + "browserTimings", + "itemCount", + "System.Double" + ], + [ + "tEST_CL", + "col_0", + "System.String" + ], + [ + "tEST_CL", + "col_1", + "System.String" + ], + [ + "tEST_CL", + "col_2", + "System.String" + ], + [ + "tEST_CL", + "col_3", + "System.String" + ], + [ + "tEST_CL", + "ingestionTime", + "System.DateTime" + ], + [ + "bla_CL", + "col_0", + "System.String" + ], + [ + "bla_CL", + "col_1", + "System.String" + ], + [ + "bla_CL", + "col_2", + "System.String" + ], + [ + "bla_CL", + "col_3", + "System.String" + ], + [ + "bla_CL", + "ingestionTime", + "System.DateTime" + ] + ], + "KqlPrimaryTimestampColumnName": "timestamp" + }, + { + "TableName": "Table_1", + "Columns": [ + { + "ColumnName": "TableType", + "DataType": "String" + }, + { + "ColumnName": "TableName", + "DataType": "String" + }, + { + "ColumnName": "PrimaryTimestampColumnName", + "DataType": "String" + } + ], + "Rows": [ + [ + "ai", + "traces", + "timestamp" + ], + [ + "ai", + "customEvents", + "timestamp" + ], + [ + "ai", + "pageViews", + "timestamp" + ], + [ + "ai", + "requests", + "timestamp" + ], + [ + "ai", + "dependencies", + "timestamp" + ], + [ + "ai", + "exceptions", + "timestamp" + ], + [ + "ai", + "availabilityResults", + "timestamp" + ], + [ + "ai", + "customMetrics", + "timestamp" + ], + [ + "ai", + "performanceCounters", + "timestamp" + ], + [ + "ai", + "browserTimings", + "timestamp" + ], + [ + "openschema", + "tEST_CL", + "ingestionTime" + ], + [ + "openschema", + "bla_CL", + "ingestionTime" + ] + ] + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/tmp.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/tmp.json new file mode 100644 index 000000000000..0143c4a3966a --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/tmp.json @@ -0,0 +1,2024 @@ +{ + "swagger": "2.0", + "info": { + "version": "v1", + "title": "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": "aiapi@microsoft.com" + }, + "license": { + "name": "Microsoft", + "url": "https://dev.applicationinsights.io/license" + } + }, + "host": "api.applicationinsights.io", + "basePath": "/v1", + "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": { + "/apps/{app-id}/metrics/{metric-id}": { + "get": { + "operationId": "GetMetric", + "summary": "Retrieve metric data", + "description": "Gets metric values for a single metric", + "x-ms-examples": { + "simpleMetric": { + "$ref": "examples/metric-get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/metricId" + }, + { + "$ref": "#/parameters/metricsTimespan" + }, + { + "$ref": "#/parameters/metricsInterval" + }, + { + "$ref": "#/parameters/metricsAggregation" + }, + { + "$ref": "#/parameters/metricsSegment" + }, + { + "$ref": "#/parameters/metricsTop" + }, + { + "$ref": "#/parameters/metricsOrderBy" + }, + { + "$ref": "#/parameters/metricsFilter" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/metricsResult" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/apps/{app-id}/metrics": { + "post": { + "operationId": "GetMetrics", + "summary": "Retrieve metric data", + "description": "Gets metric values for multiple metrics", + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/metricsPostBody" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/metricsResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/apps/{app-id}/metrics/metadata": { + "get": { + "operationId": "GetMetricsMetadata", + "summary": "Retrieve metric metatadata", + "description": "Gets metadata describing the available metrics", + "parameters": [ + { + "$ref": "#/parameters/appId" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/apps/{app-id}/events/{event-type}": { + "get": { + "operationId": "GetEvents", + "summary": "Execute OData query", + "description": "Executes an OData query for events", + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$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" + } + ], + "produces": [ + "application/json;odata=none", + "application/json;odata=minimal", + "application/json;odata=full" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/eventsResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/apps/{app-id}/events/{event-type}/{event-id}": { + "get": { + "operationId": "GetEvent", + "summary": "Get an event", + "description": "Gets the data for a single event", + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/eventType" + }, + { + "$ref": "#/parameters/eventsTimespan" + }, + { + "$ref": "#/parameters/eventId" + } + ], + "produces": [ + "application/json", + "application/json;odata=none", + "application/json;odata=minimal", + "application/json;odata=full" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/eventsResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/apps/{app-id}/events/$metadata": { + "get": { + "operationId": "GetEventsMetadataOData", + "summary": "Get OData metadata", + "description": "Gets OData EDMX metadata describing the event data model", + "parameters": [ + { + "$ref": "#/parameters/appId" + } + ], + "produces": [ + "application/xml;charset=utf-8" + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "type": "object" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/apps/{app-id}/query": { + "get": { + "operationId": "GetQuery", + "summary": "Execute an Analytics query", + "description": "Executes an Analytics query for data", + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/queryParam" + }, + { + "$ref": "#/parameters/queryTimespan" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/queryResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + }, + "post": { + "operationId": "Query", + "summary": "Execute an Analytics query", + "description": "Executes an Analytics query for data. [Here](/documentation/2-Using-the-API/Query) is an example for using POST with an Analytics query.", + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/queryBody" + }, + { + "$ref": "#/parameters/queryTimespan" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/queryResults" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/apps/{app-id}/query/schema": { + "get": { + "operationId": "GetQuerySchema", + "summary": "Get Analytics query metadata", + "description": "Gets Analytics query schema describing the data model", + "parameters": [ + { + "$ref": "#/parameters/appId" + } + ], + "responses": { + "200": { + "description": "Successful responses", + "schema": { + "type": "object" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + } + }, + "parameters": { + "appId": { + "name": "app-id", + "description": "ID of the application. This is Application ID from the API Access settings blade in the Azure portal.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "metricId": { + "name": "metric-id", + "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" + ] + }, + "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", + "format": "duration" + }, + "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" + ] + } + }, + "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" + ] + } + }, + "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": "event-type", + "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": false + } + }, + "eventId": { + "name": "event-id", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "description": "ID of event.", + "type": "string", + "format": "uuid" + }, + "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", + "format": "duration" + }, + "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" + }, + "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", + "format": "duration" + }, + "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" + } + }, + "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" + ] + }, + "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", + "format": "duration" + }, + "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" + ] + } + }, + "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" + ] + } + }, + "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": { + "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": { + "type": "object" + } + }, + "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": false + } + }, + "eventId": { + "description": "ID of event.", + "type": "string", + "format": "uuid" + }, + "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", + "format": "duration" + }, + "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": { + "@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", + "format": "uuid" + }, + "type": { + "description": "The type of event.", + "type": "string", + "enum": [ + "trace", + "customEvent", + "pageView", + "browserTiming", + "request", + "dependency", + "exception", + "availabilityResult", + "performanceCounter", + "customMetric" + ] + }, + "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" + } + } + }, + "customMeasurements": { + "description": "Custom measurements of the event", + "type": "object", + "properties": { + "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" + } + } + }, + "eventsTraceResult": { + "x-ms-discriminator-value": "trace", + "description": "A trace result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "trace": { + "$ref": "#/definitions/eventsTraceInfo" + } + } + } + ] + }, + "eventsTraceInfo": { + "description": "The trace information", + "type": "object", + "properties": { + "message": { + "description": "The trace message", + "type": "string" + }, + "severityLevel": { + "description": "The trace severity level", + "type": "integer" + } + } + }, + "eventsCustomEventResult": { + "x-ms-discriminator-value": "customEvent", + "description": "A custom event result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "customEvent": { + "$ref": "#/definitions/eventsCustomEventInfo" + } + } + } + ] + }, + "eventsCustomEventInfo": { + "description": "The custom event information", + "type": "object", + "properties": { + "name": { + "description": "The name of the custom event", + "type": "string" + } + } + }, + "eventsPageViewResult": { + "x-ms-discriminator-value": "pageView", + "description": "A page view result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "pageView": { + "$ref": "#/definitions/eventsPageViewInfo" + } + } + } + ] + }, + "eventsPageViewInfo": { + "description": "The page view information", + "type": "object", + "properties": { + "name": { + "description": "The name of the page", + "type": "string" + }, + "url": { + "description": "The URL of the page", + "type": "string" + }, + "duration": { + "description": "The duration of the page view", + "type": "string" + }, + "performanceBucket": { + "description": "The performance bucket of the page view", + "type": "string" + } + } + }, + "eventsBrowserTimingResult": { + "x-ms-discriminator-value": "browserTiming", + "description": "A browser timing result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "browserTiming": { + "$ref": "#/definitions/eventsBrowserTimingInfo" + }, + "clientPerformance": { + "$ref": "#/definitions/eventsClientPerformanceInfo" + } + } + } + ] + }, + "eventsBrowserTimingInfo": { + "description": "The browser timing information", + "type": "object", + "properties": { + "urlPath": { + "description": "The path of the URL", + "type": "string" + }, + "urlHost": { + "description": "The host of the URL", + "type": "string" + }, + "name": { + "description": "The name of the page", + "type": "string" + }, + "url": { + "description": "The url of the page", + "type": "string" + }, + "totalDuration": { + "description": "The total duration of the load", + "type": "integer", + "format": "int64" + }, + "performanceBucket": { + "description": "The performance bucket of the load", + "type": "string" + }, + "networkDuration": { + "description": "The network duration of the load", + "type": "integer", + "format": "int64" + }, + "sendDuration": { + "description": "The send duration of the load", + "type": "integer", + "format": "int64" + }, + "receiveDuration": { + "description": "The receive duration of the load", + "type": "integer", + "format": "int64" + }, + "processingDuration": { + "description": "The processing duration of the load", + "type": "integer", + "format": "int64" + } + } + }, + "eventsClientPerformanceInfo": { + "description": "Client performance information", + "type": "object", + "properties": { + "name": { + "description": "The name of the client performance", + "type": "string" + } + } + }, + "eventsRequestResult": { + "x-ms-discriminator-value": "request", + "description": "A request result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "request": { + "$ref": "#/definitions/eventsRequestInfo" + } + } + } + ] + }, + "eventsRequestInfo": { + "description": "The request info", + "type": "object", + "properties": { + "name": { + "description": "The name of the request", + "type": "string" + }, + "url": { + "description": "The URL of the request", + "type": "string" + }, + "success": { + "description": "Indicates if the request was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the request", + "type": "number", + "format": "double" + }, + "performanceBucket": { + "description": "The performance bucket of the request", + "type": "string" + }, + "resultCode": { + "description": "The result code of the request", + "type": "string" + }, + "source": { + "description": "The source of the request", + "type": "string" + }, + "id": { + "description": "The ID of the request", + "type": "string" + } + } + }, + "eventsDependencyResult": { + "x-ms-discriminator-value": "dependency", + "description": "A dependency result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "dependency": { + "$ref": "#/definitions/eventsDependencyInfo" + } + } + } + ] + }, + "eventsDependencyInfo": { + "description": "The dependency info", + "type": "object", + "properties": { + "target": { + "description": "The target of the dependency", + "type": "string" + }, + "data": { + "description": "The data of the dependency", + "type": "string" + }, + "success": { + "description": "Indicates if the dependency was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the dependency", + "type": "integer", + "format": "int64" + }, + "performanceBucket": { + "description": "The performance bucket of the dependency", + "type": "string" + }, + "resultCode": { + "description": "The result code of the dependency", + "type": "string" + }, + "type": { + "description": "The type of the dependency", + "type": "string" + }, + "name": { + "description": "The name of the dependency", + "type": "string" + }, + "id": { + "description": "The ID of the dependency", + "type": "string" + } + } + }, + "eventsExceptionResult": { + "x-ms-discriminator-value": "exception", + "description": "An exception result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "exception": { + "$ref": "#/definitions/eventsExceptionInfo" + } + } + } + ] + }, + "eventsExceptionInfo": { + "description": "The exception info", + "type": "object", + "properties": { + "severityLevel": { + "description": "The severity level of the exception", + "type": "integer" + }, + "problemId": { + "description": "The problem ID of the exception", + "type": "string" + }, + "handledAt": { + "description": "Indicates where the exception was handled at", + "type": "string" + }, + "assembly": { + "description": "The assembly which threw the exception", + "type": "string" + }, + "method": { + "description": "The method that threw the exception", + "type": "string" + }, + "message": { + "description": "The message of the exception", + "type": "string" + }, + "type": { + "description": "The type of the exception", + "type": "string" + }, + "outerType": { + "description": "The outer type of the exception", + "type": "string" + }, + "outerMethod": { + "description": "The outer method of the exception", + "type": "string" + }, + "outerAssembly": { + "description": "The outer assmebly of the exception", + "type": "string" + }, + "outerMessage": { + "description": "The outer message of the exception", + "type": "string" + }, + "innermostType": { + "description": "The inner most type of the exception", + "type": "string" + }, + "innermostMessage": { + "description": "The inner most message of the exception", + "type": "string" + }, + "innermostMethod": { + "description": "The inner most method of the exception", + "type": "string" + }, + "innermostAssembly": { + "description": "The inner most assembly of the exception", + "type": "string" + }, + "details": { + "description": "The details of the exception", + "type": "array", + "items": { + "$ref": "#/definitions/eventsExceptionDetail" + } + } + } + }, + "eventsExceptionDetail": { + "description": "Exception details", + "type": "object", + "properties": { + "severityLevel": { + "description": "The severity level of the exception detail", + "type": "string" + }, + "outerId": { + "description": "The outer ID of the exception detail", + "type": "string" + }, + "message": { + "description": "The message of the exception detail", + "type": "string" + }, + "type": { + "description": "The type of the exception detail", + "type": "string" + }, + "id": { + "description": "The ID of the exception detail", + "type": "string" + }, + "parsedStack": { + "description": "The parsed stack", + "type": "array", + "items": { + "$ref": "#/definitions/eventsExceptionDetailsParsedStack" + } + } + } + }, + "eventsExceptionDetailsParsedStack": { + "description": "A parsed stack entry", + "type": "object", + "properties": { + "assembly": { + "description": "The assembly of the stack entry", + "type": "string" + }, + "method": { + "description": "The method of the stack entry", + "type": "string" + }, + "level": { + "description": "The level of the stack entry", + "type": "integer", + "format": "int64" + }, + "line": { + "description": "The line of the stack entry", + "type": "integer", + "format": "int64" + } + } + }, + "eventsAvailabilityResultResult": { + "x-ms-discriminator-value": "availabilityResult", + "description": "An availability result result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "availabilityResult": { + "$ref": "#/definitions/eventsAvailabilityResultInfo" + } + } + } + ] + }, + "eventsAvailabilityResultInfo": { + "description": "The availability result info", + "type": "object", + "properties": { + "name": { + "description": "The name of the availability result", + "type": "string" + }, + "success": { + "description": "Indicates if the availability result was successful", + "type": "string" + }, + "duration": { + "description": "The duration of the availability result", + "type": "integer", + "format": "int64" + }, + "performanceBucket": { + "description": "The performance bucket of the availability result", + "type": "string" + }, + "message": { + "description": "The message of the availability result", + "type": "string" + }, + "location": { + "description": "The location of the availability result", + "type": "string" + }, + "id": { + "description": "The ID of the availability result", + "type": "string" + }, + "size": { + "description": "The size of the availability result", + "type": "string" + } + } + }, + "eventsPerformanceCounterResult": { + "x-ms-discriminator-value": "performanceCounter", + "description": "A performance counter result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "performanceCounter": { + "$ref": "#/definitions/eventsPerformanceCounterInfo" + } + } + } + ] + }, + "eventsPerformanceCounterInfo": { + "description": "The performance counter info", + "type": "object", + "properties": { + "value": { + "description": "The value of the performance counter", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The name of the performance counter", + "type": "string" + }, + "category": { + "description": "The category of the performance counter", + "type": "string" + }, + "counter": { + "description": "The counter of the performance counter", + "type": "string" + }, + "instanceName": { + "description": "The instance name of the performance counter", + "type": "string" + }, + "instance": { + "description": "The instance of the performance counter", + "type": "string" + } + } + }, + "eventsCustomMetricResult": { + "x-ms-discriminator-value": "customMetric", + "description": "A custom metric result", + "allOf": [ + { + "$ref": "#/definitions/eventsResultData" + }, + { + "type": "object", + "properties": { + "customMetric": { + "$ref": "#/definitions/eventsCustomMetricInfo" + } + } + } + ] + }, + "eventsCustomMetricInfo": { + "description": "The custom metric info", + "type": "object", + "properties": { + "name": { + "description": "The name of the custom metric", + "type": "string" + }, + "value": { + "description": "The value of the custom metric", + "type": "number", + "format": "double" + }, + "valueSum": { + "description": "The sum of the custom metric", + "type": "number", + "format": "double" + }, + "valueCount": { + "description": "The count of the custom metric", + "type": "number", + "format": "double" + }, + "valueMin": { + "description": "The minimum value of the custom metric", + "type": "number", + "format": "double" + }, + "valueMax": { + "description": "The maximum value of the custom metric", + "type": "number", + "format": "double" + }, + "valueStdDev": { + "description": "The standard deviation of the custom metric", + "type": "number", + "format": "double" + } + } + }, + "eventsOperationInfo": { + "description": "Operation info for an event result", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "id": { + "description": "ID of the operation", + "type": "string" + }, + "parentId": { + "description": "Parent ID of the operation", + "type": "string" + }, + "syntheticSource": { + "description": "Synthetic source of the operation", + "type": "string" + } + } + }, + "eventsSessionInfo": { + "description": "Session info for an event result", + "type": "object", + "properties": { + "id": { + "description": "ID of the session", + "type": "string" + } + } + }, + "eventsUserInfo": { + "description": "User info for an event result", + "type": "object", + "properties": { + "id": { + "description": "ID of the user", + "type": "string" + }, + "accountId": { + "description": "Account ID of the user", + "type": "string" + }, + "authenticatedId": { + "description": "Authenticated ID of the user", + "type": "string" + } + } + }, + "eventsCloudInfo": { + "description": "Cloud info for an event result", + "type": "object", + "properties": { + "roleName": { + "description": "Role name of the cloud", + "type": "string" + }, + "roleInstance": { + "description": "Role instance of the cloud", + "type": "string" + } + } + }, + "eventsAiInfo": { + "description": "AI related application info for an event result", + "type": "object", + "properties": { + "iKey": { + "description": "iKey of the app", + "type": "string" + }, + "appName": { + "description": "Name of the application", + "type": "string" + }, + "appId": { + "description": "ID of the application", + "type": "string" + }, + "sdkVersion": { + "description": "SDK version of the application", + "type": "string" + } + } + }, + "eventsApplicationInfo": { + "description": "Application info for an event result", + "type": "object", + "properties": { + "version": { + "description": "Version of the application", + "type": "string" + } + } + }, + "eventsClientInfo": { + "description": "Client info for an event result", + "type": "object", + "properties": { + "model": { + "description": "Model of the client", + "type": "string" + }, + "os": { + "description": "Operating system of the client", + "type": "string" + }, + "type": { + "description": "Type of the client", + "type": "string" + }, + "browser": { + "description": "Browser of the client", + "type": "string" + }, + "ip": { + "description": "IP address of the client", + "type": "string" + }, + "city": { + "description": "City of the client", + "type": "string" + }, + "stateOrProvince": { + "description": "State or province of the client", + "type": "string" + }, + "countryOrRegion": { + "description": "Country or region of the client", + "type": "string" + } + } + }, + "queryParam": { + "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", + "type": "string" + }, + "queryTimespan": { + "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", + "format": "duration" + }, + "applicationsParam": { + "description": "Application IDs to include in cross-application queries.", + "type": "array", + "items": { + "type": "string" + } + }, + "queryBody": { + "description": "Query request body", + "type": "object", + "properties": { + "query": { + "description": "The query to execute.", + "$ref": "#/definitions/queryParam" + }, + "timespan": { + "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.", + "$ref": "#/definitions/queryTimespan" + }, + "applications": { + "description": "A list of applications that are included in the query.", + "$ref": "#/definitions/applicationsParam" + } + }, + "required": [ + "query" + ] + }, + "queryResults": { + "title": "A query response.", + "description": "Contains the tables, columns & rows resulting from a query.", + "type": "object", + "properties": { + "tables": { + "description": "The list of tables, columns and rows.", + "type": "array", + "items": { + "$ref": "#/definitions/table" + } + } + }, + "required": [ + "tables" + ] + }, + "table": { + "title": "A query response table.", + "description": "Contains the columns and rows for one table in a query response.", + "type": "object", + "properties": { + "name": { + "description": "The name of the table.", + "type": "string" + }, + "columns": { + "description": "The list of columns in this table.", + "type": "array", + "items": { + "$ref": "#/definitions/column" + } + }, + "rows": { + "description": "The resulting rows from this query.", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "required": [ + "name", + "columns", + "rows" + ] + }, + "column": { + "title": "A table column.", + "description": "A column in a table.", + "type": "object", + "properties": { + "name": { + "description": "The name of this column.", + "type": "string" + }, + "type": { + "description": "The data type of this column.", + "type": "string" + } + } + }, + "errorDetail": { + "title": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "target": { + "description": "Indicates which property in the request is responsible for the error.", + "type": "string" + }, + "value": { + "description": "Indicates which value in 'target' is responsible for the error.", + "type": "string" + }, + "resources": { + "description": "Indicates resources which were responsible for the error.", + "type": "array", + "items": { + "type": "string" + } + }, + "additionalProperties": { + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "errorInfo": { + "title": "The code and message for an error.", + "type": "object", + "properties": { + "code": { + "description": "A machine readable error code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + }, + "details": { + "description": "error details.", + "type": "array", + "items": { + "$ref": "#/definitions/errorDetail" + } + }, + "innererror": { + "description": "Inner error details if they exist.", + "$ref": "#/definitions/errorInfo" + }, + "additionalProperties": { + "type": "object" + } + }, + "required": [ + "code", + "message" + ] + }, + "errorResponse": { + "title": "Error details.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/errorInfo" + } + }, + "required": [ + "error" + ] + } + } +} \ No newline at end of file From ea97ddd31a7afe911a297a4f3df4f04a3983ccf9 Mon Sep 17 00:00:00 2001 From: Ace Eldeib Date: Fri, 2 Feb 2018 06:43:26 -0800 Subject: [PATCH 5/6] Remove extraneous swagger file --- .../data-plane/microsoft.insights/v1/tmp.json | 2024 ----------------- 1 file changed, 2024 deletions(-) delete mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/tmp.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/tmp.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/tmp.json deleted file mode 100644 index 0143c4a3966a..000000000000 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/tmp.json +++ /dev/null @@ -1,2024 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "v1", - "title": "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": "aiapi@microsoft.com" - }, - "license": { - "name": "Microsoft", - "url": "https://dev.applicationinsights.io/license" - } - }, - "host": "api.applicationinsights.io", - "basePath": "/v1", - "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": { - "/apps/{app-id}/metrics/{metric-id}": { - "get": { - "operationId": "GetMetric", - "summary": "Retrieve metric data", - "description": "Gets metric values for a single metric", - "x-ms-examples": { - "simpleMetric": { - "$ref": "examples/metric-get.json" - } - }, - "parameters": [ - { - "$ref": "#/parameters/appId" - }, - { - "$ref": "#/parameters/metricId" - }, - { - "$ref": "#/parameters/metricsTimespan" - }, - { - "$ref": "#/parameters/metricsInterval" - }, - { - "$ref": "#/parameters/metricsAggregation" - }, - { - "$ref": "#/parameters/metricsSegment" - }, - { - "$ref": "#/parameters/metricsTop" - }, - { - "$ref": "#/parameters/metricsOrderBy" - }, - { - "$ref": "#/parameters/metricsFilter" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/metricsResult" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - } - }, - "/apps/{app-id}/metrics": { - "post": { - "operationId": "GetMetrics", - "summary": "Retrieve metric data", - "description": "Gets metric values for multiple metrics", - "parameters": [ - { - "$ref": "#/parameters/appId" - }, - { - "$ref": "#/parameters/metricsPostBody" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/metricsResults" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - } - }, - "/apps/{app-id}/metrics/metadata": { - "get": { - "operationId": "GetMetricsMetadata", - "summary": "Retrieve metric metatadata", - "description": "Gets metadata describing the available metrics", - "parameters": [ - { - "$ref": "#/parameters/appId" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "type": "object" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - } - }, - "/apps/{app-id}/events/{event-type}": { - "get": { - "operationId": "GetEvents", - "summary": "Execute OData query", - "description": "Executes an OData query for events", - "parameters": [ - { - "$ref": "#/parameters/appId" - }, - { - "$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" - } - ], - "produces": [ - "application/json;odata=none", - "application/json;odata=minimal", - "application/json;odata=full" - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/eventsResults" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - } - }, - "/apps/{app-id}/events/{event-type}/{event-id}": { - "get": { - "operationId": "GetEvent", - "summary": "Get an event", - "description": "Gets the data for a single event", - "parameters": [ - { - "$ref": "#/parameters/appId" - }, - { - "$ref": "#/parameters/eventType" - }, - { - "$ref": "#/parameters/eventsTimespan" - }, - { - "$ref": "#/parameters/eventId" - } - ], - "produces": [ - "application/json", - "application/json;odata=none", - "application/json;odata=minimal", - "application/json;odata=full" - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/eventsResults" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - } - }, - "/apps/{app-id}/events/$metadata": { - "get": { - "operationId": "GetEventsMetadataOData", - "summary": "Get OData metadata", - "description": "Gets OData EDMX metadata describing the event data model", - "parameters": [ - { - "$ref": "#/parameters/appId" - } - ], - "produces": [ - "application/xml;charset=utf-8" - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "type": "object" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - } - }, - "/apps/{app-id}/query": { - "get": { - "operationId": "GetQuery", - "summary": "Execute an Analytics query", - "description": "Executes an Analytics query for data", - "parameters": [ - { - "$ref": "#/parameters/appId" - }, - { - "$ref": "#/parameters/queryParam" - }, - { - "$ref": "#/parameters/queryTimespan" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/queryResults" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - }, - "post": { - "operationId": "Query", - "summary": "Execute an Analytics query", - "description": "Executes an Analytics query for data. [Here](/documentation/2-Using-the-API/Query) is an example for using POST with an Analytics query.", - "parameters": [ - { - "$ref": "#/parameters/appId" - }, - { - "$ref": "#/parameters/queryBody" - }, - { - "$ref": "#/parameters/queryTimespan" - } - ], - "responses": { - "200": { - "description": "Successful response", - "schema": { - "$ref": "#/definitions/queryResults" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - } - }, - "/apps/{app-id}/query/schema": { - "get": { - "operationId": "GetQuerySchema", - "summary": "Get Analytics query metadata", - "description": "Gets Analytics query schema describing the data model", - "parameters": [ - { - "$ref": "#/parameters/appId" - } - ], - "responses": { - "200": { - "description": "Successful responses", - "schema": { - "type": "object" - } - }, - "default": { - "description": "An error response object.", - "schema": { - "$ref": "#/definitions/errorResponse" - } - } - } - } - } - }, - "parameters": { - "appId": { - "name": "app-id", - "description": "ID of the application. This is Application ID from the API Access settings blade in the Azure portal.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "metricId": { - "name": "metric-id", - "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" - ] - }, - "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", - "format": "duration" - }, - "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" - ] - } - }, - "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" - ] - } - }, - "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": "event-type", - "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": false - } - }, - "eventId": { - "name": "event-id", - "in": "path", - "required": true, - "x-ms-parameter-location": "method", - "description": "ID of event.", - "type": "string", - "format": "uuid" - }, - "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", - "format": "duration" - }, - "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" - }, - "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", - "format": "duration" - }, - "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" - } - }, - "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" - ] - }, - "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", - "format": "duration" - }, - "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" - ] - } - }, - "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" - ] - } - }, - "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": { - "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": { - "type": "object" - } - }, - "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": false - } - }, - "eventId": { - "description": "ID of event.", - "type": "string", - "format": "uuid" - }, - "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", - "format": "duration" - }, - "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": { - "@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", - "format": "uuid" - }, - "type": { - "description": "The type of event.", - "type": "string", - "enum": [ - "trace", - "customEvent", - "pageView", - "browserTiming", - "request", - "dependency", - "exception", - "availabilityResult", - "performanceCounter", - "customMetric" - ] - }, - "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" - } - } - }, - "customMeasurements": { - "description": "Custom measurements of the event", - "type": "object", - "properties": { - "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" - } - } - }, - "eventsTraceResult": { - "x-ms-discriminator-value": "trace", - "description": "A trace result", - "allOf": [ - { - "$ref": "#/definitions/eventsResultData" - }, - { - "type": "object", - "properties": { - "trace": { - "$ref": "#/definitions/eventsTraceInfo" - } - } - } - ] - }, - "eventsTraceInfo": { - "description": "The trace information", - "type": "object", - "properties": { - "message": { - "description": "The trace message", - "type": "string" - }, - "severityLevel": { - "description": "The trace severity level", - "type": "integer" - } - } - }, - "eventsCustomEventResult": { - "x-ms-discriminator-value": "customEvent", - "description": "A custom event result", - "allOf": [ - { - "$ref": "#/definitions/eventsResultData" - }, - { - "type": "object", - "properties": { - "customEvent": { - "$ref": "#/definitions/eventsCustomEventInfo" - } - } - } - ] - }, - "eventsCustomEventInfo": { - "description": "The custom event information", - "type": "object", - "properties": { - "name": { - "description": "The name of the custom event", - "type": "string" - } - } - }, - "eventsPageViewResult": { - "x-ms-discriminator-value": "pageView", - "description": "A page view result", - "allOf": [ - { - "$ref": "#/definitions/eventsResultData" - }, - { - "type": "object", - "properties": { - "pageView": { - "$ref": "#/definitions/eventsPageViewInfo" - } - } - } - ] - }, - "eventsPageViewInfo": { - "description": "The page view information", - "type": "object", - "properties": { - "name": { - "description": "The name of the page", - "type": "string" - }, - "url": { - "description": "The URL of the page", - "type": "string" - }, - "duration": { - "description": "The duration of the page view", - "type": "string" - }, - "performanceBucket": { - "description": "The performance bucket of the page view", - "type": "string" - } - } - }, - "eventsBrowserTimingResult": { - "x-ms-discriminator-value": "browserTiming", - "description": "A browser timing result", - "allOf": [ - { - "$ref": "#/definitions/eventsResultData" - }, - { - "type": "object", - "properties": { - "browserTiming": { - "$ref": "#/definitions/eventsBrowserTimingInfo" - }, - "clientPerformance": { - "$ref": "#/definitions/eventsClientPerformanceInfo" - } - } - } - ] - }, - "eventsBrowserTimingInfo": { - "description": "The browser timing information", - "type": "object", - "properties": { - "urlPath": { - "description": "The path of the URL", - "type": "string" - }, - "urlHost": { - "description": "The host of the URL", - "type": "string" - }, - "name": { - "description": "The name of the page", - "type": "string" - }, - "url": { - "description": "The url of the page", - "type": "string" - }, - "totalDuration": { - "description": "The total duration of the load", - "type": "integer", - "format": "int64" - }, - "performanceBucket": { - "description": "The performance bucket of the load", - "type": "string" - }, - "networkDuration": { - "description": "The network duration of the load", - "type": "integer", - "format": "int64" - }, - "sendDuration": { - "description": "The send duration of the load", - "type": "integer", - "format": "int64" - }, - "receiveDuration": { - "description": "The receive duration of the load", - "type": "integer", - "format": "int64" - }, - "processingDuration": { - "description": "The processing duration of the load", - "type": "integer", - "format": "int64" - } - } - }, - "eventsClientPerformanceInfo": { - "description": "Client performance information", - "type": "object", - "properties": { - "name": { - "description": "The name of the client performance", - "type": "string" - } - } - }, - "eventsRequestResult": { - "x-ms-discriminator-value": "request", - "description": "A request result", - "allOf": [ - { - "$ref": "#/definitions/eventsResultData" - }, - { - "type": "object", - "properties": { - "request": { - "$ref": "#/definitions/eventsRequestInfo" - } - } - } - ] - }, - "eventsRequestInfo": { - "description": "The request info", - "type": "object", - "properties": { - "name": { - "description": "The name of the request", - "type": "string" - }, - "url": { - "description": "The URL of the request", - "type": "string" - }, - "success": { - "description": "Indicates if the request was successful", - "type": "string" - }, - "duration": { - "description": "The duration of the request", - "type": "number", - "format": "double" - }, - "performanceBucket": { - "description": "The performance bucket of the request", - "type": "string" - }, - "resultCode": { - "description": "The result code of the request", - "type": "string" - }, - "source": { - "description": "The source of the request", - "type": "string" - }, - "id": { - "description": "The ID of the request", - "type": "string" - } - } - }, - "eventsDependencyResult": { - "x-ms-discriminator-value": "dependency", - "description": "A dependency result", - "allOf": [ - { - "$ref": "#/definitions/eventsResultData" - }, - { - "type": "object", - "properties": { - "dependency": { - "$ref": "#/definitions/eventsDependencyInfo" - } - } - } - ] - }, - "eventsDependencyInfo": { - "description": "The dependency info", - "type": "object", - "properties": { - "target": { - "description": "The target of the dependency", - "type": "string" - }, - "data": { - "description": "The data of the dependency", - "type": "string" - }, - "success": { - "description": "Indicates if the dependency was successful", - "type": "string" - }, - "duration": { - "description": "The duration of the dependency", - "type": "integer", - "format": "int64" - }, - "performanceBucket": { - "description": "The performance bucket of the dependency", - "type": "string" - }, - "resultCode": { - "description": "The result code of the dependency", - "type": "string" - }, - "type": { - "description": "The type of the dependency", - "type": "string" - }, - "name": { - "description": "The name of the dependency", - "type": "string" - }, - "id": { - "description": "The ID of the dependency", - "type": "string" - } - } - }, - "eventsExceptionResult": { - "x-ms-discriminator-value": "exception", - "description": "An exception result", - "allOf": [ - { - "$ref": "#/definitions/eventsResultData" - }, - { - "type": "object", - "properties": { - "exception": { - "$ref": "#/definitions/eventsExceptionInfo" - } - } - } - ] - }, - "eventsExceptionInfo": { - "description": "The exception info", - "type": "object", - "properties": { - "severityLevel": { - "description": "The severity level of the exception", - "type": "integer" - }, - "problemId": { - "description": "The problem ID of the exception", - "type": "string" - }, - "handledAt": { - "description": "Indicates where the exception was handled at", - "type": "string" - }, - "assembly": { - "description": "The assembly which threw the exception", - "type": "string" - }, - "method": { - "description": "The method that threw the exception", - "type": "string" - }, - "message": { - "description": "The message of the exception", - "type": "string" - }, - "type": { - "description": "The type of the exception", - "type": "string" - }, - "outerType": { - "description": "The outer type of the exception", - "type": "string" - }, - "outerMethod": { - "description": "The outer method of the exception", - "type": "string" - }, - "outerAssembly": { - "description": "The outer assmebly of the exception", - "type": "string" - }, - "outerMessage": { - "description": "The outer message of the exception", - "type": "string" - }, - "innermostType": { - "description": "The inner most type of the exception", - "type": "string" - }, - "innermostMessage": { - "description": "The inner most message of the exception", - "type": "string" - }, - "innermostMethod": { - "description": "The inner most method of the exception", - "type": "string" - }, - "innermostAssembly": { - "description": "The inner most assembly of the exception", - "type": "string" - }, - "details": { - "description": "The details of the exception", - "type": "array", - "items": { - "$ref": "#/definitions/eventsExceptionDetail" - } - } - } - }, - "eventsExceptionDetail": { - "description": "Exception details", - "type": "object", - "properties": { - "severityLevel": { - "description": "The severity level of the exception detail", - "type": "string" - }, - "outerId": { - "description": "The outer ID of the exception detail", - "type": "string" - }, - "message": { - "description": "The message of the exception detail", - "type": "string" - }, - "type": { - "description": "The type of the exception detail", - "type": "string" - }, - "id": { - "description": "The ID of the exception detail", - "type": "string" - }, - "parsedStack": { - "description": "The parsed stack", - "type": "array", - "items": { - "$ref": "#/definitions/eventsExceptionDetailsParsedStack" - } - } - } - }, - "eventsExceptionDetailsParsedStack": { - "description": "A parsed stack entry", - "type": "object", - "properties": { - "assembly": { - "description": "The assembly of the stack entry", - "type": "string" - }, - "method": { - "description": "The method of the stack entry", - "type": "string" - }, - "level": { - "description": "The level of the stack entry", - "type": "integer", - "format": "int64" - }, - "line": { - "description": "The line of the stack entry", - "type": "integer", - "format": "int64" - } - } - }, - "eventsAvailabilityResultResult": { - "x-ms-discriminator-value": "availabilityResult", - "description": "An availability result result", - "allOf": [ - { - "$ref": "#/definitions/eventsResultData" - }, - { - "type": "object", - "properties": { - "availabilityResult": { - "$ref": "#/definitions/eventsAvailabilityResultInfo" - } - } - } - ] - }, - "eventsAvailabilityResultInfo": { - "description": "The availability result info", - "type": "object", - "properties": { - "name": { - "description": "The name of the availability result", - "type": "string" - }, - "success": { - "description": "Indicates if the availability result was successful", - "type": "string" - }, - "duration": { - "description": "The duration of the availability result", - "type": "integer", - "format": "int64" - }, - "performanceBucket": { - "description": "The performance bucket of the availability result", - "type": "string" - }, - "message": { - "description": "The message of the availability result", - "type": "string" - }, - "location": { - "description": "The location of the availability result", - "type": "string" - }, - "id": { - "description": "The ID of the availability result", - "type": "string" - }, - "size": { - "description": "The size of the availability result", - "type": "string" - } - } - }, - "eventsPerformanceCounterResult": { - "x-ms-discriminator-value": "performanceCounter", - "description": "A performance counter result", - "allOf": [ - { - "$ref": "#/definitions/eventsResultData" - }, - { - "type": "object", - "properties": { - "performanceCounter": { - "$ref": "#/definitions/eventsPerformanceCounterInfo" - } - } - } - ] - }, - "eventsPerformanceCounterInfo": { - "description": "The performance counter info", - "type": "object", - "properties": { - "value": { - "description": "The value of the performance counter", - "type": "integer", - "format": "int64" - }, - "name": { - "description": "The name of the performance counter", - "type": "string" - }, - "category": { - "description": "The category of the performance counter", - "type": "string" - }, - "counter": { - "description": "The counter of the performance counter", - "type": "string" - }, - "instanceName": { - "description": "The instance name of the performance counter", - "type": "string" - }, - "instance": { - "description": "The instance of the performance counter", - "type": "string" - } - } - }, - "eventsCustomMetricResult": { - "x-ms-discriminator-value": "customMetric", - "description": "A custom metric result", - "allOf": [ - { - "$ref": "#/definitions/eventsResultData" - }, - { - "type": "object", - "properties": { - "customMetric": { - "$ref": "#/definitions/eventsCustomMetricInfo" - } - } - } - ] - }, - "eventsCustomMetricInfo": { - "description": "The custom metric info", - "type": "object", - "properties": { - "name": { - "description": "The name of the custom metric", - "type": "string" - }, - "value": { - "description": "The value of the custom metric", - "type": "number", - "format": "double" - }, - "valueSum": { - "description": "The sum of the custom metric", - "type": "number", - "format": "double" - }, - "valueCount": { - "description": "The count of the custom metric", - "type": "number", - "format": "double" - }, - "valueMin": { - "description": "The minimum value of the custom metric", - "type": "number", - "format": "double" - }, - "valueMax": { - "description": "The maximum value of the custom metric", - "type": "number", - "format": "double" - }, - "valueStdDev": { - "description": "The standard deviation of the custom metric", - "type": "number", - "format": "double" - } - } - }, - "eventsOperationInfo": { - "description": "Operation info for an event result", - "type": "object", - "properties": { - "name": { - "description": "Name of the operation", - "type": "string" - }, - "id": { - "description": "ID of the operation", - "type": "string" - }, - "parentId": { - "description": "Parent ID of the operation", - "type": "string" - }, - "syntheticSource": { - "description": "Synthetic source of the operation", - "type": "string" - } - } - }, - "eventsSessionInfo": { - "description": "Session info for an event result", - "type": "object", - "properties": { - "id": { - "description": "ID of the session", - "type": "string" - } - } - }, - "eventsUserInfo": { - "description": "User info for an event result", - "type": "object", - "properties": { - "id": { - "description": "ID of the user", - "type": "string" - }, - "accountId": { - "description": "Account ID of the user", - "type": "string" - }, - "authenticatedId": { - "description": "Authenticated ID of the user", - "type": "string" - } - } - }, - "eventsCloudInfo": { - "description": "Cloud info for an event result", - "type": "object", - "properties": { - "roleName": { - "description": "Role name of the cloud", - "type": "string" - }, - "roleInstance": { - "description": "Role instance of the cloud", - "type": "string" - } - } - }, - "eventsAiInfo": { - "description": "AI related application info for an event result", - "type": "object", - "properties": { - "iKey": { - "description": "iKey of the app", - "type": "string" - }, - "appName": { - "description": "Name of the application", - "type": "string" - }, - "appId": { - "description": "ID of the application", - "type": "string" - }, - "sdkVersion": { - "description": "SDK version of the application", - "type": "string" - } - } - }, - "eventsApplicationInfo": { - "description": "Application info for an event result", - "type": "object", - "properties": { - "version": { - "description": "Version of the application", - "type": "string" - } - } - }, - "eventsClientInfo": { - "description": "Client info for an event result", - "type": "object", - "properties": { - "model": { - "description": "Model of the client", - "type": "string" - }, - "os": { - "description": "Operating system of the client", - "type": "string" - }, - "type": { - "description": "Type of the client", - "type": "string" - }, - "browser": { - "description": "Browser of the client", - "type": "string" - }, - "ip": { - "description": "IP address of the client", - "type": "string" - }, - "city": { - "description": "City of the client", - "type": "string" - }, - "stateOrProvince": { - "description": "State or province of the client", - "type": "string" - }, - "countryOrRegion": { - "description": "Country or region of the client", - "type": "string" - } - } - }, - "queryParam": { - "description": "The Analytics query. Learn more about the [Analytics query syntax](https://azure.microsoft.com/documentation/articles/app-insights-analytics-reference/)", - "type": "string" - }, - "queryTimespan": { - "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", - "format": "duration" - }, - "applicationsParam": { - "description": "Application IDs to include in cross-application queries.", - "type": "array", - "items": { - "type": "string" - } - }, - "queryBody": { - "description": "Query request body", - "type": "object", - "properties": { - "query": { - "description": "The query to execute.", - "$ref": "#/definitions/queryParam" - }, - "timespan": { - "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.", - "$ref": "#/definitions/queryTimespan" - }, - "applications": { - "description": "A list of applications that are included in the query.", - "$ref": "#/definitions/applicationsParam" - } - }, - "required": [ - "query" - ] - }, - "queryResults": { - "title": "A query response.", - "description": "Contains the tables, columns & rows resulting from a query.", - "type": "object", - "properties": { - "tables": { - "description": "The list of tables, columns and rows.", - "type": "array", - "items": { - "$ref": "#/definitions/table" - } - } - }, - "required": [ - "tables" - ] - }, - "table": { - "title": "A query response table.", - "description": "Contains the columns and rows for one table in a query response.", - "type": "object", - "properties": { - "name": { - "description": "The name of the table.", - "type": "string" - }, - "columns": { - "description": "The list of columns in this table.", - "type": "array", - "items": { - "$ref": "#/definitions/column" - } - }, - "rows": { - "description": "The resulting rows from this query.", - "type": "array", - "items": { - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "required": [ - "name", - "columns", - "rows" - ] - }, - "column": { - "title": "A table column.", - "description": "A column in a table.", - "type": "object", - "properties": { - "name": { - "description": "The name of this column.", - "type": "string" - }, - "type": { - "description": "The data type of this column.", - "type": "string" - } - } - }, - "errorDetail": { - "title": "Error details.", - "type": "object", - "properties": { - "code": { - "description": "The error's code.", - "type": "string" - }, - "message": { - "description": "A human readable error message.", - "type": "string" - }, - "target": { - "description": "Indicates which property in the request is responsible for the error.", - "type": "string" - }, - "value": { - "description": "Indicates which value in 'target' is responsible for the error.", - "type": "string" - }, - "resources": { - "description": "Indicates resources which were responsible for the error.", - "type": "array", - "items": { - "type": "string" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "required": [ - "code", - "message" - ] - }, - "errorInfo": { - "title": "The code and message for an error.", - "type": "object", - "properties": { - "code": { - "description": "A machine readable error code.", - "type": "string" - }, - "message": { - "description": "A human readable error message.", - "type": "string" - }, - "details": { - "description": "error details.", - "type": "array", - "items": { - "$ref": "#/definitions/errorDetail" - } - }, - "innererror": { - "description": "Inner error details if they exist.", - "$ref": "#/definitions/errorInfo" - }, - "additionalProperties": { - "type": "object" - } - }, - "required": [ - "code", - "message" - ] - }, - "errorResponse": { - "title": "Error details.", - "description": "Contains details when the response code indicates an error.", - "type": "object", - "properties": { - "error": { - "description": "The error details.", - "$ref": "#/definitions/errorInfo" - } - }, - "required": [ - "error" - ] - } - } -} \ No newline at end of file From 0bcd160c3838afb62c3c15bf25cc87aa366baeb7 Mon Sep 17 00:00:00 2001 From: Ace Eldeib Date: Tue, 6 Feb 2018 10:04:26 -0800 Subject: [PATCH 6/6] Fixing validation errors --- .../microsoft.insights/v1/AppInsights.json | 154 ++++++++++++------ .../v1/examples/events-get-by-id.json | 6 +- .../v1/examples/events-get-by-type.json | 4 +- .../v1/examples/events-get-metadata.json | 7 +- .../v1/examples/metric-get-custom.json | 21 +++ .../v1/examples/metric-get-full.json | 45 +++++ .../v1/examples/metric-get.json | 39 ++--- .../v1/examples/metric-post.json | 136 ++++++++-------- .../v1/examples/metrics-get-metadata.json | 2 +- .../v1/examples/query-get.json | 2 +- .../v1/examples/query-post.json | 4 +- .../v1/examples/query-schema.json | 43 +++-- 12 files changed, 280 insertions(+), 183 deletions(-) create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-custom.json create mode 100644 specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-full.json diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json index 8081c325fe7c..014f6f25a45e 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/AppInsights.json @@ -45,14 +45,75 @@ } ], "paths": { - "/apps/{app-id}/metrics/{metric-id}": { + "/apps/{appId}/metrics/{metricType}/{metricId}": { "get": { "operationId": "GetMetric", "summary": "Retrieve metric data", - "description": "Gets metric values for a single metric", + "description": "Gets data for a single metric.", "x-ms-examples": { "simpleMetric": { "$ref": "examples/metric-get.json" + }, + "intervaledMetric": { + "$ref": "examples/metric-get-full.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/appId" + }, + { + "$ref": "#/parameters/metricType" + }, + { + "$ref": "#/parameters/metricId" + }, + { + "$ref": "#/parameters/metricsTimespan" + }, + { + "$ref": "#/parameters/metricsInterval" + }, + { + "$ref": "#/parameters/metricsAggregation" + }, + { + "$ref": "#/parameters/metricsSegment" + }, + { + "$ref": "#/parameters/metricsTop" + }, + { + "$ref": "#/parameters/metricsOrderBy" + }, + { + "$ref": "#/parameters/metricsFilter" + } + ], + "responses": { + "200": { + "description": "Successful response", + "schema": { + "$ref": "#/definitions/metricsResult" + } + }, + "default": { + "description": "An error response object.", + "schema": { + "$ref": "#/definitions/errorResponse" + } + } + } + } + }, + "/apps/{appId}/metrics/customEvents/custom/{metricId}": { + "get": { + "operationId": "GetCustomEventCustomMetric", + "summary": "Retrieve metric data", + "description": "Gets data for a single metric.", + "x-ms-examples": { + "customEventsMetric": { + "$ref": "examples/metric-get-custom.json" } }, "parameters": [ @@ -100,7 +161,7 @@ } } }, - "/apps/{app-id}/metrics": { + "/apps/{appId}/metrics": { "post": { "operationId": "GetMetrics", "summary": "Retrieve metric data", @@ -134,7 +195,7 @@ } } }, - "/apps/{app-id}/metrics/metadata": { + "/apps/{appId}/metrics/metadata": { "get": { "operationId": "GetMetricsMetadata", "summary": "Retrieve metric metatadata", @@ -165,7 +226,7 @@ } } }, - "/apps/{app-id}/events/{event-type}": { + "/apps/{appId}/events/{eventType}": { "get": { "operationId": "GetEvents", "summary": "Execute OData query", @@ -234,7 +295,7 @@ } } }, - "/apps/{app-id}/events/{event-type}/{event-id}": { + "/apps/{appId}/events/{eventType}/{eventId}": { "get": { "operationId": "GetEvent", "summary": "Get an event", @@ -280,7 +341,7 @@ } } }, - "/apps/{app-id}/events/$metadata": { + "/apps/{appId}/events/$metadata": { "get": { "operationId": "GetEventsMetadataOData", "summary": "Get OData metadata", @@ -314,7 +375,7 @@ } } }, - "/apps/{app-id}/query": { + "/apps/{appId}/query": { "get": { "operationId": "GetQuery", "summary": "Execute an Analytics query", @@ -386,7 +447,7 @@ } } }, - "/apps/{app-id}/query/schema": { + "/apps/{appId}/query/schema": { "get": { "operationId": "GetQuerySchema", "summary": "Get Analytics query metadata", @@ -420,7 +481,7 @@ }, "parameters": { "appId": { - "name": "app-id", + "name": "appId", "description": "ID of the application. This is Application ID from the API Access settings blade in the Azure portal.", "in": "path", "required": true, @@ -428,46 +489,20 @@ "x-ms-parameter-location": "client" }, "metricId": { - "name": "metric-id", + "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" - ] + "description": "Specific metric to operate over within a type (e.g. count, duration, failed)", + "type": "string" + }, + "metricType": { + "name": "metricType", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "description": "Type of metric to operate over. Must be paired with id for a distinct metric.", + "type": "string" }, "metricsTimespan": { "name": "timespan", @@ -568,7 +603,7 @@ "x-ms-parameter-location": "method" }, "eventType": { - "name": "event-type", + "name": "eventType", "in": "path", "required": true, "x-ms-parameter-location": "method", @@ -593,7 +628,7 @@ } }, "eventId": { - "name": "event-id", + "name": "eventId", "in": "path", "required": true, "x-ms-parameter-location": "method", @@ -704,7 +739,7 @@ } }, "definitions": { - "metricId": { + "metricEnumId": { "description": "ID of the metric. This is either a standard AI metric, or an application-specific custom metric.", "type": "string", "enum": [ @@ -742,6 +777,14 @@ "customEvents/count" ] }, + "metricType": { + "description": "Type of metric to operate over. Must be paired with id for a distinct metric.", + "type": "string" + }, + "metricId": { + "description": "Specific metric to operate over within a type (e.g. count, duration, failed)", + "type": "string" + }, "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", @@ -1022,6 +1065,10 @@ "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", @@ -1972,10 +2019,11 @@ "type": "array", "items": { "type": "array", - "items": { - "type": "string" - } + "items": {} } + }, + "primaryTimeStampColumn": { + "description": "name of column in database containing primary" } }, "required": [ diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-id.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-id.json index 95bba3026085..d68ed461a1c1 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-id.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-id.json @@ -2,9 +2,9 @@ "title": "Get A Specific Events By Type & ID", "description": "Gets a specific event by type and id.", "parameters": { - "app-id": "DEMO_APP", - "event-type": "traces", - "event-id": "dc76df01-0141-11e8-9894-e3e7c1eeabad" + "appId": "DEMO_APP", + "eventType": "traces", + "eventId": "dc76df01-0141-11e8-9894-e3e7c1eeabad" }, "responses": { "200": { diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-type.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-type.json index e2032fae5958..bde08ad28d94 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-type.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-by-type.json @@ -2,8 +2,8 @@ "title": "Get Events By Type", "description": "Gets events of a specific type", "parameters": { - "app-id": "DEMO_APP", - "event-type": "traces", + "appId": "DEMO_APP", + "eventType": "traces", "event-top": 5 }, "responses": { diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-metadata.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-metadata.json index d7eac414c793..b36dffa32f90 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-metadata.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/events-get-metadata.json @@ -2,11 +2,14 @@ "title": "Get Events Metadata", "description": "Gets event metadata", "parameters": { - "app-id": "DEMO_APP" + "appId": "DEMO_APP" }, "responses": { "200": { - "body": "\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n" + "headers": { + "content-type": "application/xml;charset=utf-8" + }, + "body": " " } } } \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-custom.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-custom.json new file mode 100644 index 000000000000..ce53a6175202 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-custom.json @@ -0,0 +1,21 @@ +{ + "title": "Get Request Count", + "description": "Gets request count metric", + "parameters": { + "appId": "DEMO_APP", + "metricId": "sizeInMB" + }, + "responses": { + "200": { + "body": { + "value": { + "start": "2016-01-01T02:00:00.000Z", + "end": "2016-01-03T02:00:00.000Z", + "customEvents/custom/sizeInMB": { + "avg": 384.2 + } + } + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-full.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-full.json new file mode 100644 index 000000000000..167e2faa2c65 --- /dev/null +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get-full.json @@ -0,0 +1,45 @@ +{ + "title": "Get intervaled request count", + "description": "Gets intervaled request count metric", + "parameters": { + "appId": "DEMO_APP", + "metricType": "requests", + "metricId": "count", + "timespan": "P2D", + "interval": "P1D" + }, + "responses": { + "200": { + "body": { + "value": { + "start": "2018-02-04T10:01:35.086Z", + "end": "2018-02-06T10:01:35.086Z", + "interval": "P1D", + "segments": [ + { + "start": "2018-02-04T10:01:35.086Z", + "end": "2018-02-05T00:00:00.000Z", + "requests/count": { + "sum": 4927 + } + }, + { + "start": "2018-02-05T00:00:00.000Z", + "end": "2018-02-06T00:00:00.000Z", + "requests/count": { + "sum": 8460 + } + }, + { + "start": "2018-02-06T00:00:00.000Z", + "end": "2018-02-06T10:01:35.086Z", + "requests/count": { + "sum": 3743 + } + } + ] + } + } + } + } +} \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get.json index 5f551c8782ee..f4a0080be495 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-get.json @@ -1,38 +1,21 @@ { - "title": "Get Metric", - "description": "Gets data for a metric.", + "title": "Get Request Count", + "description": "Gets request count metric", "parameters": { - "app-id": "DEMO_APP", - "metric-id": "requests/failed", - "timespan": "P2D", - "interval": "P1D" + "appId": "DEMO_APP", + "metricType": "requests", + "metricId": "count" }, "responses": { "200": { "body": { - "value": [ - { - "start": "2016-01-01T02:00:00.000Z", - "end": "2016-01-03T02:00:00.000Z", - "interval": "P1D", - "segments": [ - { - "start": "2016-01-01T02:00:00.000Z", - "end": "2016-01-02T02:00:00.000Z", - "requests/failed": { - "sum": 23 - } - }, - { - "start": "2016-01-02T02:00:00.000Z", - "end": "2016-01-03T02:00:00.000Z", - "requests/failed": { - "sum": 19 - } - } - ] + "value": { + "start": "2016-01-01T02:00:00.000Z", + "end": "2016-01-03T02:00:00.000Z", + "requests/count": { + "sum": 23 } - ] + } } } } diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json index a6bf8752cda0..4e6b7cd90933 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metric-post.json @@ -2,8 +2,8 @@ "title": "Post Metric", "description": "Posts data for a metric.", "parameters": { - "app-id": "DEMO_APP", - "metricsPostBody": [ + "appId": "DEMO_APP", + "body": [ { "id": "failed", "parameters": { @@ -24,78 +24,76 @@ }, "responses": { "200": { - "body": { - "value": [ - { - "id": "failed", - "status": 200, - "body": { - "value": { - "start": "2018-01-22T19:59:12.488Z", - "end": "2018-01-24T19:59:12.488Z", - "interval": "P1D", - "segments": [ - { - "start": "2018-01-22T19:59:12.488Z", - "end": "2018-01-23T00:00:00.000Z", - "requests/failed": { - "sum": 277 - } - }, - { - "start": "2018-01-23T00:00:00.000Z", - "end": "2018-01-24T00:00:00.000Z", - "requests/failed": { - "sum": 1599 - } - }, - { - "start": "2018-01-24T00:00:00.000Z", - "end": "2018-01-24T19:59:12.488Z", - "requests/failed": { - "sum": 1392 - } + "body": [ + { + "id": "failed", + "status": 200, + "body": { + "value": { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-24T19:59:12.488Z", + "interval": "P1D", + "segments": [ + { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-23T00:00:00.000Z", + "requests/failed": { + "sum": 277 } - ] - } + }, + { + "start": "2018-01-23T00:00:00.000Z", + "end": "2018-01-24T00:00:00.000Z", + "requests/failed": { + "sum": 1599 + } + }, + { + "start": "2018-01-24T00:00:00.000Z", + "end": "2018-01-24T19:59:12.488Z", + "requests/failed": { + "sum": 1392 + } + } + ] } - }, - { - "id": "count", - "status": 200, - "body": { - "value": { - "start": "2018-01-22T19:59:12.488Z", - "end": "2018-01-24T19:59:12.488Z", - "interval": "P1D", - "segments": [ - { - "start": "2018-01-22T19:59:12.488Z", - "end": "2018-01-23T00:00:00.000Z", - "requests/count": { - "sum": 1225 - } - }, - { - "start": "2018-01-23T00:00:00.000Z", - "end": "2018-01-24T00:00:00.000Z", - "requests/count": { - "sum": 7382 - } - }, - { - "start": "2018-01-24T00:00:00.000Z", - "end": "2018-01-24T19:59:12.488Z", - "requests/count": { - "sum": 6674 - } + } + }, + { + "id": "count", + "status": 200, + "body": { + "value": { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-24T19:59:12.488Z", + "interval": "P1D", + "segments": [ + { + "start": "2018-01-22T19:59:12.488Z", + "end": "2018-01-23T00:00:00.000Z", + "requests/count": { + "sum": 1225 + } + }, + { + "start": "2018-01-23T00:00:00.000Z", + "end": "2018-01-24T00:00:00.000Z", + "requests/count": { + "sum": 7382 } - ] - } + }, + { + "start": "2018-01-24T00:00:00.000Z", + "end": "2018-01-24T19:59:12.488Z", + "requests/count": { + "sum": 6674 + } + } + ] } } - ] - } + } + ] } } } \ No newline at end of file diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metrics-get-metadata.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metrics-get-metadata.json index 2d997a12bf15..55a1344fc9a3 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metrics-get-metadata.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/metrics-get-metadata.json @@ -2,7 +2,7 @@ "title": "Get Metric Metadata", "description": "Gets metadata data for metrics.", "parameters": { - "app-id": "DEMO_APP" + "appId": "DEMO_APP" }, "responses": { "200": { diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-get.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-get.json index 29a368de9a45..37ef38562b5e 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-get.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-get.json @@ -2,7 +2,7 @@ "title": "Get Query", "description": "A simple query that returns query results.", "parameters": { - "app-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "appId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "query": "requests | take 10", "timespan": "PT12H" }, diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-post.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-post.json index bb731b028d2f..1ea2712576a7 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-post.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-post.json @@ -1,8 +1,8 @@ { - "title": "Get Query", + "title": "Post Query", "description": "A simple query that returns query results.", "parameters": { - "app-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "appId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", "body": { "timespan": "PT12H", "query": "requests | summarize count() by bin(timestamp, 1h)" diff --git a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-schema.json b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-schema.json index 1a79593a8ed0..9041c74be769 100644 --- a/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-schema.json +++ b/specification/applicationinsights/data-plane/microsoft.insights/v1/examples/query-schema.json @@ -2,7 +2,7 @@ "title": "Get Query", "description": "A simple query that returns query results.", "parameters": { - "app-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" + "appId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345" }, "responses": { "200": { @@ -11,24 +11,24 @@ "x-ms-correlation-request-id": "58a37988-2c05-427a-891f-5e0e1266fcc5" }, "body": { - "Tables": [ + "tables": [ { - "TableName": "Table_0", - "Columns": [ + "name": "Table_0", + "columns": [ { - "ColumnName": "TableName", - "DataType": "String" + "name": "TableName", + "type": "String" }, { - "ColumnName": "ColumnName", - "DataType": "String" + "name": "ColumnName", + "type": "String" }, { - "ColumnName": "ColumnType", - "DataType": "String" + "name": "ColumnType", + "type": "String" } ], - "Rows": [ + "rows": [ [ "traces", "timestamp", @@ -1849,26 +1849,25 @@ "ingestionTime", "System.DateTime" ] - ], - "KqlPrimaryTimestampColumnName": "timestamp" + ] }, { - "TableName": "Table_1", - "Columns": [ + "name": "Table_1", + "columns": [ { - "ColumnName": "TableType", - "DataType": "String" + "name": "TableType", + "type": "String" }, { - "ColumnName": "TableName", - "DataType": "String" + "name": "TableName", + "type": "String" }, { - "ColumnName": "PrimaryTimestampColumnName", - "DataType": "String" + "name": "PrimaryTimestampColumnName", + "type": "String" } ], - "Rows": [ + "rows": [ [ "ai", "traces",