Compartilhar via

Experimentar API de consultas de relatório

  • Artigo

Essa API executa uma instrução de consulta de relatório. A API retorna apenas 100 registros que você como parceiro pode usar para verificar se os dados são os esperados.

Importante

Essa API tem um tempo limite de execução de consulta de 100 segundos. Se você observar que a API está demorando mais de 100 segundos, é muito provável que a consulta esteja sintaticamente correta ou, caso contrário, você receberia um código de erro diferente de 200. A geração de relatório real será aprovada se a sintaxe da consulta estiver correta.

Sintaxe da solicitação

Método URI da solicitação
GET https://api.partnercenter.microsoft.com/insights/v1/mpn/ScheduledQueries/testQueryResult?<exportQuery={querytext}\|queryId={queryId}>

Cabeçalho da solicitação

Cabeçalho Tipo Descrição
Autorização string Obrigatória. O token de acesso do Microsoft Entra no formato Bearer <token>
Tipo de conteúdo string Application/JSON

Parâmetro de caminho

Nenhum

Parâmetro de consulta

Nome do Parâmetro Tipo Obrigatória Descrição
exportQuery string Não Cadeia de caracteres de consulta de relatório que precisa ser executada
queryId string Não Uma ID de consulta existente válida. Mutuamente exclusiva com a cadeia de caracteres de consulta especificada no parâmetro exportQuery
startTime string Não Hora de início da qual queremos os dados. Substitui o intervalo de tempo especificado na consulta
endTime string Não Hora de término até a qual queremos os dados. Substitui o intervalo de tempo especificado na consulta

Payload da solicitação

Nenhum

Solicitar glossário

Nenhum

Resposta

A carga de solicitação é estrutura conforme a seguir:

Código de resposta: 200, 400, 401, 403, 404, 500

Exemplo de conteúdo da resposta:

Top 100 rows of query execution
{
  "Value": [
    {
    }
  ],
  "TotalCount": 0,
  "Message": "string",
  "StatusCode": 0,
}

Glossário de respostas

Esta tabela define os principais elementos na resposta:

Parâmetro Descrição
TotalCount Número de conjuntos de itens na Matriz de valores
Mensagem Mensagem do status da execução da API
StatusCode Código de resultado. Os valores possíveis são 200, 400, 401, 403, 500