Microsoft Exchange Metrics REST Connector
Intro
Microsoft Exchange Server is a mail server or messaging platform which works as a centralized hub with mailboxes for storing users' mail. Use this connector to view information about user details, email activity, and more. To learn more about Microsoft Exchange Server, visit their page (https://docs.microsoft.com/en-us/exc...xchserver-2019).
To use this connector, you must first create a Microsoft Azure Web App and set the necessary permissions. This is discussed in the "Prerequisites" section below.
You connect to your Microsoft Exchange Metrics REST account in the Data Center. This topic discusses the fields and menus that are specific to the Microsoft Exchange Metrics REST connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.
Prerequisites
To connect to your Microsoft Exchange Metrics account and create a DataSet, you must have the following:
-
A customer client ID and client secret obtained from your Microsoft Azure Web App
-
Microsoft account credentials
Configuring Your Azure App
To create a connection with your Microsoft Exchange Metrics account, you must first create a Microsoft Azure Web App to obtain the necessary client ID and secret.
To configure an Azure App:
-
Login into Azure Portal.
-
Select Azure Active Directory > App Registrations > New Registration.
3. Fill out the registration form as follows:
-
Name: Enter name for your application.
-
Supported account types: Select an option to specify who can use this application or access this API.
-
Redirect URI: Add and save the following URI:
https
://oauth.domo.com/api/data/v1/oauth/providers/microsoft-exchange-metrics-rest/exchange
. The authentication response is sent to this URI after successfully authenticating the user. Providing the URI at this stage is optional and it can be changed later, but a value is required for most of the authentication scenarios.
4. Click Register. An overview of your registered App will appear.
5. The Application ID that appears here is the Client ID you will enter in the Credentials pane in Domo.
6. Click API Permissions >> +Add a permission.
7. Request API permissions section appears. Select Microsoft Graph.
8. Click on Delegated permissions, and add the delegated permissions for your app from the permissions list.
9. Similarly, click on Application permissions, and add the application permissions for your app from the permissions list.
10. Click on Certificates and secrets. Certificates can be used as secrets to prove the application’s identity when requesting a token. Also, can be referred to as public keys. Click Upload certificate to upload a new certificate for your App.
11. Click +New client secret.
12. Specify the client secret description and the expiry period for your client secret, and click Add.
13. Copy the value and paste it into the Client Secret field in the Connector credentials section in Domo.
Assigning a Reports Reader Role for a User in Office 365:
1. In the Admin Center, click Users > Active users in the expanded menu.
2. Select the user(s) you would like to assign the role to.
3. In the expanded view on the left-hand side of the screen, find the Roles section, and click Edit.
4. Select Customized administrator and from the options below, choose Reports reader and click Save.
5. Once you click Save, you will see the confirmation saying "The user's role have been successfully updated."
6. Click Close.
Connecting to Your Microsoft Exchange Metrics Account
This section enumerates the options in the Credentials and Details panes in the Microsoft Exchange Metrics Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.
Credentials Pane
This pane contains fields for entering credentials to connect to your Microsoft Exchange Metrics account. The following table describes what is needed for each field:
Field |
Description |
---|---|
Client ID | Enter your Microsoft Exchange Metrics client ID. |
Client Secret | Enter your Microsoft Exchange Metrics client secret. |
After you enter a client ID and client secret, you are taken to Microsoft's OAuth page where you are requested to enter your email, phone number, or Skype name associated with your Microsoft account. Once you have connected, you can use the same account any time you go to create a new Microsoft Exchange Metrics DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.
Details Pane
This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.
Menu |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Report |
Select the Microsoft Exchange Metrics report you want to run. The following reports are available:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Parameter Type |
Select whether you want to pull data for a selected period of days (Period) or for a specified date or date range (Date). |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Period |
Select the number of days you want to retrieve data for. ("D" refers to days. So D7 would pull data for 7 days, D30 would pull data for 30 days, etc.) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Duration |
Select whether you want to pull data for a specific date or a date range. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Report Date |
Select whether the report data is for a specific date or for a relative number of days back from today. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Select Specific Date |
Select the date for the report. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Days Back |
Enter the number of past days that should appear in the report. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Start Date |
Specify whether the first date in your date range is a specific or relative date. You select the last date in your range in End Date. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
End Date |
Specify whether the second date in your date range is a specific or relative date. You select the first date in your range in Start Date. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Select Specific Start Date |
Select the first date in your date range. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Select Specific End Date |
Select the second date in your date range. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Days Back to Start From |
Enter the number of the farthest day back that should be represented in the report. Combine with Days Back to End At to create a range of represented days. For example, if you entered 10 for Days Back to Start From and 5 for Days Back to End At, the report would contain data for 10 days ago up until 5 days ago. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Days Back to End At |
Enter the number of the most recent day back that should be represented in the report. Combine with Days Back to Start From to create a range of represented days. For example, if you entered 10 for Days Back to Start From and 5 for Days Back to End At, the report would contain data for 10 days ago up until 5 days ago. |
Other Panes
For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.