Tinybird ingests data and exposes query results through APIs. Send JSON or NDJSON events, run SQL queries, or call a published Pipe by name with its parameters. The integration also manages data sources and checks asynchronous task status.
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.
Send events to a Tinybird Data Source using the Events API. Supports JSON and NDJSON formats with optional gzip compression.
Parameter Type Required Description base_urlstring Yes Tinybird API base URL (e.g., https://api.tinybird.co or https://api.us-east.tinybird.co ) datasourcestring Yes Name of the Tinybird Data Source to send events to. Example: "events_raw", "user_analytics" datastring Yes Data 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"} waitboolean No Wait for database acknowledgment before responding. Enables safer retries but introduces latency. Defaults to false. formatstring No Format of the events data: "ndjson" (default) or "json" compressionstring No Compression format: "none" (default) or "gzip" tokenstring Yes Tinybird API Token with DATASOURCES:APPEND or DATASOURCES:CREATE scope
Parameter Type Description successful_rowsnumber Number of rows successfully ingested quarantined_rowsnumber Number of rows quarantined (failed validation)
Execute SQL queries against Tinybird Pipes and Data Sources using the Query API.
Parameter Type Required Description base_urlstring Yes Tinybird API base URL (e.g., https://api.tinybird.co ) querystring Yes SQL 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" pipelinestring No Optional pipe name. When provided, enables SELECT * FROM _ syntax. Example: "my_pipe", "analytics_pipe" tokenstring Yes Tinybird API Token with PIPES:READ scope
Parameter Type Description datajson Query result data. For FORMAT JSON: array of objects. For other formats (CSV, TSV, etc.): raw text string. metaarray Column metadata for the result set (only available with FORMAT JSON) ↳ name string Column name ↳ type string Column data type rowsnumber Number of rows returned (only available with FORMAT JSON) rows_before_limit_at_leastnumber Minimum number of rows there would be without a LIMIT clause (only available with FORMAT JSON) statisticsjson Query execution statistics - elapsed time, rows read, bytes read (only available with FORMAT JSON)
Call a published Tinybird Pipe API Endpoint by name, passing dynamic parameters and receiving structured JSON results.
Parameter Type Required Description base_urlstring Yes Tinybird API base URL (e.g., https://api.tinybird.co ) pipestring Yes Name of the published Pipe API Endpoint to call. Example: "top_pages" parametersjson No Dynamic Pipe parameters as a JSON object, sent as query-string arguments. Example: {"start_date": "2024-01-01", "limit": 10} qstring No Optional SQL to run on top of the Pipe result. Use "_" to reference the Pipe. Example: "SELECT count() FROM _" tokenstring Yes Tinybird API Token with PIPES:READ scope
Parameter Type Description datajson Pipe result data as an array of row objects metaarray Column metadata for the result set ↳ name string Column name ↳ type string Column data type rowsnumber Number of rows returned rows_before_limit_at_leastnumber Minimum number of rows there would be without a LIMIT clause statisticsjson Query execution statistics - elapsed time, rows read, bytes read ↳ elapsed number Query execution time in seconds ↳ rows_read number Number of rows processed ↳ bytes_read number Number of bytes processed
Append data to a Tinybird Data Source from a remote file URL (CSV, NDJSON, Parquet).
Parameter Type Required Description base_urlstring Yes Tinybird API base URL (e.g., https://api.tinybird.co ) datasourcestring Yes Name of the existing Data Source to append to. Example: "events_raw" urlstring Yes Publicly accessible URL of the file to append. Example: "https://example.com/data.csv " formatstring No Format of the source file: "csv" (default), "ndjson", or "parquet" tokenstring Yes Tinybird API Token with DATASOURCES:APPEND or DATASOURCES:CREATE scope
Parameter Type Description idstring Identifier of the append operation import_idstring Import identifier for the append job job_idstring Job identifier used to poll import status job_urlstring URL to query the import job status statusstring Initial job status (e.g., "waiting") jobjson Full import job details (kind, id, status, created_at, datasource, ...) datasourcejson Target Data Source metadata (id, name, ...)
Delete all rows from a Tinybird Data Source.
Parameter Type Required Description base_urlstring Yes Tinybird API base URL (e.g., https://api.tinybird.co ) datasourcestring Yes Name of the Data Source to truncate. Example: "events_raw" tokenstring Yes Tinybird API Token with DATASOURCES:CREATE scope
Parameter Type Description truncatedboolean Whether the Data Source was truncated successfully resultjson Raw response body from the truncate endpoint, if any
Delete rows from a Tinybird Data Source matching a SQL condition.
Parameter Type Required Description base_urlstring Yes Tinybird API base URL (e.g., https://api.tinybird.co ) datasourcestring Yes Name of the Data Source to delete rows from. Example: "events_raw" delete_conditionstring Yes SQL WHERE-clause condition selecting the rows to delete. Example: "country = 'ES'" or "event_date < '2024-01-01'" dry_runboolean No When true, returns how many rows would be deleted without deleting them. Defaults to false. tokenstring Yes Tinybird API Token with DATASOURCES:CREATE scope
Parameter Type Description idstring Identifier of the delete operation job_idstring Job identifier used to poll delete status delete_idstring Deletion identifier job_urlstring URL to query the delete job status statusstring Current job status (e.g., "waiting", "done") jobjson Full delete job details (kind, id, status, delete_condition, rows_affected, ...)
Check the status of an asynchronous Tinybird job (import, delete, etc.) by ID.
Parameter Type Required Description base_urlstring Yes Tinybird API base URL (e.g., https://api.tinybird.co ) job_idstring Yes ID of the job to check, as returned by an append or delete operation tokenstring Yes Tinybird API Token with ADMIN scope, or the token that started the job
Parameter Type Description idstring Job identifier job_idstring Job identifier (same as id) kindstring Job kind (e.g., "import", "delete_data", "populateview", "copy") statusstring Current job status: "waiting", "working", "done", "error", or "cancelled" job_urlstring URL to re-query this job status created_atstring Timestamp the job was created started_atstring Timestamp the job started running updated_atstring Timestamp of the last job status update is_cancellableboolean Whether the job can still be cancelled errorstring Error message, present only when status is "error" jobjson Full raw job details, including kind-specific fields (statistics, datasource, delete_condition, etc.)