Configure Google Sheet Delivery
Export squid run results directly to a shared Google Sheet
https://api.lobstr.io/v1/delivery?squid={squid_hash}Configure Google Sheet delivery to export run results directly to a shared Google Sheet. Results can be overwritten with each run or appended with deduplication.
Behavior
- append = false: Only the latest run's data is exported. Any previously exported data is overwritten.
- append = true: Data from all runs is appended and deduplicated before export.
Requirements
- The Google Sheet must be shared with "Anyone with the link"
- The sheet must have Editor access permission
- Export is limited to 100,000 rows
Headers
AuthorizationstringheaderrequiredYour API authentication token. Value: Token YOUR_API_KEY
Content-TypestringheaderrequiredMust be application/json. Value: application/json
Query Parameters
squidstringqueryrequiredThe unique identifier (hash) of the squid for which to configure Google Sheet delivery. Example: c106a44a98044ef18acc59986ae10967
Request Body
google_sheet_fields.urlstringrequiredPublic Google Sheet URL (must be accessible with Editor permission). Example: "https://docs.google.com/spreadsheets/d/1ly9nwTs-hNaFCzWtSljevSf16chs5Nn0PIv_TpQSEhA/edit?usp=sharing"
google_sheet_fields.appendbooleanrequiredfalse: Overwrites previous data with the last run's result. true: Appends new results, deduplicated. Example: false
google_sheet_fields.is_activebooleanrequiredSet to true to enable Google Sheet export, false to disable. Example: true
Response Field Explanations
google_sheet_fields.urlstringThe configured Google Sheet URL. Example: "https://docs.google.com/spreadsheets/d/1ly9nwTs-hNaFCzWtSljevSf16chs5Nn0PIv_TpQSEhA/edit?usp=sharing"
google_sheet_fields.is_activebooleanWhether Google Sheet export is active. Example: true
google_sheet_fields.appendbooleanAppend mode setting. Example: false
The Google Sheet MUST be shared with 'Anyone with the link' and have Editor permissions. Without these settings, export will fail.
Use append: false for dashboards where you only want the latest data. Use append: true for historical tracking.
When append is true, Lobstr automatically deduplicates rows before exporting, so you won't get duplicate entries.
Export is limited to 100,000 rows. If your squid generates more results, consider using S3 or SFTP delivery instead.
Use the Test Google Sheet endpoint to verify your sheet permissions before activating automatic delivery.
Code Examples
curl -X POST "https://api.lobstr.io/v1/delivery?squid=YOUR_SQUID_HASH" \ -H "Authorization: Token YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "google_sheet_fields": { "url": "https://docs.google.com/spreadsheets/d/YOUR_SHEET_ID/edit?usp=sharing", "append": false, "is_active": true } }'
Response
{ "google_sheet_fields": { "url": "https://docs.google.com/spreadsheets/d/1ly9nwTs-hNaFCzWtSljevSf16chs5Nn0PIv_TpQSEhA/edit?usp=sharing", "is_active": true, "append": false } }