APIs para acessar dados de análise do marketplace comercial

Veja a seguir a lista de APIs para acessar dados de análise do marketplace comercial e suas funcionalidades associadas.

APIs pull do conjuntos de dados

Tabela 1: APIs pull do conjuntos de dados

API	Funcionalidade
Obter todos os conjuntos de dados	Essa API deve ser chamada para obter a lista de conjuntos de dados disponíveis e respectivas colunas, métricas e intervalos de tempo.

Tabela 2: APIs de gerenciamento de consulta

API	Funcionalidade
Criar consulta de relatório	Essa API deve ser usada para criar uma consulta de acordo com o caso de uso.
Consultas de relatório GET	Essa API deve ser usada para obter a lista de consultas.
Consultas de relatório DELETE	Essa API deve ser usada para excluir qualquer consulta definida pelo usuário.
Consultas de relatório TRY	Essa API deve ser usada para testar a consulta e validar os dados.

Tabela 3: APIs de gerenciamento de relatório

API	Funcionalidade
Criar Relatório	Essa API deve ser usada para criar ou agendar um relatório com base na ID da consulta.
Obter relatório	Essa API deve ser usada para obter a lista de relatórios criados.
Atualizar relatório	Essa API deve ser usada para modificar um parâmetro de relatório.
Excluir relatório	Esta API deve ser usada para excluir qualquer relatório e respectivos registros de execução.
Pausar execuções de relatório	Essa API deve ser usada para pausar a execução programada de relatórios.
Retomar execuções de relatório	Essa API deve ser usada para retomar a execução agendada de um relatório pausado.

Tabela 4: APIs pull de execução de relatório

API	Funcionalidade
Obter execuções de relatório	Essa API deve ser usada para obter todas as execuções de um relatório.

É possível experimentar as APIs por meio da URL da API do Swagger.