Live Google Sheet status for a campaign

GET /campaigns/{id}/sheet

Live Google Sheet status for a campaign

cURL

curl --request GET \
  --url https://api.pineyard.ai/campaigns/{id}/sheet \
  --header 'Authorization: Bearer <token>'

200

{
  "connected": true,
  "googleEmail": "<string>",
  "linked": true,
  "spreadsheetUrl": "<string>",
  "source": "GENERATED",
  "status": "ACTIVE",
  "autoSync": true,
  "matchColumn": "<string>",
  "lastSyncedAt": "<string>",
  "lastError": "<string>",
  "legacyLayout": true,
  "managedColumnCount": 123,
  "layoutLocked": true,
  "sheetTitle": "<string>",
  "sheetGid": 123,
  "previousSpreadsheetUrl": "<string>",
  "rotatedAt": "<string>"
}

Required scope: intel.view

Requires a plan that includes business intelligence (basic tier). Otherwise the request is refused; see Errors.

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Response

200

application/json

OK

connected · boolean · required

googleEmail · string | null · required

linked · boolean · required

spreadsheetUrl · string | null · required

source · enum<string> | null · required

Available options: GENERATED, ATTACHED

status · enum<string> | null · required

Available options: ACTIVE, PAUSED, ERROR

autoSync · boolean · required

matchColumn · string | null · required

lastSyncedAt · string | null · required

lastError · string | null · required

legacyLayout · boolean · required

managedColumnCount · integer · required

layoutLocked · boolean · required

sheetTitle · string | null · required

sheetGid · integer | null · required

previousSpreadsheetUrl · string | null · required

rotatedAt · string | null · required