👤 Para super admins e admins
🔐 Disponível para todos os planos
🎯 Para quem quer disponibilizar o link de um relatório em um email ou em qualquer outro lugar
⏩ Resumo:
Aprenda a tirar o máximo proveito da API do Pipefy para disponibilizar o link de download do seu relatório.
Como gerar um link de download para seu relatório
É possível fazer isso utilizando a API do Pipefy (GraphiQL). Na API, é possível realizar consultas (queries) e ações (mutations) em seus processos. Saiba mais sobre como usar a API do Pipefy.
📢 Atenção: Para que você possa utilizar a API, você precisa ter a função de administrador na empresa. Saiba mais sobre funções e permissões no Pipefy.
Apesar de ser necessário um pouco de código, neste artigo você encontrará todos os passos necessários para que você faça as atualizações.
Dentro do pipe com seus relatórios
Para começar, você precisará do ID do pipe com seus relatórios. Acessando o pipe, você encontrará o ID na URL.
Na API do Pipefy
Acesse a API e siga as instruções abaixo.
Agora que você já tem o ID do pipe, você vai precisar realizar três queries para criar o link de download do seu relatório.
A primeira delas, você irá encontrar o ID de cada um dos seus relatórios. Substitua o ID do Pipe pelo que foi encontrado no último passo:
query{ pipe(id:ID do Pipe){ reports{ name id } } }
A query deverá estar parecida com esta:
Após executar a query, no lado direito, você terá a lista com as informações de nome e ID do relatório:
Após obter a ID do seu relatório, você irá contruir a segunda query, a qual irá exportar o seu relatório. Substitua as informações com o ID do pipe e o ID do relatório:
mutation { exportPipeReport(input: {pipeId: ID do pipe, pipeReportId: ID do relatorio}) {clientMutationId pipeReportExport {id state} } }
A mutation deverá estar parecida com esta:
Após executar a mutation, no lado direito, você obterá o ID da exportação:
Após obter a ID da exportação, você irá contruir a terceira query, a qual irá gerar o link de download do seu relatório. Substitua as informações com o ID da exportação do relatório:
query{ pipeReportExport(id:ID da exportação){ state fileURL } }
A query deverá estar parecida com esta:
Após executar a query, no lado direito, você obterá o Link de download do relatório, podendo disponibiliza-lo no corpo do seu email, ou onde desejar:
📢 Atenção: Atente-se ao rodar atualizações ou consultas em massa, uma vez que as chamadas de API consomem parte dos limites do seu plano. Saiba mais sobre os limites dos planos.
Conteúdos relacionados
🎓 Aprenda a fazer muito mais com os cursos gratuitos da Pipefy Academy!
🌎 Faça parte da Comunidade do Pipefy para tirar dúvidas, compartilhar sugestões, ficar por dentro das novidades e dividir seu conhecimento com pessoas do mundo todo!