Tinybird

Potencialize seus pipelines de dados e analytics em tempo real com o Tinybird – a plataforma rápida e escalável para ingerir, consultar e construir APIs sobre grandes volumes de dados de eventos. O Tinybird permite que desenvolvedores e engenheiros de dados coletem, transformem e exponham dados instantaneamente, facilitando dashboards, aplicações e automação com insights atualizados.

Com a integração do Tinybird, você pode:

  • Transmitir eventos em escala: Ingerir milhões de eventos JSON por segundo de forma confiável, usando APIs HTTP com NDJSON ou JSON.
  • Consultar dados com baixa latência: Executar analytics e agregações complexas baseadas em SQL em tempo real, ideais para dashboards, alertas e relatórios.
  • Expor dados via APIs instantâneas: Construir e publicar endpoints de API para suas queries diretamente na UI do Tinybird ou via API.
  • Automatizar fluxos de trabalho: Usar as APIs do Tinybird nas suas automações para buscar, transformar e sincronizar dados em todo o seu stack.
  • Monitorar e depurar: Obter insights sobre performance de pipelines, latências de query e saúde da ingestão com monitoramento em tempo real.
  • Acesso seguro: Aproveitar autenticação granular e escopo de recursos com tokens de API pessoais ou de workspace.

O Tinybird capacita equipes de engenharia, analytics e produto a entregar produtos de dados ultrarrápidos e sempre atualizados com sobrecarga operacional mínima. Vá de dados brutos de eventos a endpoints prontos para produção em minutos.

Conecte o Tinybird aos seus fluxos hoje para acelerar features orientadas a dados, automação e analytics!

Usage Instructions

Interact with Tinybird: stream JSON or NDJSON events with the Events API, run SQL with the Query API, call published Pipe API Endpoints by name with dynamic parameters, manage Data Sources by appending from a URL, truncating, or deleting rows by condition, and poll the status of asynchronous jobs.

Actions

tinybird_events

Send events to a Tinybird Data Source using the Events API. Supports JSON and NDJSON formats with optional gzip compression.

Input

ParameterTypeRequiredDescription
base_urlstringYesTinybird API base URL (e.g., https://api.tinybird.co or https://api.us-east.tinybird.co\)
datasourcestringYesName of the Tinybird Data Source to send events to. Example: "events_raw", "user_analytics"
datastringYesData to send as NDJSON (newline-delimited JSON) or JSON string. Each event should be a valid JSON object. Example NDJSON: {"user_id": 1, "event": "click"}\n{"user_id": 2, "event": "view"}
waitbooleanNoWait for database acknowledgment before responding. Enables safer retries but introduces latency. Defaults to false.
formatstringNoFormat of the events data: "ndjson" (default) or "json"
compressionstringNoCompression format: "none" (default) or "gzip"
tokenstringYesTinybird API Token with DATASOURCES:APPEND or DATASOURCES:CREATE scope

Output

ParameterTypeDescription
successful_rowsnumberNumber of rows successfully ingested
quarantined_rowsnumberNumber of rows quarantined (failed validation)

tinybird_query

Execute SQL queries against Tinybird Pipes and Data Sources using the Query API.

Input

ParameterTypeRequiredDescription
base_urlstringYesTinybird API base URL (e.g., https://api.tinybird.co\)
querystringYesSQL query to execute. Specify your desired output format (e.g., FORMAT JSON, FORMAT CSV, FORMAT TSV). JSON format provides structured data, while other formats return raw text. Example: "SELECT * FROM my_datasource LIMIT 100 FORMAT JSON"
pipelinestringNoOptional pipe name. When provided, enables SELECT * FROM _ syntax. Example: "my_pipe", "analytics_pipe"
tokenstringYesTinybird API Token with PIPES:READ scope

Output

ParameterTypeDescription
datajsonQuery result data. For FORMAT JSON: array of objects. For other formats (CSV, TSV, etc.): raw text string.
metaarrayColumn metadata for the result set (only available with FORMAT JSON)
namestringColumn name
typestringColumn data type
rowsnumberNumber of rows returned (only available with FORMAT JSON)
rows_before_limit_at_leastnumberMinimum number of rows there would be without a LIMIT clause (only available with FORMAT JSON)
statisticsjsonQuery execution statistics - elapsed time, rows read, bytes read (only available with FORMAT JSON)

tinybird_query_pipe

Call a published Tinybird Pipe API Endpoint by name, passing dynamic parameters and receiving structured JSON results.

Input

ParameterTypeRequiredDescription
base_urlstringYesTinybird API base URL (e.g., https://api.tinybird.co\)
pipestringYesName of the published Pipe API Endpoint to call. Example: "top_pages"
parametersjsonNoDynamic Pipe parameters as a JSON object, sent as query-string arguments. Example: {"start_date": "2024-01-01", "limit": 10}
qstringNoOptional SQL to run on top of the Pipe result. Use "_" to reference the Pipe. Example: "SELECT count() FROM _"
tokenstringYesTinybird API Token with PIPES:READ scope

Output

ParameterTypeDescription
datajsonPipe result data as an array of row objects
metaarrayColumn metadata for the result set
namestringColumn name
typestringColumn data type
rowsnumberNumber of rows returned
rows_before_limit_at_leastnumberMinimum number of rows there would be without a LIMIT clause
statisticsjsonQuery execution statistics - elapsed time, rows read, bytes read
elapsednumberQuery execution time in seconds
rows_readnumberNumber of rows processed
bytes_readnumberNumber of bytes processed

tinybird_append_datasource

Append data to a Tinybird Data Source from a remote file URL (CSV, NDJSON, Parquet).

Input

ParameterTypeRequiredDescription
base_urlstringYesTinybird API base URL (e.g., https://api.tinybird.co\)
datasourcestringYesName of the existing Data Source to append to. Example: "events_raw"
urlstringYesPublicly accessible URL of the file to append. Example: "https://example.com/data.csv"
formatstringNoFormat of the source file: "csv" (default), "ndjson", or "parquet"
tokenstringYesTinybird API Token with DATASOURCES:APPEND or DATASOURCES:CREATE scope

Output

ParameterTypeDescription
idstringIdentifier of the append operation
import_idstringImport identifier for the append job
job_idstringJob identifier used to poll import status
job_urlstringURL to query the import job status
statusstringInitial job status (e.g., "waiting")
jobjsonFull import job details (kind, id, status, created_at, datasource, ...)
datasourcejsonTarget Data Source metadata (id, name, ...)

tinybird_truncate_datasource

Delete all rows from a Tinybird Data Source.

Input

ParameterTypeRequiredDescription
base_urlstringYesTinybird API base URL (e.g., https://api.tinybird.co\)
datasourcestringYesName of the Data Source to truncate. Example: "events_raw"
tokenstringYesTinybird API Token with DATASOURCES:CREATE scope

Output

ParameterTypeDescription
truncatedbooleanWhether the Data Source was truncated successfully
resultjsonRaw response body from the truncate endpoint, if any

tinybird_delete_datasource_rows

Delete rows from a Tinybird Data Source matching a SQL condition.

Input

ParameterTypeRequiredDescription
base_urlstringYesTinybird API base URL (e.g., https://api.tinybird.co\)
datasourcestringYesName of the Data Source to delete rows from. Example: "events_raw"
delete_conditionstringYesSQL WHERE-clause condition selecting the rows to delete. Example: "country = 'ES'" or "event_date < '2024-01-01'"
dry_runbooleanNoWhen true, returns how many rows would be deleted without deleting them. Defaults to false.
tokenstringYesTinybird API Token with DATASOURCES:CREATE scope

Output

ParameterTypeDescription
idstringIdentifier of the delete operation
job_idstringJob identifier used to poll delete status
delete_idstringDeletion identifier
job_urlstringURL to query the delete job status
statusstringCurrent job status (e.g., "waiting", "done")
jobjsonFull delete job details (kind, id, status, delete_condition, rows_affected, ...)

tinybird_get_job

Check the status of an asynchronous Tinybird job (import, delete, etc.) by ID.

Input

ParameterTypeRequiredDescription
base_urlstringYesTinybird API base URL (e.g., https://api.tinybird.co\)
job_idstringYesID of the job to check, as returned by an append or delete operation
tokenstringYesTinybird API Token with ADMIN scope, or the token that started the job

Output

ParameterTypeDescription
idstringJob identifier
job_idstringJob identifier (same as id)
kindstringJob kind (e.g., "import", "delete_data", "populateview", "copy")
statusstringCurrent job status: "waiting", "working", "done", "error", or "cancelled"
job_urlstringURL to re-query this job status
created_atstringTimestamp the job was created
started_atstringTimestamp the job started running
updated_atstringTimestamp of the last job status update
is_cancellablebooleanWhether the job can still be cancelled
errorstringError message, present only when status is "error"
jobjsonFull raw job details, including kind-specific fields (statistics, datasource, delete_condition, etc.)

On this page