Data API

Endpoints para consumo externo de visualizacoes via API key.

Executar Endpoint

POST/api/v1/data-api/:namespace/:slug/execute

Executa um endpoint de visualizacao. O modo de execucao (sync ou async) e definido na configuracao do endpoint.

Permissao: data_api:execute

Parametros de Rota

Campo	Tipo	Descricao
namespace	string	Namespace do endpoint (kebab-case)
slug	string	Slug do endpoint (kebab-case)

Body (opcional)

Campo	Tipo	Obrigatorio	Descricao
parameter_values	object	Nao	Valores para os parametros da visualizacao
callback_url	string	Nao	URL para webhook de resultado (apenas modo async, HTTPS obrigatorio)

Resposta Sync (200)

{
  "columns": [{ "name": "regiao", "type": "varchar" }],
  "rows": [{ "regiao": "Sul" }],
  "row_count": 1,
  "truncated": false,
  "max_rows": 10000,
  "executed_at": "2026-04-11T10:30:00Z"
}

Resposta Async (202)

{
  "job_id": "507f1f77bcf86cd799439011",
  "status": "processing",
  "polling_url": "/api/v1/data-api/:namespace/:slug/jobs/507f1f77bcf86cd799439011"
}

---

Consultar Job

GET/api/v1/data-api/:namespace/:slug/jobs/:job_id

Consulta o status de um job de execucao assincrona.

Permissao: data_api:get_job

Parametros de Rota

Campo	Tipo	Descricao
namespace	string	Namespace do endpoint
slug	string	Slug do endpoint
job_id	string	ID do job retornado na execucao async

Resposta (200)

{
  "job_id": "507f1f77bcf86cd799439011",
  "status": "processing | completed | failed",
  "result": null,
  "error": null,
  "created_at": "2026-04-11T10:30:00Z",
  "completed_at": null
}

Quando status e completed, o campo result contem:

{
  "columns": [{ "name": "string", "type": "string" }],
  "rows": [{}],
  "row_count": 0,
  "truncated": false
}

Quando status e failed, o campo error contem a mensagem de erro.

---

Codigos de Erro

HTTP	Codigo	Descricao
400	INVALID_PARAMS	Namespace ou slug ausente
401	-	Token ausente ou invalido
403	FORBIDDEN	Sem permissao necessaria
404	ENDPOINT_NOT_FOUND	Endpoint inexistente, inativo ou de outra company
404	JOB_NOT_FOUND	Job inexistente ou nao pertence ao endpoint
408	EXECUTION_TIMEOUT	Timeout na execucao sync (60s)
422	-	Parametro invalido ou violacao de share context
500	EXECUTION_ERROR	Erro na execucao da query
500	INTERNAL_ERROR	Erro interno