Partilhar via


APIs para aceder a dados analíticos do mercado comercial

A seguir está a lista de APIs para acessar dados de análise de mercado comercial e suas funcionalidades associadas.

APIs de pull de conjunto de dados

Tabela 1: APIs de pull do conjunto de dados

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

APIs de gerenciamento de consultas

Tabela 2: APIs de gerenciamento de consultas

API Funcionalidade
Criar consulta de relatório Esta API deve ser usada para criar consultas de acordo com o caso de uso.
Consultas de relatório GET Esta API deve ser utilizada para obter a lista de consultas.
EXCLUIR consultas de relatório Esta API deve ser utilizada para eliminar qualquer consulta definida pelo utilizador.
Consultas de relatório TRY Esta API deve ser utilizada para testar a consulta e validar os dados.

APIs de gerenciamento de relatórios

Tabela 3: APIs de gerenciamento de relatórios

API Funcionalidade
Criar relatório Esta API deve ser utilizada para criar ou agendar um relatório com base no ID da consulta.
Obter relatório Esta API deve ser usada para obter a lista de relatórios criados.
Relatório de atualização Esta API deve ser utilizada para modificar um parâmetro de relatório.
Excluir relatório Esta API será utilizada para eliminar qualquer relatório e respetivos registos 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 Esta API deve ser utilizada para retomar a execução programada de um relatório pausado.

APIs pull de execução de relatório

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

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

Você pode experimentar as APIs por meio da URL da API do Swagger.