Hämta rapport-API för kommersiell marknadsplats

Det här API:et hämtar alla rapporter som har schemalagts.

Syntax för begäran

Metod	Begärande-URI
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledReport?reportId={Report ID}&reportName={Report Name}&queryId={Query ID}

Begärandehuvud

Sidhuvud	Typ	Beskrivning
Auktorisering	sträng	Obligatoriskt. Microsoft Entra-åtkomsttoken i formuläret Bearer <token>
Innehållstyp	sträng	Application/JSON

Sökvägsparameter

Ingen

Frågeparameter

Parameternamn	Krävs	Typ	Beskrivning
reportId	Nej	sträng	Filtrera för att få information om endast rapporter med angivet reportId i det här argumentet. Flera reportId kan anges genom att avgränsa dem med semikolon (;)
reportName	Nej	sträng	Filtrera för att få information om endast rapporter med angivet reportName i det här argumentet
queryId	Nej	boolean	Inkludera fördefinierade systemfrågor i svaret

Ordlista

Ingen

Response

Svarsnyttolasten är strukturerad i JSON-format enligt följande:

Svarskod: 200, 400, 401, 403, 404, 500

Svarsnyttolast:

{
  "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
}

Ordlista

I den här tabellen visas viktiga definitioner av element i svaret.

Parameter	Description
ReportId	Universellt unik identifierare (UUID) för den rapport som du skapade
ReportName	Namn som angavs i nyttolasten för begäran när rapporten skapades
Description	Beskrivning som anges i nyttolasten för begäran när rapporten skapas
QueryId	Fråge-ID som anges i nyttolasten för begäran när rapporten skapas
Query	Frågetext som ska köras för den här rapporten
User	Användar-ID som används för att skapa rapporten
CreatedTime	UTC Tid då rapporten skapades i det här formatet: åååå-MM-ddTHH:mm:ssZ
ModifiedTime	UTC Tid då rapporten senast ändrades i det här formatet: åååå-MM-ddTHH:mm:ssZ
ExecuteNow	ExecuteNow-parametern som anges i nyttolasten för begäran när rapporten skapas
queryStartTime	Frågestarttid som anges i nyttolasten för begäran när rapporten skapas. Detta gäller endast om ExecuteNow är inställt på "True"
queryEndTime	Frågesluttid som anges i nyttolasten för begäran när rapporten skapas. Detta gäller endast om ExecuteNow är inställt på "True"
StartTime	Starttid som anges i nyttolasten för begäran när rapporten skapas
ReportStatus	Status för rapportkörningen. Möjliga värden är Pausade, Aktiva och Inaktiva.
RecurrenceInterval	Upprepningsintervall som anges i nyttolasten för begäran när rapporten skapas
RecurrenceCount	Återstående antal upprepningar för rapporten
CallbackUrl	Motringnings-URL som anges i nyttolasten för begäran när rapporten skapas
CallbackMethod	Motringningsmetod som tillhandahålls i nyttolasten för begäran när rapporten skapas
Format	Format för rapportfilerna som angavs i nyttolasten för begäran när rapporten skapades
EndTime	Sluttid som anges i nyttolasten för begäran när rapporten skapas. Detta gäller endast om ExecuteNow är inställt på "True"
TotalRecurrenceCount	RecurrenceCount som anges i nyttolasten för begäran när rapporten skapas
nextExecutionStartTime	UTC-tidsstämpel när nästa rapportkörning startar
TotalCount	Antal poster i matrisen Värde
StatusCode	Resultatkod. Möjliga värden är 200, 400, 401, 403, 500
message	Statusmeddelande från körningen av API:et