Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This API gets all the reports that have been scheduled.
Request syntax
| Method | Request URI |
|---|---|
| GET | https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID} |
Request header
| Header | Type | Description |
|---|---|---|
| Authorization | string | Required. The Microsoft Entra access token in the form Bearer <token> |
| Content-Type | string | Application/JSON |
Path parameter
None
Query parameter
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| reportId | string | No | Filter to get details of only reports with the reportId given in this argument |
| reportName | string | No | Filter to get details of only reports with the reportName given in this argument |
| queryId | string | No | Filter to get details of only reports with the queryId given in this argument |
Request payload
None
Request glossary
None
Response
The response payload is structured as follows:
Response code: 200, 400, 401, 403, 404, 500
Response payload example:
{
"Value": [
{
"ReportId": "string",
"ReportName": "string",
"Description": "string",
"QueryId": "string",
"Query": "string",
"User": "string",
"CreatedTime": "string",
"ModifiedTime": "string",
"executeNow": true,
"StartTime": "string",
"ReportStatus": "string",
"RecurrenceInterval": 0,
" RecurrenceCount": 0,
"CallbackUrl": "string",
"CallbackMethod": null,
"Format": "string"
}
],
"TotalCount": 0,
"Message": "string",
"StatusCode": 0
}
Response glossary
This table defines the key elements in the response:
| Parameter | Description |
|---|---|
| ReportId | Unique UUID of the report that was created |
| ReportName | Name given to the report in the request payload |
| Description | Description given when the report was created |
| QueryId | Query ID passed at the time the report was created |
| Query | Query text that will be executed for this report |
| User | User ID used to create the report |
| CreatedTime | Time the report was created. The time format is yyyy-MM-ddTHH:mm:ssZ |
| ModifiedTime | Time the report was last modified. The time format is yyyy-MM-ddTHH:mm:ssZ |
| executeNow | ExecuteNow flag set at the time the report was created |
| StartTime | Time execution will begin. The time format is yyyy-MM-ddTHH:mm:ssZ |
| ReportStatus | Status of the report execution. The possible values are Paused, Active, and Inactive. |
| RecurrenceInterval | Recurrence interval provided during report creation |
| RecurrenceCount | Recurrence count provided during report creation |
| CallbackUrl | Callback URL provided in the request |
| CallbackMethod | Callback method provided in the request |
| Format | Format of the report files |
| TotalCount | Number of datasets in the Value array |
| Message | Status message from the execution of the API |
| StatusCode | Result Code. The possible values are 200, 400, 401, 403, 500 |