Manage your Teams apps using Developer Portal

The Developer Portal for Teams is the primary tool for configuring, distributing, and managing your Microsoft Teams apps. With the Developer Portal, you can collaborate with colleagues on your app, set up runtime environments, and much more.

Screenshot showing the home page of the Developer Portal for Teams.

Note

  • Currently, Developer Portal is not available for Government Community Cloud (GCC), GCC-High, or Department of Defense (DOD) tenants.
  • However, you can use a regular tenant to build an app in the Developer Portal, download the app, and upload the app using Microsoft Graph to a national cloud. For more information, see National cloud deployments.

Register an app

The Developer Portal provides a couple ways to register a Teams app:

  • Register a brand new app
  • Import an existing app package

Note

If you create an app using the Microsoft Teams Toolkit for Visual Studio Code, you can manage that app in the Developer Portal.

Set up an environment

You can configure environments and global variables to help transition your app from your local runtime to production. Global variables are used across all environments.

To set up an environment:

  1. In the Developer Portal, select the app you're working on.
  2. Go to the Environments page and select + Add an environment.
  3. Select + Add a variable to create configuration variables for your environment.

To use variables:

Use the variable names instead of hard-coded values to set your app configurations.

  1. Enter {{ in any field in the Developer Portal. A dropdown with all the variables you've created for the chosen environment along with the global variables appears.
  2. Before downloading your app package (for example, when getting ready to publish to the Teams store), select the environment you want to use. Your app configurations update automatically based on the environment.

Identify app owners

Each app includes an Owners page, where you can share your app registration with colleagues in your org. The Contributor role has the same permissions as the Owner role except the ability to delete an app.

Configure your app's capabilities and other important metadata

A Teams app is a web app. Like all web apps, its source code is typically developed in an IDE or code editor and hosted somewhere in the cloud (like Azure).

To install and render your app in Teams, you must include a set of configurations that Teams recognizes. This has traditionally been done by crafting an app manifest, a JSON file that contains all the metadata Teams needs to display your app content. The Developer Portal abstracts this process and includes new features and tooling to help you be more successful.

Test your app directly in Teams

The Developer Portal provides options for testing and debugging your app:

  • On the Overview page, you can see a snapshot of whether your app's configurations validate against Teams store test cases.
  • The Preview in Teams button lets you launch your app quickly in the Teams client for debugging.

Distribute your app

From the Developer Portal, use the Distribute button to download an app package, publish to your org, or publish to the Teams store.

For more information, see distribute your Teams app.

Analyze your app's usage

In the Developer Portal for Teams, on the Overview page, you can see the total number of active users for your app.

Note

Usage analytics are currently available only for new custom apps published to your org through Developer Portal for Teams (formerly App Studio) or imported into Developer Portal for Teams after April 2022. Usage analytics for all the apps published to the Teams store is available in Partner Center, for more information Teams apps usage report.

Metric Definition
Monthly R30 The default usage metric. It shows the count of unique active users who used your app within that rolling 30 day window in UTC.
Daily It shows you the count of unique active users who used your app in a given day in UTC.

The app usage for a given day is reflected within 24 to 48 hours, and usage data for new apps can take up to three to five days to reflect in the charts.

You can view your app's usage and other insights from the Analytics page. To access the page:

  1. Go to Developer Portal for Teams.
  2. Select Apps from the left pane.
  3. Select the required app from the Apps page.
  4. Select Analytics under the Overview or select View details under the Active Users (Preview) card.

dev-Portal-analytics

As you explore individual metrics on this page, you can use the Filter button to analyze your app's usage from the following filter options:

  • Aggregation type: This filter allows you to group the following metrics by a count of distinct users or a count of distinct tenants or customers.
  • Platform
  • Operating system
  • Area

Filter

After you have selected your desired filters, you can explore the following individual widgets:

Usage by time period

The Usage by time period chart shows you the number of active users or tenants who opened and used your app across different time periods.

Period

Metric Definition
Monthly R30 Each data point represents a given R30 (Rolling 30 day) period.
Monthly R28 Each data point represents a given R28 (Rolling 28 day) period.
Weekly R7 Each data point represents a given R7 (Rolling 7 day) period.
Daily Each data point represents a given R1 (Rolling 1 day) period.

Usage by platform and OS

The Usage by platform and OS chart shows your app's active usage across various endpoints, such as Windows, Mac, iOS, Android, and Web. The same user or tenant can use an app on multiple endpoints. Each data point represents a given R30 (Rolling 30 day) period.

Platform

Usage by retention state

The Usage by retention state chart lets you track four key retention or churn metrics for your app over time.

Retention

Metric Definition
New users or tenants Active users or tenants who are new new and have not used your app.
Returning users or tenants Active users or tenants who used your app during a given R30 (Rolling 30 day) time period and the immediately preceding R30 time period.
Resurrected users or tenants Active users or tenants who used your app one or more times before but not in the immediately preceding R30 time period.
Lapsed users or tenants Active users or tenants who were not seen during a given R30 time period but were seen during the immediately preceding R30 time period.

Usage intensity

The Usage intensity chart shows you key usage intensity metrics for your app.

Intensity

Metric Definition
Median days used per month The median numbers of days in which your app was opened in the last R30 (Rolling 30 day) time period.
% of 5+ Days usage The % of Active Users who opened or used the app more than five days in the last R30 time period.
DAU/MAU The ratio of the average number of unique users or tenants who used your app on each day divided by the Monthly Active Users for the selected R30 time period.

App dashboard

The My App dashboard table shows you the latest R30 (Rolling 30 day) data for each of the metrics under the previous four categories, and the Month over Month change. Use the time picker on the upper left and select the desired date, you can see daily R30 data for the last 75 days and end of month R30 data for up to 12 months.

You can select each of these Metric name to see trends over time.

app

Use tools to create app features

The Developer Portal also includes tools to help you build some key features of Teams apps. Some of these tools include:

  • Scene studio: Design custom Together Mode scenes for Teams meetings.
  • Adaptive Cards editor: Create and preview Adaptive Cards to include with your apps.
  • Microsoft identity platform management: Register your apps with Azure Active Directory to help users sign in and provide access to APIs.

See also

Include a SaaS offer with your Microsoft Teams app