Skip to content

Files

Latest commit

dannyeversdannyevers
68709-fix-tables
May 10, 2022
3555ce2 · May 10, 2022

History

History
95 lines (76 loc) · 2.75 KB

analytics-api-delete-report.md

File metadata and controls

95 lines (76 loc) · 2.75 KB
title description ms.service ms.subservice ms.topic author ms.author ms.reviewer ms.date
Delete report API
Use this API to delete all the report and report execution records for commercial marketplace analytics reports.
marketplace
partnercenter-marketplace-publisher
article
smannepalle
smannepalle
sroy
03/14/2022

Delete report API

On execution, this API deletes all of the report and report execution records.

Request syntax

Method Request URI
DELETE https://api.partnercenter.microsoft.com/insights/v1/cmp/ScheduledReport/{Report ID}

Request header

Header Type Description
Authorization string Required. The Azure AD access token in the form Bearer <token>
Content Type string Application/JSON

Path parameter

None

Query parameter

Parameter name Required string Description
reportId Yes string ID of the report that’s being modified

Glossary

None

Response

The response payload is structured as follows:

Response code: 200, 400, 401, 403, 404, 500

Response payload:

{
  "Value": [
    {
      "ReportId": "string",
      "ReportName": "string",
      "Description": "string",
      "QueryId": "string",
      "Query": "string",
      "User": "string",
      "CreatedTime": "string",
      "ModifiedTime": "string",
      "StartTime": "string",
      "ReportStatus": "string",
      "RecurrenceInterval": 0,
      "RecurrenceCount": 0,
      "CallbackUrl": "string",
      "Format": "string"
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

Glossary

Parameter Description
ReportId Unique UUID of the deleted report
ReportName Name given to the report during creation
Description Description given during creation of the report
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
StartTime Time the report execution will begin. The time format is yyyy-MM-ddTHH:mm:ssZ
ReportStatus Status of 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
Format Format of the report files