|
|
Existe apenas uma rota que retorna dados na API do Blendb, chamada *data*. Diferente das rotas de metadados essa rota possue parâmetros que definem qual a consulta que será realizada.
|
|
|
|
|
|
Os parâmetros são:
|
|
|
|
|
|
* **metrics**: Uma lista de métricas, separadas por vírgula
|
|
|
* **dimensions**: Uma lista de dimensões, separadas por vírgula
|
|
|
* **filters**: Uma lista de filtros organizados em formato **CNF** onde vírgulas representam ORs e pontos-e-vírgulas representam ANDs.
|
|
|
|
|
|
Para mais informações sobre métricas dimensões e filtros, veja o tópico sobre [Linguagem](sobre/linguagem).
|
|
|
|
|
|
## Métricas e dimensões
|
|
|
|
|
|
As métricas e dimensão são obtidas através das rotas de metadados, para utiliza-las em uma consulta basta adcionar seu nome na lista apropriada
|
|
|
|
|
|
## Filtros
|
|
|
|
|
|
Filtros são dimensões seguidos de um operador e um valor. Usados para restringir os dados retornados.
|
|
|
|
|
|
## Consulta
|
|
|
|
|
|
A consulta é realizada através da concatenação da rota com os parâmetros. Um exemplo seria obter a **Quantidade de cidades** (métrica : **qtdCidades**) e **número de habitantes** (métrica: **qtdHabitantes**) por **Estado** (dimensão: **estado**) da base de dados é **localhost:3001/v1/** A requisição resultante seria:
|
|
|
|
|
|
**localhost:3000/v1/data?metrics=qtdCidades,qtdHabitantes&dimensions=estado**.
|
|
|
|
|
|
O resultado dessa resquisição é uma lista de objetos onde as propriedades dos objetos são as métricas e dimensões informadas.
|
|
|
|
|
|
## [Home](/)
|
|
|
* [Introdução](api/introdução)
|
|
|
* [Usos](api/usos)
|
|
|
* [Obtendo metadados](api/metadados)
|
|
|
* **Obtendo dados**
|
|
|
* [Outros](api/outros) |