Licensing Reports - Generate Licensing Report

Generate Licensing Report.
Starts generating a Copilot Studio licensing report for your tenant over the requested date range. Generation runs asynchronously; poll the URL in the Location header for status. Requires the Global, Dynamics 365, or Power Platform administrator role.

POST https://api.powerplatform.com/copilotstudio/licensing/reports/{ReportName}?api-version=2024-10-01

URI Parameters

Name In Required Type Description
ReportName
path True

string

The name of the report to generate.

api-version
query True

string

The API version.

Request Body

Name Required Type Description
endDate True

string (date)

The inclusive UTC end date of the report range. Must be on or after the start date.

startDate True

string (date)

The inclusive UTC start date of the report range.

granularity

CopilotStudioLicensingReportGranularity

The granularity of a licensing report. Daily returns one row per day in the date range, and Summary returns a single summarized row for the whole range.

Responses

Name Type Description
202 Accepted

Accepted. Report generation started.

Headers

  • Location: string
  • Retry-After: string
400 Bad Request

Bad request. The request body or a date is missing or invalid, or the end date is before the start date.

401 Unauthorized

Unauthorized. A valid access token is required.

403 Forbidden

Forbidden. The caller must be a Global, Dynamics 365, or Power Platform administrator of the tenant.

404 Not Found

Not found. The report isn't supported or licensing reports aren't available for the tenant.

Security

oauth2

Microsoft Entra ID OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com

Scopes

Name Description
.default .default

Definitions

Name Description
CopilotStudioLicensingReportGranularity

The granularity of a licensing report. Daily returns one row per day in the date range, and Summary returns a single summarized row for the whole range.

CopilotStudioLicensingReportRequest

The request body for generating a licensing report.

CopilotStudioLicensingReportGranularity

The granularity of a licensing report. Daily returns one row per day in the date range, and Summary returns a single summarized row for the whole range.

Value Description
Daily
Summary

CopilotStudioLicensingReportRequest

The request body for generating a licensing report.

Name Type Default value Description
endDate

string (date)

The inclusive UTC end date of the report range. Must be on or after the start date.

granularity

CopilotStudioLicensingReportGranularity

Daily

The granularity of a licensing report. Daily returns one row per day in the date range, and Summary returns a single summarized row for the whole range.

startDate

string (date)

The inclusive UTC start date of the report range.