Datasets - Get Refresh History

  • Referência
Service:
Power BI REST APIs
API Version:
v1.0

Retorna o histórico de atualização do conjunto de dados especificado de Meu workspace.

Escopo necessário

Dataset.ReadWrite.All ou Dataset.Read.All

Limitações

O histórico de atualização do OneDrive não é retornado.

Há sempre entre 20 a 60 entradas de histórico de atualização disponíveis para cada conjunto de dados, dependendo do número de atualizações nos últimos 3 dias.
Os 60 mais recentes são mantidos se todos tiverem menos de 3 dias. Entradas com mais de 3 dias são excluídas quando há mais de 20 entradas. 

GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/refreshes?$top={$top}

Parâmetros de URI

Nome Em Obrigatório Tipo Description
datasetId
 path True

string

A ID do conjunto de dados
$top
 query

integer

O número solicitado de entradas no histórico de atualização. Se não for fornecido, o padrão será as últimas 60 entradas disponíveis.

Respostas

Nome Tipo Description
200 OK

Refreshes

OK

Exemplos

Completed refresh example
Failed refresh example
In-progress refresh example

Completed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-13T09:31:43.153Z",
      "status": "Completed",
      "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1",
      "refreshAttempts": [
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:25:43.153Z",
          "endTime": "2017-06-13T09:31:40.153Z",
          "type": "Data"
        },
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:31:40.156Z",
          "endTime": "2017-06-13T09:31:43.153Z",
          "type": "Query"
        }
      ]
    }
  ]
}

Failed refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-13T09:31:43.153Z",
      "serviceExceptionJson": "{\"errorCode\":\"ModelRefreshFailed_CredentialsNotSpecified\"}",
      "status": "Failed",
      "requestId": "11bf290a-346b-48b7-8973-c5df149337ff",
      "refreshAttempts": [
        {
          "attemptId": 1,
          "startTime": "2017-06-13T09:25:43.153Z",
          "endTime": "2017-06-13T09:31:43.153Z",
          "serviceExceptionJson": "{\"errorCode\":\"ModelRefreshFailed_CredentialsNotSpecified\"}",
          "type": "Data"
        }
      ]
    }
  ]
}

In-progress refresh example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/refreshes?$top=1

Sample Response

Status code:
200 
{
  "value": [
    {
      "refreshType": "ViaApi",
      "startTime": "2017-06-13T09:25:43.153Z",
      "status": "Unknown",
      "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
    }
  ]
}

Definições

Nome Description
Refresh

Uma entrada de histórico de atualização do Power BI
RefreshAttempt

O Power BI faz automaticamente várias tentativas de atualizar um conjunto de dados se ele apresentar uma falha de atualização. Esse objeto contém informações sobre cada tentativa de atualização.
RefreshAttemptType

O tipo de tentativa de atualização.
Refreshes

O wrapper de resposta OData para uma lista de histórico de atualização do Power BI
RefreshType

O tipo de solicitação de atualização

Refresh

Uma entrada de histórico de atualização do Power BI

Nome Tipo Description
endTime

string

A data e a hora de término da atualização (pode estar vazia se uma atualização estiver em andamento)
refreshAttempts

RefreshAttempt[]

A lista de tentativas de atualização.
refreshType

RefreshType

O tipo de solicitação de atualização
requestId

string

O identificador da solicitação de atualização. Forneça esse identificador em todas as solicitações de serviço.
serviceExceptionJson

string

Código de erro de falha no formato JSON (vazio se nenhum erro)
startTime

string

A data e a hora de início da atualização
status

string

  • Unknown se o estado de conclusão for desconhecido ou se uma atualização estiver em andamento.
  • Completed para uma atualização concluída com êxito.
  • Failed para uma atualização malsucedida (serviceExceptionJson conterá o código de erro).
  • Disabled se a atualização estiver desabilitada por uma atualização seletiva.

RefreshAttempt

O Power BI faz automaticamente várias tentativas de atualizar um conjunto de dados se ele apresentar uma falha de atualização. Esse objeto contém informações sobre cada tentativa de atualização.

Nome Tipo Description
attemptId

integer

O índice da tentativa de atualização.
endTime

string

A data e a hora de término da tentativa de atualização. O valor será nulo se a tentativa de atualização estiver em andamento.
serviceExceptionJson

string

Código de erro de falha no formato JSON. Nulo se não houver erro.
startTime

string

A data e a hora de início da tentativa de atualização.
type

RefreshAttemptType

O tipo de tentativa de atualização.

RefreshAttemptType

O tipo de tentativa de atualização.

Nome Tipo Description
Data

string

A tentativa de atualização de carregar dados no conjunto de dados.
Query

string

A tentativa de atualizar caches de consulta premium e dashboard blocos.u

Refreshes

O wrapper de resposta OData para uma lista de histórico de atualização do Power BI

Nome Tipo Description
odata.context

string

value

Refresh[]

A lista de histórico de atualização

RefreshType

O tipo de solicitação de atualização

Nome Tipo Description
OnDemand

string

A atualização foi disparada interativamente por meio do portal do Power BI
OnDemandTraining

string

A atualização foi disparada interativamente por meio do portal do Power BI com treinamento automático de agregações
Scheduled

string

A atualização foi disparada por uma configuração de agendamento de atualização do conjunto de dados
ViaApi

string

A atualização foi disparada por uma chamada à API
ViaEnhancedApi

string

A atualização foi disparada por uma chamada avançada à API REST de atualização
ViaXmlaEndpoint

string

A atualização foi disparada por meio do ponto de extremidade XMLA público do Power BI