Endpoint Reports (for PowerBI)

TABLE OF CONTENTS

• What are Endpoint Reports
  • Security
  • Testing a Report
• Reports
  • Datamining Report
    • Supported Header Groups
    • Example
  • Projection Report
    • Supported Header Groups
    • Report Headers
    • Example
  • Blueprint Readiness Report
    • Supported Header Groups
    • Report Headers
    • Example
  • History Report
    • Supported Header Groups
    • Report Headers
    • Example
• Header Groups
  • DataSource Headers
  • Standard Datamining Tier Headers
  • Readiness/What-If Tier Headers
  • Auth Headers

What are Endpoint Reports

Rnd points reports allow 3rd party tools such as PowerBI, PowerShell, Postman etc to read data directly from a REST API endpoint. 

Security

Endpoint reports require two leaves of security to be enabled. Each report type has its security options. 

1. Admin -> Project Settings -> Project Polices -> Report Endpoints
   1. There is one rule per endpoint report type
2. Create a Role that allows the User to run an Endpoint report and add them to it. 
   1. There is one permission per endpoint report type

When reading from an Endpoint Report a User/Pass or auth Token needs to be supplied in the headers

Testing a Report

We suggest using Postman to build and test the report before creating it using PowerBI. The examples and screenshots in the article are from Postman.

Reports

Datamining Report

Url: HTTP://your.managementstudio/{projectId}/p/report/Datamining /{dmrId}/{headers}/{format}

Url: HTTP://your.managementstudio/1/p/report/Datamining/0/prefixed/json

• ProjectId: Id of Project to read data from
• DmrId: Reserved for future use, use 0
• Header: How to label the column headers on the report
  • PrefixedName: Applications_AppVendor
  • InternalName:  AppVendor
  • DisplayName: Vendor 
• Format: What format to return the report as (Json, csv, Html)

Supported Header Groups

• DataSource Headers
• Standard Datamining Tier Headers
• Readiness Tier Headers
• Auth Headers

When adding tiers, name each tier with the numbers 1-5, with the primary tier being Tier1.

Example  - 2 Tier DMR with Apps and Users
Datamining-Tier1-Module = Applications
Datamining-Tier1-Fields = AppId, AppVendor, AppName, AppVersion

Datamining-Tier2-Module = UserMigrations

Datamining-Tier1-Fields  = SamAccount, Domain, Email

Example

Projection Report

Url: HTTP://your.managementstudio/{projectId}/p/report/Projection /{module}/{report}/{format}

Url: HTTP://your.managementstudio/1/p/report/Projection/Applications/0/json

• ProjectId: Id of Project to read data from
• Module: Name of the module to run the report against e.g. UserMigrations
• Report: Reserved for future use, use 0
• Format: What format to return the report as (Json, csv, Html)

Supported Header Groups

• DataSource Headers
• Readiness Tier Headers
• Auth Headers

Report Headers

Example

Blueprint Readiness Report

Url: HTTP://your.managementstudio/{projectId}/p/report/BlueprintReadiness/{module}/{report}/{format}

Url: HTTP://your.managementstudio/1/p/report/BlueprintReadiness/UserMigrations/default/json

• ProjectId: Id of Project to read data from
• Module: Name of the module to run the report against e.g. UserMigrations
• Report: Which history report to run
  • Default  - Report only on selected items
  • OneLevel - Expand Blueprint Folders to one Level 
  • AllLevels - Expand Blueprint Folders to all levels
• Format: What format to return the report as (Json, csv, Html)

Supported Header Groups

• Readiness Tier Headers
• Auth Headers

Report Headers

Example

History Report

Url: HTTP://your.managementstudio/{projectId}/p/report/history/{module}/{report}/{format}

Url: HTTP://your.managementstudio/1/p/report/history/applications/details/json

• ProjectId: Id of Project to read data from
• Module: Name of the module to run the report against e.g. UserMigrations
• Report: Which history report to run
  • Details
  • CustomForm
  • Surveys
  • TestSignedOffs
  • Links
• Format: What format to return the report as (Json, csv, Html)

Supported Header Groups

• DataSource Headers
• Auth Headers

Report Headers

Example

Header Groups

DataSource Headers

Standard Datamining Tier Headers

Readiness/What-If Tier Headers

Then using What-If in Projection/Blueprint Readiness Reports use the prefix 'WhatIf-'. When running Datamining Reports use 'Datamining-ReadyX' where X is the tier number. 

Auth Headers