As APIs de administração do Power BI são fundamentais para ajudar nossos administradores em muitas tarefas administrativas, mas também são essenciais para examinar atividades e padrões de uso que garantem a governança e atendem aos requisitos de conformidade ou auditoria.

Há alguns meses, a Microsoft criou uma série de APIs para fornecer informações sobre quem tem acesso aos ativos do Power BI (consulte as entradas de blog anteriores aqui e aqui) e adicionou novas APIs para fornecer um inventário de relatórios e painéis que são entregues por meio de assinaturas de e-mail, compartilhados com todo o locatário ou que são publicadas na web.

Novas APIs para recuperar assinaturas de e-mail de relatório ou painel

A assinatura de e-mail para relatórios e painéis é um recurso popular que facilita a atualização sobre os dados mais importantes.

Percorrer a interface do usuário é complicado, e analisar os logs de auditoria pode demorar até 90 dias, portanto, os clientes solicitam uma API para recuperar informações sobre assinaturas de e-mail existentes para que possam realizar o inventário de acesso a relatórios e avaliar o risco de compartilhamento excessivo de maneira mais eficiente.

E como essas APIs pode ajudar você como administrador de serviço do Power BI? Às vezes, relatórios ou assinaturas de painéis não saem conforme o planejado devido a atualizações posteriores ou problemas de atualização de dados. Mas, ao usar essas APIs, você poderá recuperar uma lista de assinaturas de relatórios afetados e notificar os assinantes.

3 APIs separadas fornecem aos administradores uma lista de assinaturas de um determinado relatório, painel ou usuário do Power BI.

Abaixo está um exemplo da API para recuperar as assinaturas de um relatório:

GET https://api.powerbi.com/v1.0/myorg/admin/reports/{reportID}/subscriptions

E o resultado fica assim:

{
  "value": [
    {
      "id": "<redacted>",
      "title": "2111080010000830_ASQL ",
      "artifactId": "<redacted>",
      "artifactDisplayName": "2111080010000830_ASQL",
      "artifactType": "PaginatedReport",
      "isEnabled": true,
      "frequency": "Monthly",
      "startDate": "11/16/2021 12:00:00 AM",
      "endDate": "11/16/2022 12:00:00 AM",
      "linkToContent": true,
      "previewImage": false,
      "owner": {
        "emailAddress": "<redacted>",
        "displayName": "Admin User",
        "identifier": "<redacted>",
        "graphId": "<redacted>",
        "principalType": "User"
      },
      "users": [
        {
          "emailAddress": "<redacted>",
          "displayName": "Admin User",
          "identifier": "<redacted>",
          "graphId": "<redacted>",
          "principalType": "User",
          "userType": "Member"
        },
        {
          "emailAddress": "<redacted>",
          "principalType": "User"
        }
      ]
    }
  ]
}

Algumas notas adicionais:

1. Para obter assinaturas por API de relatório, existe o suporte para relatório do Power BI e relatório paginado;
2. A API get de assinaturas por usuário, o UPN e o ID do gráfico são compatíveis como parâmetros de entrada;
3. Para obter assinaturas por API de usuário, uma única resposta contém resultados apenas para um único tipo de artefato. Se houver mais de um tipo de artefato na resposta, haverá um token de continuação e uma URL para você fazer chamadas adicionais. Só pode haver 3 tipos de artefatos que dão suporte a assinaturas de e-mail: relatório do Power BI, relatório paginado do Power BI e painel do Power BI;
4. Assinantes externos ou usuários convidados do AAD também são suportados. Na matriz “users”, os usuários convidados do AAD serão marcados como “Guest” no parâmetro userType

Novas APIs para recuperar relatórios amplamente compartilhados;

Os relatórios do Power BI podem ser compartilhados amplamente com toda a organização ou publicamente por meio de publicações na web.

Como essas APIs ajudam você como administrador do Power BI? Talvez você tenha sido solicitado por sua equipe de TI para acompanhar os relatórios do Power BI que são compartilhados com toda a empresa ou têm um código de inserção ativo que permite o acesso público. Essas novas APIs facilitam a compilação dessas informações.

Por exemplo, para obter uma lista de todos os relatórios que foram compartilhados com todos na empresa, basta ligar para:

GET https://api.powerbi.com/v1.0/myorg/admin/widelySharedArtifacts/linksSharedToWholeOrganization

E o resultado fica assim:

{
  "ArtifactAccessEntities": [
    {
      "artifactId": "<redacted>",
      "displayName": "Human Resources Sample",
      "artifactType": "Report",
      "accessRight": "ReadReshare",
      "shareType": "Link",
      "sharer": {
        "emailAddress": "<redacted>",
        "displayName": "Admin User",
        "identifier": "<redacted>",
        "graphId": "<redacted>",
        "principalType": "User"
      }
    },
...
  ]
}

Se você quiser obter uma lista de todos os relatórios do Power BI que foram publicados na Web:

GET https://api.powerbi.com/v1.0/myorg/admin/widelySharedArtifacts/publishedToWeb

Com o resultado que se parece com a API anterior:

{
  "ArtifactAccessEntities": [
    {
      "artifactId": "<redacted>",
      "displayName": "Incremental Refresh",
      "artifactType": "Report",
      "accessRight": "None",
      "shareType": "PublishToWeb",
      "sharer": {
        "emailAddress": "<redacted>",
        "displayName": "<redacted>",
        "identifier": "<redacted>",
        "graphId": "<redacted>",
        "principalType": "User"
      }
    }
  ]
}

Observe que, como apenas o relatório do Power BI pode ser amplamente compartilhado por meio desses dois métodos, é o único tipo de artefato que pode ser retornado na resposta dessas APIs.

Saiba mais sobre essa API na página de documentação.

Orientação rápida para trabalhar com GetGroupsAsAdmin

Contar com GetGroupsAsAdmin é uma maneira popular de coletar informações em espaços de trabalho do Power BI, porém, pode não ser o melhor desempenho se você precisar expandir a resposta para incluir artefatos contidos neles. Se você precisar consultar ou iterar em muitos workspaces, recomendamos que você:

1. Faça uso dos parâmetros $filter “type” e “state”, pois esses dois parâmetros foram otimizados para desempenho, em vez de recuperar todos os espaços de trabalho primeiro e filtrar a resposta. Se você precisar de ajuda sobre a sintaxe adequada para usar o parâmetro $filter, (consulte este link);
2. Esteja atento ao uso do filtro $expand, pois ele tende a tornar a chamada da API mais cara, potencialmente adicionando um grande número de artefatos e/ou metadados do usuário à resposta;
3. Aproveite a API do Scanner, que não permite bloqueios e é projetada para lidar com um grande número de espaços de trabalho sem nenhuma das limitações usuais de chamadas de API.

Observe que, devido ao grande volume de chamadas para a API GetGroupsAsAdmin, foi reduzido para o limite normal de 200 chamadas/hora/inquilino para 50. As chamadas com mais de 30 segundos para uma resposta serão encerradas automaticamente, a fim de evitar a degradação da confiabilidade do serviço Power BI.

Fonte: Blog Power BI.

Acompanhe nosso blog toda sexta-feira e não perca nenhuma novidade sobre o Power BI. Fique de olho em nossas redes sociais também e fique por dentro de tudo que acontece na DataEX.

Alcance o topo com dashboards incríveis e 100% customizáveis.

Com o apoio de uma equipe especializada em Dados você conseguirá transformar seu negócio através de insights 100% fomentados por uma base de dados completa e confiável.

Preencha o formulário e descubra como isso é possível.