@datafire/appcenter_ms

v3.0.0

Published

2 years ago

DataFire integration for App Center Client

Downloads

0High
0Medium
0Low

datafire

@datafire/appcenter_ms

Client library for App Center Client

Installation and Usage

npm install --save @datafire/appcenter_ms

let appcenter_ms = require('@datafire/appcenter_ms').create({
  APIToken: "",
  username: "",
  password: ""
});

.then(data => {
  console.log(data);
});

Description

Microsoft Visual Studio App Center API

Actions

test_gdprExportAccounts

Lists all the endpoints available for Test accounts data

appcenter_ms.test_gdprExportAccounts(null, context)

Input

This action has no parameters

Output

output object
- resources array
  - items object
    - path string
    - rel string

test_gdprExportAccount

Lists account data

appcenter_ms.test_gdprExportAccount(null, context)

Input

This action has no parameters

Output

output object
- id string

test_gdprExportFeatureFlag

Lists feature flag data

appcenter_ms.test_gdprExportFeatureFlag(null, context)

Input

This action has no parameters

Output

output object
- name string
- target_id string

organizations_listAdministered

Returns a list organizations in which the requesting user is an admin

appcenter_ms.organizations_listAdministered(null, context)

Input

This action has no parameters

Output

output object
- organizations required object
  - avatar_url string: The URL to a user-uploaded Avatar image
  - created_at required string: The creation date of this organization
  - display_name required string: The display name of the organization
  - id required string: The internal unique id (UUID) of the organization.
  - name required string: The slug name of the organization
  - origin required string (values: appcenter, hockeyapp): The creation origin of this organization
  - updated_at required string: The date the organization was last updated at

userApiTokens_list

Returns api tokens for the authenticated user

appcenter_ms.userApiTokens_list(null, context)

Input

This action has no parameters

Output

output array
- items object
  - created_at required string: The creation time
  - description string: The description of the token
  - id required string: The unique id (UUID) of the api token
  - scope array: The scope for this token.
    - items string (values: all, viewer)

userApiTokens_new

Creates a new User API token

appcenter_ms.userApiTokens_new({}, context)

Input

input object
- description object
  - description string: The description of the token
  - scope array: The scope for this token.
    - items string (values: all, viewer)

Output

output object
- api_token required string: The api token generated will not be accessible again
- created_at required string: The creation time
- description string: The description of the token
- id required string: The unique id (UUID) of the api token
- scope array: The scope for this token.
  - items string (values: all, viewer)

userApiTokens_delete

Delete the user api_token object with the specific id

appcenter_ms.userApiTokens_delete({
  "api_token_id": ""
}, context)

Input

input object
- api_token_id required string: The unique ID (UUID) of the api token

Output

Output schema unknown

apps_list

Returns a list of apps

appcenter_ms.apps_list({}, context)

Input

input object
- $orderBy string (values: display_name, name): The name of the attribute by which to order the response by. By default, apps are in order of creation. All results are ordered in ascending order.

Output

output array
- items
  - description string: The description of the app
  - display_name required string: The display name of the app
  - icon_source string: The string representation of the source of the app's icon
  - icon_url string: The string representation of the URL pointing to the app's icon
  - id required string: The unique ID (UUID) of the app
  - name required string: The name of the app used in URLs
  - os required string (values: Android, iOS, macOS, Tizen, tvOS, Windows, Linux, Custom): The OS the app will be running on
  - owner required object: The information about the app's owner
    - avatar_url string: The avatar URL of the owner
    - display_name required string: The owner's display name
    - email string: The owner's email address
    - id required string: The unique id (UUID) of the owner
    - name required string: The unique name that used to identify the owner
    - type required string (values: org, user): The owner type. Can either be 'org' or 'user'
  - release_type string: A one-word descriptive release-type value that starts with a capital letter but is otherwise lowercase
  - app_secret string: A unique and secret key used to identify the app in communication with the ingestion endpoint for crash reporting and analytics
  - azure_subscription object
    - is_billable boolean: If the subscription can be used for billing
    - is_billing boolean: If the subscription is used for billing
    - is_microsoft_internal boolean: If the subscription is internal Microsoft subscription
    - subscription_id required string: The azure subscription id
    - subscription_name required string: The name of the azure subscription
    - tenant_id required string: The tenant id of the azure subscription belongs to
  - created_at string: The created date of this app
  - member_permissions array: The permissions of the calling user
    - items string (values: manager, developer, viewer, tester)
  - origin string (values: appcenter, hockeyapp, codepush): The creation origin of this app
  - platform string (values: Java, Objective-C-Swift, UWP, Cordova, React-Native, Unity, Electron, Xamarin, WPF, WinForms, Unknown, Custom): The platform of the app
  - updated_at string: The last updated date of this app

apps_create

Creates a new app and returns it to the caller

appcenter_ms.apps_create({
  "app": null
}, context)

Input

input object
- app required object
  - description string: A short text describing the app
  - display_name required string: The descriptive name of the app. This can contain any characters
  - name string: The name of the app used in URLs
  - os required string (values: Android, iOS, macOS, Tizen, tvOS, Windows, Linux, Custom): The OS the app will be running on
  - platform required string (values: Java, Objective-C-Swift, UWP, Cordova, React-Native, Xamarin, Unity, Electron, WPF, WinForms, Custom): The platform of the app
  - release_type string: A one-word descriptive release-type value that starts with a capital letter but is otherwise lowercase

Output

output
- description string: The description of the app
- display_name required string: The display name of the app
- icon_source string: The string representation of the source of the app's icon
- icon_url string: The string representation of the URL pointing to the app's icon
- id required string: The unique ID (UUID) of the app
- name required string: The name of the app used in URLs
- os required string (values: Android, iOS, macOS, Tizen, tvOS, Windows, Linux, Custom): The OS the app will be running on
- owner required object: The information about the app's owner
  - avatar_url string: The avatar URL of the owner
  - display_name required string: The owner's display name
  - email string: The owner's email address
  - id required string: The unique id (UUID) of the owner
  - name required string: The unique name that used to identify the owner
  - type required string (values: org, user): The owner type. Can either be 'org' or 'user'
- release_type string: A one-word descriptive release-type value that starts with a capital letter but is otherwise lowercase
- app_secret string: A unique and secret key used to identify the app in communication with the ingestion endpoint for crash reporting and analytics
- azure_subscription object
  - is_billable boolean: If the subscription can be used for billing
  - is_billing boolean: If the subscription is used for billing
  - is_microsoft_internal boolean: If the subscription is internal Microsoft subscription
  - subscription_id required string: The azure subscription id
  - subscription_name required string: The name of the azure subscription
  - tenant_id required string: The tenant id of the azure subscription belongs to
- created_at string: The created date of this app
- member_permissions array: The permissions of the calling user
  - items string (values: manager, developer, viewer, tester)
- origin string (values: appcenter, hockeyapp, codepush): The creation origin of this app
- platform string (values: Java, Objective-C-Swift, UWP, Cordova, React-Native, Unity, Electron, Xamarin, WPF, WinForms, Unknown, Custom): The platform of the app
- updated_at string: The last updated date of this app

apps_delete

Delete an app

appcenter_ms.apps_delete({
  "app_name": "",
  "owner_name": ""
}, context)

Input

input object
- app_name required string: The name of the application
- owner_name required string: The name of the owner

Output

Output schema unknown

apps_get

Return a specific app with the given app name which belongs to the given owner.

appcenter_ms.apps_get({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output
- description string: The description of the app
- display_name required string: The display name of the app
- icon_source string: The string representation of the source of the app's icon
- icon_url string: The string representation of the URL pointing to the app's icon
- id required string: The unique ID (UUID) of the app
- name required string: The name of the app used in URLs
- os required string (values: Android, iOS, macOS, Tizen, tvOS, Windows, Linux, Custom): The OS the app will be running on
- owner required object: The information about the app's owner
  - avatar_url string: The avatar URL of the owner
  - display_name required string: The owner's display name
  - email string: The owner's email address
  - id required string: The unique id (UUID) of the owner
  - name required string: The unique name that used to identify the owner
  - type required string (values: org, user): The owner type. Can either be 'org' or 'user'
- release_type string: A one-word descriptive release-type value that starts with a capital letter but is otherwise lowercase
- app_secret string: A unique and secret key used to identify the app in communication with the ingestion endpoint for crash reporting and analytics
- azure_subscription object
  - is_billable boolean: If the subscription can be used for billing
  - is_billing boolean: If the subscription is used for billing
  - is_microsoft_internal boolean: If the subscription is internal Microsoft subscription
  - subscription_id required string: The azure subscription id
  - subscription_name required string: The name of the azure subscription
  - tenant_id required string: The tenant id of the azure subscription belongs to
- created_at string: The created date of this app
- member_permissions array: The permissions of the calling user
  - items string (values: manager, developer, viewer, tester)
- origin string (values: appcenter, hockeyapp, codepush): The creation origin of this app
- platform string (values: Java, Objective-C-Swift, UWP, Cordova, React-Native, Unity, Electron, Xamarin, WPF, WinForms, Unknown, Custom): The platform of the app
- updated_at string: The last updated date of this app

apps_update

Partially updates a single app

appcenter_ms.apps_update({
  "app_name": "",
  "owner_name": ""
}, context)

Input

input object
- app_name required string: The name of the application
- owner_name required string: The name of the owner
- app object
  - description string: A short text describing the app
  - display_name string: The display name of the app
  - icon_asset_id string: The uuid for the icon's asset id from ACFUS
  - icon_url string: The string representation of the URL pointing to the app's icon
  - name string: The name of the app used in URLs
  - release_type string: A one-word descriptive release type value that starts with a capital letter but is otherwise lowercase

Output

output
- description string: The description of the app
- display_name required string: The display name of the app
- icon_source string: The string representation of the source of the app's icon
- icon_url string: The string representation of the URL pointing to the app's icon
- id required string: The unique ID (UUID) of the app
- name required string: The name of the app used in URLs
- os required string (values: Android, iOS, macOS, Tizen, tvOS, Windows, Linux, Custom): The OS the app will be running on
- owner required object: The information about the app's owner
  - avatar_url string: The avatar URL of the owner
  - display_name required string: The owner's display name
  - email string: The owner's email address
  - id required string: The unique id (UUID) of the owner
  - name required string: The unique name that used to identify the owner
  - type required string (values: org, user): The owner type. Can either be 'org' or 'user'
- release_type string: A one-word descriptive release-type value that starts with a capital letter but is otherwise lowercase
- app_secret string: A unique and secret key used to identify the app in communication with the ingestion endpoint for crash reporting and analytics
- azure_subscription object
  - is_billable boolean: If the subscription can be used for billing
  - is_billing boolean: If the subscription is used for billing
  - is_microsoft_internal boolean: If the subscription is internal Microsoft subscription
  - subscription_id required string: The azure subscription id
  - subscription_name required string: The name of the azure subscription
  - tenant_id required string: The tenant id of the azure subscription belongs to
- created_at string: The created date of this app
- member_permissions array: The permissions of the calling user
  - items string (values: manager, developer, viewer, tester)
- origin string (values: appcenter, hockeyapp, codepush): The creation origin of this app
- platform string (values: Java, Objective-C-Swift, UWP, Cordova, React-Native, Unity, Electron, Xamarin, WPF, WinForms, Unknown, Custom): The platform of the app
- updated_at string: The last updated date of this app

Analytics_DeviceCounts

Count of active devices by interval in the time range.

appcenter_ms.Analytics_DeviceCounts({
  "start": "",
  "app_build": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- versions array
- app_build required string
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- daily array: The active device count for each interval.
  - items object
    - count integer: Count of the object.
    - datetime string: The ISO 8601 datetime.
- monthly array: The active device count for each interval with a month's retention.
  - items object
    - count integer: Count of the object.
    - datetime string: The ISO 8601 datetime.
- weekly array: The active device count for each interval with a week's retention.
  - items object
    - count integer: Count of the object.
    - datetime string: The ISO 8601 datetime.

Analytics_ListAudiences

Get list of audiences.

appcenter_ms.Analytics_ListAudiences({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- include_disabled boolean: Include disabled audience definitions
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: List of audiences.
- nextLink string
- values required array: List of audiences.
  - items object: Audience definition.
    - definition string: Audience definition in OData format.
    - description string: Audience description.
    - estimated_count integer: Estimated audience size.
    - name string: Audience name.
    - state string (values: Calculating, Ready, Disabled): Audience state.

Analytics_TestAudience

Tests audience definition.

appcenter_ms.Analytics_TestAudience({
  "audience": {
    "definition": ""
  },
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- audience required object: Audience definition.
  - custom_properties object: Custom properties used in the definition.
  - definition required string: Audience definition in OData format.
  - description string: Audience description.
  - enabled boolean
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: Audience test result.
- custom_properties object: Custom properties used in the definition.
- definition string: Audience definition in OData format.
- estimated_count integer: Estimated audience size.
- estimated_total_count integer: Estimated total audience size.

Analytics_ListCustomProperties

Get list of custom properties.

appcenter_ms.Analytics_ListCustomProperties({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: List of device properties.
- values required object: List of device properties.

Analytics_ListDeviceProperties

Get list of device properties.

appcenter_ms.Analytics_ListDeviceProperties({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: List of device properties.
- values required object: List of device properties.

Analytics_ListDevicePropertyValues

Get list of device property values.

appcenter_ms.Analytics_ListDevicePropertyValues({
  "property_name": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- property_name required string: Device property
- contains string: Contains string
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: List of device property values.
- values required array: List of device property values.
  - items string

Analytics_DeleteAudience

Deletes audience definition.

appcenter_ms.Analytics_DeleteAudience({
  "audience_name": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- audience_name required string: The name of the audience
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

Output schema unknown

Analytics_GetAudience

Gets audience definition.

appcenter_ms.Analytics_GetAudience({
  "audience_name": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- audience_name required string: The name of the audience
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: Audience with details.
- custom_properties object: Custom properties used in the definition.
- enabled boolean
- estimated_total_count integer: Estimated total audience size.
- timestamp string: Date the audience was last refreshed.
- definition string: Audience definition in OData format.
- description string: Audience description.
- estimated_count integer: Estimated audience size.
- name string: Audience name.
- state string (values: Calculating, Ready, Disabled): Audience state.

Analytics_AudienceNameExists

Returns whether audience definition exists.

appcenter_ms.Analytics_AudienceNameExists({
  "audience_name": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- audience_name required string: The name of the audience
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

Output schema unknown

Analytics_CreateOrUpdateAudience

Creates or updates audience definition.

appcenter_ms.Analytics_CreateOrUpdateAudience({
  "audience_name": "",
  "audience": {
    "definition": ""
  },
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- audience_name required string: The name of the audience
- audience required object: Audience definition.
  - custom_properties object: Custom properties used in the definition.
  - definition required string: Audience definition in OData format.
  - description string: Audience description.
  - enabled boolean
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: Audience with details.
- custom_properties object: Custom properties used in the definition.
- enabled boolean
- estimated_total_count integer: Estimated total audience size.
- timestamp string: Date the audience was last refreshed.
- definition string: Audience definition in OData format.
- description string: Audience description.
- estimated_count integer: Estimated audience size.
- name string: Audience name.
- state string (values: Calculating, Ready, Disabled): Audience state.

Analytics_CrashCounts

Count of crashes by day in the time range based the selected versions. Available for UWP apps only.

appcenter_ms.Analytics_CrashCounts({
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- count integer: Total crash count.
- crashes array: The total crash count for day.
  - items object
    - count integer: Count of the object.
    - datetime string: The ISO 8601 datetime.

Analytics_CrashGroupsTotals

Overall crashes and affected users count of the selected crash groups with selected versions.

appcenter_ms.Analytics_CrashGroupsTotals({
  "crash_groups": {
    "crash_groups": []
  },
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- crash_groups required object
  - crash_groups required array
    - items object
      - app_version string
      - crash_group_id string
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output array: List of crash groups with overall crashes count and affected users.
- items object
  - app_version string
  - crash_group_id string
  - overall object
    - crash_count integer
    - device_count integer

Analytics_CrashGroupCounts

Count of crashes by day in the time range of the selected crash group with selected version. Available for UWP apps only.

appcenter_ms.Analytics_CrashGroupCounts({
  "crash_group_id": "",
  "version": "",
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- crash_group_id required string: The id of the crash group.
- version required string
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- count integer: Total crash count.
- crashes array: The total crash count for day.
  - items object
    - count integer: Count of the object.
    - datetime string: The ISO 8601 datetime.

Analytics_CrashGroupModelCounts

Top models of the selected crash group with selected version. Available for UWP apps only.

appcenter_ms.Analytics_CrashGroupModelCounts({
  "crash_group_id": "",
  "version": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- crash_group_id required string: The id of the crash group.
- version required string
- $top integer: The maximum number of results to return. (0 will fetch all results)
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- crash_count integer
- models array
  - items object
    - crash_count integer: Count of model.
    - model_name string: Model's name.

Analytics_CrashGroupOperatingSystemCounts

Top OSes of the selected crash group with selected version. Available for UWP apps only.

appcenter_ms.Analytics_CrashGroupOperatingSystemCounts({
  "crash_group_id": "",
  "version": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- crash_group_id required string: The id of the crash group.
- version required string
- $top integer: The maximum number of results to return. (0 will fetch all results)
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- crash_count integer
- operating_systems array
  - items object
    - crash_count integer: Count of OS.
    - operating_system_name string: OS name.

Analytics_CrashGroupTotals

Overall crashes and affected users count of the selected crash group with selected version. Available for UWP apps only.

appcenter_ms.Analytics_CrashGroupTotals({
  "crash_group_id": "",
  "version": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- crash_group_id required string: The id of the crash group.
- version required string
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- crash_count integer
- device_count integer

Analytics_CrashFreeDevicePercentages

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.

appcenter_ms.Analytics_CrashFreeDevicePercentages({
  "start": "",
  "version": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- version required string
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- average_percentage number: Average percentage.
- daily_percentages array: The crash-free percentage per day.
  - items object
    - datetime string: The ISO 8601 datetime.
    - percentage number: Percentage of the object.

Analytics_DistributionReleaseCounts

Count of total downloads for the provided distribution releases.

appcenter_ms.Analytics_DistributionReleaseCounts({
  "releases": {
    "releases": []
  },
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- releases required object
  - releases required array
    - items object
      - distribution_group string: Distribution group Id.
      - release required string: Release Id.
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- counts required array
  - items object
    - distribution_group string: Distribution group queried.
    - release_id required string
    - total_count required integer: Total count of downloads.
    - unique_count required integer: Count of unique downloads against user id.
- total integer

Analytics_EventsDeleteLogs

Delete the set of Events with the specified event names.

appcenter_ms.Analytics_EventsDeleteLogs({
  "event_name": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- event_name required string: The id of the event.
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

Output schema unknown

Analytics_Events

Count of active events in the time range ordered by event.

appcenter_ms.Analytics_Events({
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- versions array
- event_name array: To select the specific events.
- $top integer: The maximum number of results to return. (0 will fetch all results)
- $skip integer: The offset (starting at 0) of the first result to return. This parameter along with limit is used to perform pagination.
- $inlinecount string (values: allpages, none): Controls whether or not to include a count of all the items across all pages.
- $orderby string: controls the sorting order and sorting based on which column
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- events array
  - items object
    - count integer
    - count_per_device number
    - count_per_session number
    - device_count integer
    - id string
    - name string
    - previous_count integer: The event count of previous time range of the event.
    - previous_device_count integer: The device count of previous time range of the event.
- total integer: The total count of events.
- total_devices integer: The active device over this period.

Analytics_EventsDelete

Delete the set of Events with the specified event names.

appcenter_ms.Analytics_EventsDelete({
  "event_name": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- event_name required string: The id of the event.
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

Output schema unknown

Analytics_EventPerDeviceCount

Count of events per device by interval in the time range.

appcenter_ms.Analytics_EventPerDeviceCount({
  "event_name": "",
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- event_name required string: The id of the event.
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- avg_count_per_device number
- count_per_device array
  - items object
    - count number: Decimal count of the object.
    - datetime string: The ISO 8601 datetime.
- previous_avg_count_per_device number

Analytics_EventPerSessionCount

Count of events per session by interval in the time range.

appcenter_ms.Analytics_EventPerSessionCount({
  "event_name": "",
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- event_name required string: The id of the event.
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- avg_count_per_session number
- count_per_session array
  - items object
    - count number: Decimal count of the object.
    - datetime string: The ISO 8601 datetime.
- previous_avg_count_per_session number

Analytics_EventDeviceCount

Count of devices for an event by interval in the time range.

appcenter_ms.Analytics_EventDeviceCount({
  "event_name": "",
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- event_name required string: The id of the event.
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- devices_count array
  - items object
    - count integer: Count of the object.
    - datetime string: The ISO 8601 datetime.
- previous_total_devices_with_event integer
- total_devices integer
- total_devices_with_event integer

Analytics_EventCount

Count of events by interval in the time range.

appcenter_ms.Analytics_EventCount({
  "event_name": "",
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- event_name required string: The id of the event.
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- count array
  - items object
    - count integer: Count of the object.
    - datetime string: The ISO 8601 datetime.
- previous_total_count integer
- total_count integer

Analytics_EventProperties

Event properties.

appcenter_ms.Analytics_EventProperties({
  "event_name": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- event_name required string: The id of the event.
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: Event properties during the time range.
- event_properties array
  - items string: The event property.

Analytics_EventPropertyCounts

Event properties value counts during the time range in descending order.

appcenter_ms.Analytics_EventPropertyCounts({
  "event_name": "",
  "event_property_name": "",
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- event_name required string: The id of the event.
- event_property_name required string: The id of the event property.
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- versions array
- $top integer: The number of property values to return. Set to 0 in order to fetch all results available.
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: Event property value counts during the time range in descending order.
- total integer: The total property value counts.
- values array: The event property values.
  - items object: An event property value with counts.
    - count integer: The count of the the event property value.
    - name string: The event property value name.
    - previous_count integer: The count of previous time range of the event property value.

Analytics_GenericLogFlow

Logs received between the specified start time and the current time. The API will return a maximum of 100 logs per call.

appcenter_ms.Analytics_GenericLogFlow({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start string: 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.
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- exceeded_max_limit boolean: indicates if the number of available logs are more than the max allowed return limit(100).
- last_received_log_timestamp string: the timestamp of the last log received. This value can be used as the start time parameter in the consecutive API call.
- logs required array: the list of logs
  - items object: Generic log.
    - account_id string: Account ID of the authenticated user.
    - auth_provider string: Auth service provider.
    - device required object: Device characteristics.
      - app_build required string: The app's build number, e.g. 42.
      - app_namespace string: The bundle identifier, package identifier, or namespace, depending on what the individual plattforms use, .e.g com.microsoft.example.
      - app_version required string: Application version name, e.g. 1.1.0
      - carrier_code string: Carrier country code (for mobile devices).
      - carrier_country string: Carrier country.
      - carrier_name string: Carrier name (for mobile devices).
      - live_update_deployment_key string: Identifier of environment that current application release belongs to, deployment key then maps to environment like Production, Staging.
      - live_update_package_hash string: Hash of all files (ReactNative or Cordova) deployed to device via LiveUpdate beacon. Helps identify the Release version on device or need to download updates in future.
      - live_update_release_label string: Label that is used to identify application code 'version' released via Live Update beacon running on device
      - locale required string: Language code (example: en_US).
      - model string: Device model (example: iPad2,3).
      - oem_name string: Device manufacturer (example: HTC).
      - os_api_level integer: API level when applicable like in Android (example: 15).
      - os_build string: OS build code (example: LMY47X).
      - os_name required string: OS name (example: iOS). The following OS names are standardized (non-exclusive): Android, iOS, macOS, tvOS, Windows.
      - os_version required string: OS version (example: 9.3.0).
      - screen_size string: Screen size of the device in pixels (example: 640x480).
      - sdk_name required string: Name of the SDK. Consists of the name of the SDK and the platform, e.g. "appcenter.ios", "hockeysdk.android".
      - sdk_version required string: Version of the SDK in semver format, e.g. "1.2.0" or "0.12.3-alpha.1".
      - time_zone_offset required integer: The offset in minutes from UTC for the device time zone, including daylight savings time.
      - wrapper_runtime_version string: Version of the wrapper technology framework (Xamarin runtime version or ReactNative or Cordova etc...). See wrapper_sdk_name to see if this version refers to Xamarin or ReactNative or other.
      - wrapper_sdk_name string: Name of the wrapper SDK. Consists of the name of the SDK and the wrapper platform, e.g. "appcenter.xamarin", "hockeysdk.cordova".
      - wrapper_sdk_version string: Version of the wrapper SDK in semver format. When the SDK is embedding another base SDK (for example Xamarin.Android wraps Android), the Xamarin specific version is populated into this field while sdkVersion refers to the original Android SDK.
    - event_id string: Event ID.
    - event_name string: Event name.
    - install_id required string: Install ID.
    - message_id string: Message ID.
    - properties object: event specific properties.
    - session_id string: Session ID.
    - timestamp required string: Log creation timestamp.
    - type required string (values: event, page, start_session, error, push_installation, start_service, custom_properties): Log type.

Analytics_LanguageCounts

Languages in the time range.

appcenter_ms.Analytics_LanguageCounts({
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- $top integer: The maximum number of results to return. (0 will fetch all results)
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- languages array
  - items object
    - count integer: Count current of language.
    - language_name string: Language's name.
    - previous_count integer: Count of previous lanugage.
- total integer

Analytics_LogFlow

Logs received between the specified start time and the current time. The API will return a maximum of 100 logs per call.

appcenter_ms.Analytics_LogFlow({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start string: 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.
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- exceeded_max_limit boolean: indicates if the number of available logs are more than the max allowed return limit(100).
- last_received_log_timestamp string: the timestamp of the last log received. This value can be used as the start time parameter in the consecutive API call.
- logs required array: the list of logs
  - items object
    - device required object: Device characteristics.
      - app_build required string: The app's build number, e.g. 42.
      - app_namespace string: The bundle identifier, package identifier, or namespace, depending on what the individual plattforms use, .e.g com.microsoft.example.
      - app_version required string: Application version name, e.g. 1.1.0
      - carrier_code string: Carrier country code (for mobile devices).
      - carrier_country string: Carrier country.
      - carrier_name string: Carrier name (for mobile devices).
      - live_update_deployment_key string: Identifier of environment that current application release belongs to, deployment key then maps to environment like Production, Staging.
      - live_update_package_hash string: Hash of all files (ReactNative or Cordova) deployed to device via LiveUpdate beacon. Helps identify the Release version on device or need to download updates in future.
      - live_update_release_label string: Label that is used to identify application code 'version' released via Live Update beacon running on device
      - locale required string: Language code (example: en_US).
      - model string: Device model (example: iPad2,3).
      - oem_name string: Device manufacturer (example: HTC).
      - os_api_level integer: API level when applicable like in Android (example: 15).
      - os_build string: OS build code (example: LMY47X).
      - os_name required string: OS name (example: iOS). The following OS names are standardized (non-exclusive): Android, iOS, macOS, tvOS, Windows.
      - os_version required string: OS version (example: 9.3.0).
      - screen_size string: Screen size of the device in pixels (example: 640x480).
      - sdk_name required string: Name of the SDK. Consists of the name of the SDK and the platform, e.g. "appcenter.ios", "hockeysdk.android".
      - sdk_version required string: Version of the SDK in semver format, e.g. "1.2.0" or "0.12.3-alpha.1".
      - time_zone_offset required integer: The offset in minutes from UTC for the device time zone, including daylight savings time.
      - wrapper_runtime_version string: Version of the wrapper technology framework (Xamarin runtime version or ReactNative or Cordova etc...). See wrapper_sdk_name to see if this version refers to Xamarin or ReactNative or other.
      - wrapper_sdk_name string: Name of the wrapper SDK. Consists of the name of the SDK and the wrapper platform, e.g. "appcenter.xamarin", "hockeysdk.cordova".
      - wrapper_sdk_version string: Version of the wrapper SDK in semver format. When the SDK is embedding another base SDK (for example Xamarin.Android wraps Android), the Xamarin specific version is populated into this field while sdkVersion refers to the original Android SDK.
    - install_id required string: Install ID.
    - timestamp required string: Log creation timestamp.
    - type required string (values: event, page, start_session, error, push_installation, start_service, custom_properties): Log type.

Analytics_ModelCounts

Models in the time range.

appcenter_ms.Analytics_ModelCounts({
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- $top integer: The maximum number of results to return. (0 will fetch all results)
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- models array
  - items object
    - count integer: Count current of model.
    - model_name string: Model's name.
    - previous_count integer: Count of previous model.
- total integer

Analytics_OperatingSystemCounts

OSes in the time range.

appcenter_ms.Analytics_OperatingSystemCounts({
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- $top integer: The maximum number of results to return. (0 will fetch all results)
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- oses array
  - items object
    - count integer: Count current of OS.
    - os_name string: OS name.
    - previous_count integer: Count of previous OS.
- total integer

Analytics_PlaceCounts

Places in the time range.

appcenter_ms.Analytics_PlaceCounts({
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- $top integer: The maximum number of results to return. (0 will fetch all results)
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: Places and count during the time range in descending order.
- places array
  - items object: The place code and the count.
    - code string: The place code.
    - count integer: The count of the this place.
    - previous_count integer: The count of previous time range of the place.
- total integer

Analytics_SessionCounts

Count of sessions in the time range.

appcenter_ms.Analytics_SessionCounts({
  "start": "",
  "interval": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- interval required string: Size of interval in ISO 8601 duration format. (PnYnMnDTnHnMnS|PnW|PT). The valid durations are 1 day (P1D), 1 week (P1W), and 30 days (P30D).
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output array
- items object
  - count integer: Count of the object.
  - datetime string: The ISO 8601 datetime.

Analytics_SessionDurationsDistribution

Gets session duration.

appcenter_ms.Analytics_SessionDurationsDistribution({
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- average_duration string: The average session duration for current time range.
- distribution array: The count of sessions in these buckets.
  - items object
    - bucket string: The bucket name.
    - count integer: The count of sessions in current bucket.
- previous_average_duration string: The previous average session duration for previous time range.

Analytics_PerDeviceCounts

Count of sessions per device in the time range.

appcenter_ms.Analytics_PerDeviceCounts({
  "start": "",
  "interval": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- interval required string: Size of interval in ISO 8601 duration format. (PnYnMnDTnHnMnS|PnW|PT). The valid durations are 1 day (P1D), 1 week (P1W), and 30 days (P30D).
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- average_sessions_per_user number: Average seesion per user.
- previous_average_sessions_per_user number: Previous average session per user.
- previous_total_count integer: Previous total count.
- sessions_per_user array: The session count for each interval per device.
  - items object
    - count number: Count.
    - datetime string: The ISO 8601 datetime.
- total_count integer: Total session per device count.

Analytics_Versions

Count of active versions in the time range ordered by version.

appcenter_ms.Analytics_Versions({
  "start": "",
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- start required string: Start date time in data in ISO 8601 date time format.
- end string: Last date time in data in ISO 8601 date time format.
- $top integer: The maximum number of results to return. (0 will fetch all results)
- versions array
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object
- total integer: The total count of versions.
- versions array: List of version count.
  - items object
    - count integer: Version count.
    - previous_count integer: The count of previous time range of the version.
    - version string: Version.

appApiTokens_list

Returns App API tokens for the app

appcenter_ms.appApiTokens_list({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output array
- items object
  - created_at required string: The creation time
  - description string: The description of the token
  - id required string: The unique id (UUID) of the api token
  - scope array: The scope for this token.
    - items string (values: all, viewer)

appApiTokens_new

Creates a new App API token

appcenter_ms.appApiTokens_new({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application
- description object
  - description string: The description of the token
  - scope array: The scope for this token.
    - items string (values: all, viewer)

Output

output object
- api_token required string: The api token generated will not be accessible again
- created_at required string: The creation time
- description string: The description of the token
- id required string: The unique id (UUID) of the api token
- scope array: The scope for this token.
  - items string (values: all, viewer)

appApiTokens_delete

Delete the App Api Token object with the specific ID

appcenter_ms.appApiTokens_delete({
  "owner_name": "",
  "app_name": "",
  "api_token_id": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application
- api_token_id required string: The unique ID (UUID) of the api token

Output

Output schema unknown

appleMapping_delete

Delete mapping of apple app to an existing app in apple store.

appcenter_ms.appleMapping_delete({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- body string
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

Output schema unknown

appleMapping_get

Get mapping of apple app to an existing app in apple store.

appcenter_ms.appleMapping_get({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: Apple Mapping Request Type
- app_id string: ID of the apple application in Mobile Center
- apple_id string: ID of the apple application in apple store
- service_connection_id string: Id for the shared service connection. In case of Apple AppStore, this connection will be used to create and connect to the Apple AppStore in Mobile Center.
- team_identifier string: ID of the Team associated with the app in apple store

appleMapping_create

Create a mapping for an existing app in apple store for the specified application.

appcenter_ms.appleMapping_create({
  "body": null,
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- body required object: Apple Mapping Request Type
  - apple_id string: ID of the apple application in apple store, takes precedence over bundle_identifier when both are provided
  - bundle_identifier string: Bundle Identifier of the apple package
  - service_connection_id required string: Id for the shared service connection. In case of Apple AppStore, this connection will be used to create and connect to the Apple AppStore in Mobile Center.
  - team_identifier required string: ID of the Team associated with the app in apple store
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output object: Apple Mapping Request Type
- app_id string: ID of the apple application in Mobile Center
- apple_id string: ID of the apple application in apple store
- service_connection_id string: Id for the shared service connection. In case of Apple AppStore, this connection will be used to create and connect to the Apple AppStore in Mobile Center.
- team_identifier string: ID of the Team associated with the app in apple store

appleMapping_TestFlightGroups

Fetch all apple test flight groups

appcenter_ms.appleMapping_TestFlightGroups({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output array
- items object: Apple Test Flight Groups Response Type
  - appleId number: apple id of the group.
  - id string: id of the group.
  - name string: name of the group.
  - providerId number: provider id of the group.

apps_deleteAvatar

Deletes the uploaded app avatar

appcenter_ms.apps_deleteAvatar({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output
- description string: The description of the app
- display_name required string: The display name of the app
- icon_source string: The string representation of the source of the app's icon
- icon_url string: The string representation of the URL pointing to the app's icon
- id required string: The unique ID (UUID) of the app
- name required string: The name of the app used in URLs
- os required string (values: Android, iOS, macOS, Tizen, tvOS, Windows, Linux, Custom): The OS the app will be running on
- owner required object: The information about the app's owner
  - avatar_url string: The avatar URL of the owner
  - display_name required string: The owner's display name
  - email string: The owner's email address
  - id required string: The unique id (UUID) of the owner
  - name required string: The unique name that used to identify the owner
  - type required string (values: org, user): The owner type. Can either be 'org' or 'user'
- release_type string: A one-word descriptive release-type value that starts with a capital letter but is otherwise lowercase
- app_secret string: A unique and secret key used to identify the app in communication with the ingestion endpoint for crash reporting and analytics
- azure_subscription object
  - is_billable boolean: If the subscription can be used for billing
  - is_billing boolean: If the subscription is used for billing
  - is_microsoft_internal boolean: If the subscription is internal Microsoft subscription
  - subscription_id required string: The azure subscription id
  - subscription_name required string: The name of the azure subscription
  - tenant_id required string: The tenant id of the azure subscription belongs to
- created_at string: The created date of this app
- member_permissions array: The permissions of the calling user
  - items string (values: manager, developer, viewer, tester)
- origin string (values: appcenter, hockeyapp, codepush): The creation origin of this app
- platform string (values: Java, Objective-C-Swift, UWP, Cordova, React-Native, Unity, Electron, Xamarin, WPF, WinForms, Unknown, Custom): The platform of the app
- updated_at string: The last updated date of this app

apps_updateAvatar

Sets the app avatar

appcenter_ms.apps_updateAvatar({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application
- avatar string, object: The image for an app avatar to upload.
  - content string
  - encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
  - contentType string
  - filename string

Output

output
- description string: The description of the app
- display_name required string: The display name of the app
- icon_source string: The string representation of the source of the app's icon
- icon_url string: The string representation of the URL pointing to the app's icon
- id required string: The unique ID (UUID) of the app
- name required string: The name of the app used in URLs
- os required string (values: Android, iOS, macOS, Tizen, tvOS, Windows, Linux, Custom): The OS the app will be running on
- owner required object: The information about the app's owner
  - avatar_url string: The avatar URL of the owner
  - display_name required string: The owner's display name
  - email string: The owner's email address
  - id required string: The unique id (UUID) of the owner
  - name required string: The unique name that used to identify the owner
  - type required string (values: org, user): The owner type. Can either be 'org' or 'user'
- release_type string: A one-word descriptive release-type value that starts with a capital letter but is otherwise lowercase
- app_secret string: A unique and secret key used to identify the app in communication with the ingestion endpoint for crash reporting and analytics
- azure_subscription object
  - is_billable boolean: If the subscription can be used for billing
  - is_billing boolean: If the subscription is used for billing
  - is_microsoft_internal boolean: If the subscription is internal Microsoft subscription
  - subscription_id required string: The azure subscription id
  - subscription_name required string: The name of the azure subscription
  - tenant_id required string: The tenant id of the azure subscription belongs to
- created_at string: The created date of this app
- member_permissions array: The permissions of the calling user
  - items string (values: manager, developer, viewer, tester)
- origin string (values: appcenter, hockeyapp, codepush): The creation origin of this app
- platform string (values: Java, Objective-C-Swift, UWP, Cordova, React-Native, Unity, Electron, Xamarin, WPF, WinForms, Unknown, Custom): The platform of the app
- updated_at string: The last updated date of this app

azureSubscription_listForApp

Returns a list of azure subscriptions for the app

appcenter_ms.azureSubscription_listForApp({
  "owner_name": "",
  "app_name": ""
}, context)

Input

input object
- owner_name required string: The name of the owner
- app_name required string: The name of the application

Output

output array
- items object
  - is_billable boolean: If the subscription can be used for billing
  - is_billing boolean: If the subscription is used for billing
  - is_microsoft_internal boolean: If the subscription is internal Microsoft subscription
  - subscription_id required string: The azure subscription id
  - subscription_name required string: The name of the azure subscription
  - tenant_id required string: The tenant id of the azure subsc

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@datafire/appcenter_ms

Installation and Usage

Description

Actions

test_gdprExportAccounts

Input

Output

test_gdprExportAccount

Input

Output

test_gdprExportFeatureFlag

Input

Output

organizations_listAdministered

Input

Output

userApiTokens_list

Input

Output

userApiTokens_new

Input

Output

userApiTokens_delete

Input

Output

apps_list

Input

Output

apps_create

Input

Output

apps_delete

Input

Output

apps_get

Input

Output

apps_update

Input

Output

Analytics_DeviceCounts

Input

Output

Analytics_ListAudiences

Input

Output

Analytics_TestAudience

Input

Output

Analytics_ListCustomProperties

Input

Output

Analytics_ListDeviceProperties

Input

Output

Analytics_ListDevicePropertyValues

Input

Output

Analytics_DeleteAudience

Input

Output

Analytics_GetAudience

Input

Output

Analytics_AudienceNameExists

Input

Output

Analytics_CreateOrUpdateAudience

Input

Output

Analytics_CrashCounts

Input

Output

Analytics_CrashGroupsTotals