Advisor

Relatórios gerados pelo servidor com sugestões sobre o projeto.

Classe Advisor: 5 métodos (0 no @owbase/web, 5 no @owbase/node). Os exemplos usam a forma de objeto dos parâmetros; troque os valores entre < e > pelos seus.

listReports

Listar relatórios

SDK: só @owbase/node

Obtém a lista de todos os relatórios de análise do projeto. Use os parâmetros de consulta para filtrar os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
queries	string[]	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: appId, type, targetType, target, analyzedAt
total	boolean	não	Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo reports.read.

@owbase/node

import { Client, Advisor } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const advisor = new Advisor(client);

const result = await advisor.listReports({
    queries: [], // opcional
    total: false, // opcional
});

getReport

Obter relatório

SDK: só @owbase/node

Obtém um relatório de análise pelo ID. A resposta traz os metadados do relatório e os insights aninhados que ele gerou.

Parâmetro	Tipo	Obrigatório	Descrição
reportId	string	sim	ID do relatório.

Acesso: chave de API com o escopo reports.read.

@owbase/node

import { Client, Advisor } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const advisor = new Advisor(client);

const result = await advisor.getReport({
    reportId: '<REPORT_ID>',
});

deleteReport

Excluir relatório

SDK: só @owbase/node

Exclui um relatório de análise pelo ID. Os insights aninhados e os metadados de CTA são removidos de forma assíncrona pelo worker de exclusões.

Parâmetro	Tipo	Obrigatório	Descrição
reportId	string	sim	ID do relatório.

Acesso: chave de API com o escopo reports.write.

@owbase/node

import { Client, Advisor } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const advisor = new Advisor(client);

const result = await advisor.deleteReport({
    reportId: '<REPORT_ID>',
});

listInsights

Listar insights

SDK: só @owbase/node

Lista os insights gerados por um relatório de análise. Use os parâmetros de consulta para filtrar mais os resultados.

Parâmetro	Tipo	Obrigatório	Descrição
reportId	string	sim	ID do relatório pai.
queries	string[]	não	Lista de consultas geradas com a classe Query do SDK. Saiba mais sobre consultas. No máximo 100 consultas, cada uma com até 4096 caracteres. É possível filtrar pelos atributos: type, severity, status, resourceType, resourceId, parentResourceType, parentResourceId, analyzedAt, dismissedAt, dismissedBy
total	boolean	não	Com false, o total não é calculado e volta como 0.

Acesso: chave de API com o escopo insights.read.

@owbase/node

import { Client, Advisor } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const advisor = new Advisor(client);

const result = await advisor.listInsights({
    reportId: '<REPORT_ID>',
    queries: [], // opcional
    total: false, // opcional
});

getInsight

Obter insight

SDK: só @owbase/node

Obtém um insight pelo ID, dentro do relatório a que pertence.

Parâmetro	Tipo	Obrigatório	Descrição
reportId	string	sim	ID do relatório pai.
insightId	string	sim	ID do insight.

Acesso: chave de API com o escopo insights.read.

@owbase/node

import { Client, Advisor } from '@owbase/node';

const client = new Client()
    .setEndpoint('https://cloud.owbase.dev/v1') // endpoint da API
    .setProject('<YOUR_PROJECT_ID>') // ID do projeto
    .setKey('<YOUR_API_KEY>'); // chave de API (só no servidor)

const advisor = new Advisor(client);

const result = await advisor.getInsight({
    reportId: '<REPORT_ID>',
    insightId: '<INSIGHT_ID>',
});

---

As descrições desta página são traduções das que vêm da especificação da API do servidor (licença BSD-3-Clause), e os exemplos vêm do gerador de SDKs (licença MIT). Os avisos completos estão no arquivo NOTICE dos pacotes @owbase/web e @owbase/node.