Analytics

BI dataset catalog

GET/api/v1/analitico

The catalog of BI datasets the key can query, with columns, type and whether each is sensitive or filterable.

Key scope

Any key of the account (read is enough).

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	yes	Bearer followed by the key. Alternative: X-API-Key header.

Response fields

Name	Type	Description
`datasets`	array	Available datasets.
`datasets[].chave`	string	Key to use in the URL or in colunas.
`datasets[].nome`	string	Name.
`datasets[].colunas`	array	The columns.
`datasets[].colunas[].chave`	string	Key to use in the URL or in colunas.
`datasets[].colunas[].rotulo`	string	Field label as the screen shows it.
`datasets[].colunas[].tipo`	string	Type, in the screen's vocabulary.
`datasets[].colunas[].sensivel`	boolean	true when the column only comes for keys with See Values.
`datasets[].colunas[].filtravel`	boolean	true when the column accepts filters.
`datasets[].colunas[].campoDaEmpresa`	boolean	true for company-created fields (only returned when asked by name).
`limite`	integer	Row ceiling per query.
`parametros`	string	Summary of accepted parameters.
`aviso`	string	Text notice about the response.

Status codes

HTTP	Description
200	Catalog

Error messages

HTTP	Message (erro field)	When it happens
401	`chave de API ausente ou inválida`	No key header, revoked key or typo.
401	`chave sem empresa vinculada`	The key exists but is not linked to an account. Create another one in Settings › API.
403	`conta de demonstração: a API pública está desligada na vitrine`	The call reached the demo account, where the public API is turned off.
403	`identidade da chave de API irregular`	The account refuses keys with irregular identity (deactivated person or ownerless key). The body brings motivo and comoResolver.
429	`limite de requisições excedido (120/min)`	The key went over its per-minute limit. Wait for Retry-After.

Request example

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 generated from the contract — download at 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);

Response example

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
}

Generated from OpenAPI contract v1.2.0, the same one openapi.json publishes. openapi.json