Skip to main content
POST
/
v1
/
delivery
Configure Google Sheet Delivery
curl --request POST \
  --url https://api.lobstr.io/v1/delivery \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "google_sheet_fields.url": "<string>",
  "google_sheet_fields.append": true,
  "google_sheet_fields.is_active": true
}
'
{
  "google_sheet_fields.url": "<string>",
  "google_sheet_fields.is_active": true,
  "google_sheet_fields.append": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

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

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
​
Content-Type
string
required
Must be application/json. Value: application/json

​
Query Parameters

​
squid
string
required
The unique identifier (hash) of the squid for which to configure Google Sheet delivery. Example: c106a44a98044ef18acc59986ae10967

​
Request Body

​
google_sheet_fields.url
string
required
Public 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.append
boolean
required
false: Overwrites previous data with the last run’s result. true: Appends new results, deduplicated. Example: false
​
google_sheet_fields.is_active
boolean
required
Set to true to enable Google Sheet export, false to disable. Example: true

​
Response Field Explanations

​
google_sheet_fields.url
string
The configured Google Sheet URL. Example: "https://docs.google.com/spreadsheets/d/1ly9nwTs-hNaFCzWtSljevSf16chs5Nn0PIv_TpQSEhA/edit?usp=sharing"
​
google_sheet_fields.is_active
boolean
Whether Google Sheet export is active. Example: true
​
google_sheet_fields.append
boolean
Append 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

201
{
  "google_sheet_fields": {
    "url": "https://docs.google.com/spreadsheets/d/1ly9nwTs-hNaFCzWtSljevSf16chs5Nn0PIv_TpQSEhA/edit?usp=sharing",
    "is_active": true,
    "append": false
  }
}