From 28ab1331169bf820273f829cbd161cf880a87187 Mon Sep 17 00:00:00 2001 From: Alexander Chocron Date: Mon, 6 Nov 2017 15:06:42 -0500 Subject: [PATCH 1/8] Replace ingestion.yaml and remove others --- swagger/analytics.yaml | 1524 ---------------------------------------- swagger/crash.yaml | 112 --- swagger/devices.yaml | 93 --- swagger/ingestion.yaml | 391 +++++++---- 4 files changed, 253 insertions(+), 1867 deletions(-) delete mode 100644 swagger/analytics.yaml delete mode 100644 swagger/crash.yaml delete mode 100644 swagger/devices.yaml diff --git a/swagger/analytics.yaml b/swagger/analytics.yaml deleted file mode 100644 index f153b3486..000000000 --- a/swagger/analytics.yaml +++ /dev/null @@ -1,1524 +0,0 @@ -swagger: '2.0' -info: - title: Sonoma.Analytics - description: Microsoft Sonoma Analytics REST API. - version: '1.0.0-preview20161028' -host: api-prod-east-us2.prod.avalanch.es -schemes: - - https -consumes: - - application/json -produces: - - application/json -basePath: /v0.1 -paths: - '/apps/{app_id}/analytics/log_flow': - get: - operationId: Analytics_LogFlow - x-client-operation: Analytics_LogFlow - description: Logs received between the specified start time and the current time. The API will return a maximum of 100 logs per call. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/LogFlowStartTimeParameter' - responses: - '200': - description: List of logs for the requested time range. - schema: - $ref: '#/definitions/LogContainer' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/active_device_counts': - get: - operationId: Analytics_DeviceCounts - x-client-operation: Analytics_DeviceCounts - description: Count of active devices by interval in the time range. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Count of active devices by interval in the time range. - schema: - $ref: '#/definitions/ActiveDeviceCounts' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/session_durations_distribution': - get: - operationId: Analytics_SessionDurationsDistribution - x-client-operation: Analytics_SessionDurationsDistribution - description: Gets session duration . - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: List of session durations for requested time range. - schema: - $ref: '#/definitions/SessionDurationsDistribution' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/versions': - get: - operationId: Analytics_Versions - x-client-operation: Analytics_Versions - description: Count of active versions in the time range ordered by version. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/CountParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Count of active versions in the time range ordered by version. - schema: - $ref: '#/definitions/Versions' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/session_counts': - get: - operationId: Analytics_SessionCounts - x-client-operation: Analytics_SessionCounts - description: Count of sessions in the time range. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/IntervalParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Count of sessions in the time range. - schema: - $ref: '#/definitions/SessionCounts' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/sessions_per_device': - get: - operationId: Analytics_PerDeviceCounts - x-client-operation: Analytics_PerDeviceCounts - description: Count of sessions per device in the time range - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/IntervalParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Count of sessions per device in the time range - schema: - $ref: '#/definitions/SessionsPerDevice' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/places': - get: - operationId: Analytics_PlaceCounts - x-client-operation: Analytics_PlaceCounts - description: Places in the time range - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/CountParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Places with count during the time range in descending order - schema: - $ref: '#/definitions/Places' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/models': - get: - operationId: Analytics_ModelCounts - x-client-operation: Analytics_ModelCounts - description: models in the time range - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/CountParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Models with count during the time range in descending order - schema: - $ref: '#/definitions/AnalyticsModels' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/languages': - get: - operationId: Analytics_LanguageCounts - x-client-operation: Analytics_LanguageCounts - description: languages in the time range - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/CountParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Languages with count during the time range in descending order - schema: - $ref: '#/definitions/Languages' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/oses': - get: - operationId: Analytics_OperatingSystemCounts - x-client-operation: Analytics_OperatingSystemCounts - description: OSes in the time range - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/CountParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: OSes with count during the time range in descending order - schema: - $ref: '#/definitions/OSes' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/available_versions': - x-internal: true - get: - x-ms-pageable: - nextLinkName: nextLink - operationId: Analytics_AvailableVersions - x-client-operation: Analytics_AvailableVersions - description: Get all available versions in the time range. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/TopParameter' - - $ref: '#/parameters/SkipParameter' - - $ref: '#/parameters/FilterParameter' - - $ref: '#/parameters/InlineCountParameter' - responses: - '200': - description: A list of available versions in the time range. - schema: - $ref: '#/definitions/AvailableVersions' - default: - description: Error code with reason. - schema: - $ref: '#/definitions/Error' - '/apps/{app_id}/analytics/crash_counts': - get: - operationId: Analytics_CrashCounts - x-client-operation: Analytics_CrashCounts - description: Count of crashes by day in the time range based the selected versions. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Count of crashes by day in the time range and total crashes over the time range. - schema: - $ref: '#/definitions/CrashCounts' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/crashfree_device_percentages': - get: - operationId: Analytics_CrashFreeDevicePercentages - x-client-operation: Analytics_CrashFreeDevicePercentages - description: Percentage of crash-free device by day in the time range based on the selected versions. Api will return -1 if crash devices is greater than active devices - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Percentage of crash-free devices by day in the time range and overall percentage of the time range. - schema: - $ref: '#/definitions/CrashFreeDevicePercentages' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/crash_groups': - post: - operationId: Analytics_CrashGroupsTotals - x-client-operation: Analytics_CrashGroupsTotals - description: Overall crashes and affected users count of the selected crash groups with selected versions - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/CrashGroupsParameter' - responses: - '200': - description: Overall crashes and affected users count for all selected crash groups - schema: - $ref: '#/definitions/CrashesOverall' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/crash_groups/{crash_group_id}/overall': - get: - operationId: Analytics_CrashGroupTotals - x-client-operation: Analytics_CrashGroupTotals - description: Overall crashes and affected users count of the selected crash group with selected version - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/CrashGroupParameter' - - $ref: '#/parameters/VersionParameter' - responses: - '200': - description: Overall crashes and affected users count - schema: - $ref: '#/definitions/CrashOverall' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/crash_groups/{crash_group_id}/crash_counts': - get: - operationId: Analytics_CrashGroupCounts - x-client-operation: Analytics_CrashGroupCounts - description: Count of crashes by day in the time range of the selected crash group with selected version - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/CrashGroupParameter' - - $ref: '#/parameters/VersionParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - responses: - '200': - description: Count of crashes by day in the time range and total crashes over the time range. - schema: - $ref: '#/definitions/CrashCounts' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/crash_groups/{crash_group_id}/models': - get: - operationId: Analytics_CrashGroupModelCounts - x-client-operation: Analytics_CrashGroupModelCounts - description: top models of the selected crash group with selected version - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/CrashGroupParameter' - - $ref: '#/parameters/VersionParameter' - - $ref: '#/parameters/TopParameter' - responses: - '200': - description: Top Models with percentage in descending order - schema: - $ref: '#/definitions/CrashGroupModels' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/crash_groups/{crash_group_id}/operating_systems': - get: - operationId: Analytics_CrashGroupOperatingSystemCounts - x-client-operation: Analytics_CrashGroupOperatingSystemCounts - description: top OSes of the selected crash group with selected version - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/CrashGroupParameter' - - $ref: '#/parameters/VersionParameter' - - $ref: '#/parameters/TopParameter' - responses: - '200': - description: Top OSes with percentage in descending order - schema: - $ref: '#/definitions/CrashGroupOperatingSystems' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/events': - get: - operationId: Analytics_Events - x-client-operation: Analytics_Events - description: Count of active events in the time range ordered by event. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/VersionsParameter' - - $ref: '#/parameters/EventNameParameter' - - $ref: '#/parameters/TopParameter' - - $ref: '#/parameters/SkipParameter' - - $ref: '#/parameters/InlineCountParameter' - - $ref: '#/parameters/OrderByParameter' - responses: - '200': - description: Count of active events in the time range ordered by event. - schema: - $ref: '#/definitions/Events' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/events/{event_name}/event_count': - get: - operationId: Analytics_EventCount - x-client-operation: Analytics_EventCount - description: Count of events by interval in the time range. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/EventParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Count of events by interval in the time range. - schema: - $ref: '#/definitions/EventCount' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/events/{event_name}/device_count': - get: - operationId: Analytics_EventDeviceCount - x-client-operation: Analytics_EventDeviceCount - description: Count of devices for an event by interval in the time range. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/EventParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Count of devices for an event by interval in the time range. - schema: - $ref: '#/definitions/EventDeviceCount' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/events/{event_name}/count_per_device': - get: - operationId: Analytics_EventPerDeviceCount - x-client-operation: Analytics_EventPerDeviceCount - description: Count of events per device by interval in the time range. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/EventParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Count of events per device by interval in the time range. - schema: - $ref: '#/definitions/EventCountPerDevice' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/events/{event_name}/count_per_session': - get: - operationId: Analytics_EventPerSessionCount - x-client-operation: Analytics_EventPerSessionCount - description: Count of events per session by interval in the time range. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/EventParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/VersionsParameter' - responses: - '200': - description: Count of events per session by interval in the time range. - schema: - $ref: '#/definitions/EventCountPerSession' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/events/{event_name}/properties': - get: - operationId: Analytics_EventProperties - x-client-operation: Analytics_EventProperties - description: Event properties. Up to the first 5 received properties. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/EventParameter' - responses: - '200': - description: Event properties. Up to the first 5 received properties. - schema: - $ref: '#/definitions/EventProperties' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - - '/apps/{app_id}/analytics/events/{event_name}/properties/{event_property_name}/counts': - get: - operationId: Analytics_EventPropertyCounts - x-client-operation: Analytics_EventPropertyCounts - description: Event properties value counts during the time range in descending order. Limited up to 5 values. - parameters: - - $ref: '#/parameters/AppKeyParameter' - - $ref: '#/parameters/EventParameter' - - $ref: '#/parameters/EventPropertyParameter' - - $ref: '#/parameters/StartParameter' - - $ref: '#/parameters/EndParameter' - - $ref: '#/parameters/VersionsParameter' - - $ref: '#/parameters/PropertyCountParameter' - responses: - '200': - description: Event properties value counts during the time range in descending order. Limited up to 5 values. - schema: - $ref: '#/definitions/EventPropertyValues' - default: - description: Error code with reason - schema: - $ref: '#/definitions/Error' - -parameters: - AppKeyParameter: - name: app_id - in: path - description: The id of the application - required: true - type: string - format: string - - StartParameter: - name: start - in: query - description: Start date time in data in ISO 8601 date time format - required: true - type: string - format: date-time - - LogFlowStartTimeParameter: - name: start - in: query - description: Start date time in data in ISO 8601 date time format. It must be within the current day in the UTC timezone. The default value is the start time of the current day in UTC timezone. - required: false - type: string - format: date-time - - EndParameter: - name: end - in: query - description: Last date time in data in ISO 8601 date time format - required: false - type: string - format: date-time - - CrashGroupParameter: - name: crash_group_id - in: path - description: The id of the crash group - required: true - type: string - format: string - - CrashGroupsParameter: - name: crash_groups - in: body - required: true - schema: - $ref: "#/definitions/CrashGroupContainer" - - EventParameter: - name: event_name - in: path - description: The id of the event - required: true - type: string - format: string - - EventPropertyParameter: - name: event_property_name - in: path - description: The id of the event property - required: true - type: string - format: string - - IntervalParameter: - name: interval - in: query - description: Size of interval in ISO 8601 duration format. (PnYnMnDTnHnMnS|PnW|PT