Data API

Endpoints para consumo externo de visualizaciones via API key.

Ejecutar Endpoint

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

Ejecuta un endpoint de visualizacion. El modo de ejecucion (sync o async) se define en la configuracion del endpoint.

Permiso: data_api:execute

Parametros de Ruta

Campo	Tipo	Descripcion
namespace	string	Namespace del endpoint (kebab-case)
slug	string	Slug del endpoint (kebab-case)

Body (opcional)

Campo	Tipo	Obligatorio	Descripcion
parameter_values	object	No	Valores para los parametros de la visualizacion
callback_url	string	No	URL de webhook para el resultado (solo modo async, HTTPS obligatorio)

Respuesta 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"
}

Respuesta 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 el estado de un job de ejecucion asincrona.

Permiso: data_api:get_job

Parametros de Ruta

Campo	Tipo	Descripcion
namespace	string	Namespace del endpoint
slug	string	Slug del endpoint
job_id	string	ID del job devuelto en la ejecucion async

Respuesta (200)

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

Cuando status es completed, el campo result contiene:

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

Cuando status es failed, el campo error contiene el mensaje de error.

---

Codigos de Error

HTTP	Codigo	Descripcion
400	INVALID_PARAMS	Namespace o slug ausente
401	-	Token ausente o invalido
403	FORBIDDEN	Sin el permiso necesario
404	ENDPOINT_NOT_FOUND	Endpoint inexistente, inactivo o de otra company
404	JOB_NOT_FOUND	Job inexistente o no pertenece al endpoint
408	EXECUTION_TIMEOUT	Timeout en la ejecucion sync (60s)
422	-	Parametro invalido o violacion de share context
500	EXECUTION_ERROR	Error en la ejecucion del query
500	INTERNAL_ERROR	Error interno