|
|
|
Para obter qualquer informação da API (dados ou metadados) duas informações são necessárias o **endereço base** e as **rotas**.
|
|
|
|
Existem duas rotas que retornam dados no Blendb, *metrics* e *dimensions*.
|
|
|
|
|
|
|
|
O **endereço base** representa a base de dados. Nada mais é do que uma URL. Uma base pública provavelmente informará qual é a URL base. Um exemplo de endereço base para uma abse pública seria **http://blendb.c3sl.ufpr.br/api/v1** . Uma instalação local poderia ser **localhost:3000/v1**.
|
|
|
|
## Metrics
|
|
|
|
|
|
|
|
As **rotas** definem as operações que podem ser realizadas. Essas rotas definem a API.
|
|
|
|
A rota *metrics* retorna as informações de todas as métricas disponíveis na base de dados. O próposito dessa rota é informar ao usuário o **significado** da métrica e oferecer a informação necessária para realizar a consulta.
|
|
|
|
|
|
|
|
Para fazer uma requisição para a base da dados basta concatenar o **endereço base** com a **rota**.
|
|
|
|
Essa rota responde uma lista com as informação de todas as métricas.
|
|
|
|
|
|
|
|
Um exemplo, para obter as métricas da base **localhost:3000/v1** a requisição é feita para **localhost:3000/v1/metrics**
|
|
|
|
As informações de cada métrica são:
|
|
|
|
* **name**: Nome da métrica, utilizada para realizar a consulta
|
|
|
|
* **aggregation**: Função de agregação da métrica
|
|
|
|
* **dataType**: O tipo de dados da métrica (Inteiro, string, etc...)
|
|
|
|
* **description**: Uma breve descrição da métrica.
|
|
|
|
|
|
|
|
## Dimensions
|
|
|
|
|
|
|
|
A rota *dimensions* retorna as informações de todas as dimensões disponíveis na base de dados. O próposito dessa rota é informar ao usuário o **significado** da dimensão e oferecer a informação necessária para realizar a consulta.
|
|
|
|
|
|
|
|
Essa rota responde uma lista com as informação de todas as dimensões.
|
|
|
|
|
|
|
|
As informações de cada dimensão são:
|
|
|
|
* **name**: Nome da dimensão, utilizada para realizar a consulta
|
|
|
|
* **relation**: Relação que existe com a dimensão mãe
|
|
|
|
* **parent**: Dimensão mãe
|
|
|
|
* **dataType**: O tipo de dados da métrica (Inteiro, string, etc...)
|
|
|
|
* **description**: Uma breve descrição da dimensão.
|
|
|
|
|
|
|
|
## [Home](/)
|
|
|
|
* [Introdução](api/introdução)
|
|
|
|
* [Usos](api/usos)
|
|
|
|
* **Obtendo metadados**
|
|
|
|
* [Obtendo dados](api/dados)
|
|
|
|
* [Outros](api/outros)
|
|
|
|
|
|
|
|
A seguir é apresentado quais são as rotas utilizadas para obter dados e metadados e quais são os parametros que devem ser utilizados. |
|
|
\ No newline at end of file |
