Analítico

Catálogo dos datasets do BI (plataforma + os da sua empresa)

GET/api/v1/analitico

O catálogo dos conjuntos de dados do BI que a chave pode consultar, com as colunas, o tipo e se cada uma é sensível ou filtrável.

Cada dataset traz chave, nome e colunas (tipo, sensivel, filtravel). Colunas sensíveis só saem quando a chave pode ver valores.

Escopo da chave

Qualquer chave da conta (leitura basta).

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
`Authorization`	header	string	sim	Bearer seguido da chave. Alternativa: cabeçalho X-API-Key.

Campos da resposta

Nome	Tipo	Descrição
`datasets`	array	Os conjuntos de dados disponíveis.
`datasets[].chave`	string	Chave para usar no endereço ou em colunas.
`datasets[].nome`	string	Nome.
`datasets[].colunas`	array	As colunas.
`datasets[].colunas[].chave`	string	Chave para usar no endereço ou em colunas.
`datasets[].colunas[].rotulo`	string	Nome do campo como a tela mostra.
`datasets[].colunas[].tipo`	string	Tipo, no vocabulário da tela.
`datasets[].colunas[].sensivel`	boolean	true quando a coluna só vem para chave com Ver Valores.
`datasets[].colunas[].filtravel`	boolean	true quando a coluna aceita filtro.
`datasets[].colunas[].campoDaEmpresa`	boolean	true para campo criado pela empresa (só vem quando pedido pelo nome).
`limite`	integer	Teto de linhas por consulta.
`parametros`	string	Resumo dos parâmetros aceitos.
`aviso`	string	Aviso em texto sobre a resposta.

Códigos de status

HTTP	Descrição
200	Catálogo

Mensagens de erro

HTTP	Mensagem (campo erro)	Quando acontece
401	`chave de API ausente ou inválida`	Sem cabeçalho de chave, chave revogada ou digitada errada.
401	`chave sem empresa vinculada`	A chave existe mas não está ligada a uma conta. Gere outra em Configurações › API.
403	`conta de demonstração: a API pública está desligada na vitrine`	A chamada veio para a conta de demonstração: lá a API pública fica desligada.
403	`identidade da chave de API irregular`	A conta recusa chaves com identidade irregular (pessoa desligada ou chave sem dono). O corpo traz motivo e comoResolver.
429	`limite de requisições excedido (120/min)`	Passou do limite por minuto da chave. Espere o Retry-After.

Exemplo de chamada

cURL

curl "https://tenka.app.br/api/v1/analitico" \
  -H "Authorization: Bearer $TENKA_API_KEY"

JavaScript

const response = await fetch("https://tenka.app.br/api/v1/analitico", {
  method: "GET",
  headers: {
    "Authorization": "Bearer " + TENKA_API_KEY
  }
});
const data = await response.json();
if (!response.ok || data.erro) throw new Error(response.status + " " + data.erro);
console.log(data);

Python

import os
import requests

response = requests.get(
    "https://tenka.app.br/api/v1/analitico",
    headers={
        "Authorization": f"Bearer {os.environ['TENKA_API_KEY']}",
    },
    timeout=30,
)
data = response.json()
if not response.ok or "erro" in data:
    raise RuntimeError(f"{response.status_code} {data.get('erro')}")
print(data)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder(URI.create("https://tenka.app.br/api/v1/analitico"))
    .header("Authorization", "Bearer " + System.getenv("TENKA_API_KEY"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());

using System.Net.Http.Headers;
using System.Text;

using var http = new HttpClient();
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("TENKA_API_KEY"));
var request = new HttpRequestMessage(HttpMethod.Get, "https://tenka.app.br/api/v1/analitico");
var response = await http.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

PHP

<?php
$ch = curl_init("https://tenka.app.br/api/v1/analitico");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("TENKA_API_KEY"),
    ],
]);
$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$data = json_decode($body, true);
echo $status . " " . $body;

Node (SDK)

// SDK gerado do contrato — baixe em https://tenka.app.br/api/v1/sdk/tenka.js
import { Tenka } from "./tenka.js";

const tenka = new Tenka(process.env.TENKA_API_KEY, "https://tenka.app.br/api/v1");
const data = await tenka.getAnalitico({});
console.log(data);

Exemplo de resposta

200 · application/json

{
  "datasets": [
    {
      "chave": "tickets",
      "nome": "Demandas (tickets)",
      "colunas": [
        {
          "chave": "titulo",
          "rotulo": "Título",
          "tipo": "TEXTO",
          "sensivel": false,
          "filtravel": true,
          "campoDaEmpresa": false
        }
      ]
    }
  ],
  "limite": 1000
}

Gerado do contrato OpenAPI v1.2.0, o mesmo que o openapi.json publica. openapi.json