Hämta API för rapportfrågor för den kommersiella marknadsplatsen

API:et Hämta rapportfrågor hämtar alla frågor som är tillgängliga för användning i rapporter. Den hämtar alla system- och användardefinierade frågor som standard.

Syntax för begäran

Metod	Begärande-URI
GET	https://api.partnercenter.microsoft.com/insights/v1.1/cmp/ScheduledQueries?queryId={QueryID}&queryName={QueryName}&includeSystemQueries={include_system_queries}&includeOnlySystemQueries={include_only_system_queries}

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	Typ	Obligatoriskt	Beskrivning
queryId	sträng	Nej	Filtrera för att få information om endast frågor med det ID som anges i argumentet
queryName	sträng	Nej	Filtrera för att få information om endast frågor med det namn som anges i argumentet
IncludeSystemQueries	boolean	Nej	Inkludera fördefinierade systemfrågor i svaret. Standardvärdet är sant.
IncludeOnlySystemQueries	boolean	Nej	Inkludera endast systemfrågor i svaret. Standardvärdet är Falskt

Begär nyttolast

Ingen

Ordlista

Ingen

Response

Svarsnyttolasten är strukturerad på följande sätt:

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

Svarsnyttolast:

{
  "Value": [
    {
      "QueryId": "string",
      "Name": "string",
      "Description": "string",
      "Query": "string",
      "Type": "string",
      "User": "string",
      "CreatedTime": "string",
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0
}

Ordlista

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

Parameter	Beskrivning
QueryId	Unikt UUID för frågan
Name	Namn som angavs för frågan när frågan skapades
Description	Beskrivning som gavs när frågan skapades
Query	Rapportfrågesträng
Type	Ange till userDefined för användarskapade frågor och system för fördefinierade systemfrågor
User	Användar-ID som skapade frågan
CreatedTime	Tidpunkt då frågan skapades
TotalCount	Antal datauppsättningar i matrisen Värde
StatusCode	Resultatkod. Möjliga värden är 200, 400, 401, 403, 500