Skip to content

Files

Latest commit

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

History

History
94 lines (76 loc) · 2.81 KB

analytics-api-pause-report-executions.md

File metadata and controls

94 lines (76 loc) · 2.81 KB
title description ms.service ms.subservice ms.topic author ms.author ms.reviewer ms.date
Pause report executions API
Use this API to pause the scheduled execution of a commercial marketplace analytics report.
marketplace
partnercenter-marketplace-publisher
article
smannepalle
smannepalle
sroy
03/14/2022

Pause report executions API

This API, on execution, pauses the scheduled execution of reports.

Request syntax

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

Request header

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

Path parameter

None

Query parameter

Parameter name Required Type Description
reportId Yes string ID of the report being modified

Glossary

None

Response

The response payload is structured as follows in JSON format:

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 Universally unique identifier (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 for creation of 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 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
Format Format of the report files