Available Features - Get Available Feature By Name

Service:

Power BI REST APIs

API Version:

v1.0

Returns the specified available feature for the user by name.

This API call doesn't require any scopes.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

GET https://api.powerbi.com/v1.0/myorg/availableFeatures(featureName='{featureName}')

URI Parameters

Name	In	Required	Type	Description
featureName	path	True	string	The feature name

Responses

Name	Type	Description
200 OK	AvailableFeature	OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/availableFeatures(featureName='embedTrial')

Sample response

Status code:

200

{
  "name": "embedTrial",
  "state": "Enabled",
  "extendedState": "Enabled",
  "additionalInfo": {
    "usage": 65
  }
}

Definitions

Name	Description
AdditionalFeatureInfo	Additional feature information
AvailableFeature	A Power BI available feature
FeatureExtendedState	The feature extended state
FeatureState	The feature state

AdditionalFeatureInfo

Additional feature information

Name	Type	Description
Usage	integer	Workspaces that aren't assigned to a capacity get a limited amount of embed tokens, to allow experimenting with the APIs. The Usage value represents the percentage of embed tokens that have been consumed. The Usage value only applies to the embed trial feature. For more information, see Development testing.

AvailableFeature

A Power BI available feature

Name	Type	Description
additionalInfo	AdditionalFeatureInfo	Additional feature information
extendedState	FeatureExtendedState	The feature extended state
name	string	The feature name
state	FeatureState	The feature state

FeatureExtendedState

The feature extended state

Name	Type	Description
DisabledByAdmin	string
Enabled	string
UserNotLicensed	string

FeatureState

The feature state

Name	Type	Description
Disabled	string
Enabled	string