Skip to main content

SheetIntegration

idstring
namestring
kindstring

run: dataset items of each succeeded matching run; listening: new mentions of a project (+ a daily KPI row)

Possible values: [run, listening]

spreadsheet_idstring
spreadsheet_urlstring
sheet_namestring

Tab; created when missing. No [ ] * ? / \ :

condition object

run only

actor_idstring
task_idstring
project_idstring | nullnullable

listening only, required

fieldsstring[]

Columns (item paths, a.b for nested). Empty: run = the items' keys; listening = the default mention columns

upsert_keystring | nullnullable

Overwrite the row whose cell in this column matches (listening defaults to id). Empty: append

max_rowsinteger | nullnullable

Rows one delivery may write

row_limitinteger
include_kpisboolean

listening: yesterday's KPI row (date, new_mentions, views, likes, comments, shares, engagement, sentiment counts) once a day, upserted by date

kpi_sheet_namestring | nullnullable

Default: '⟨sheet_name⟩ KPI'

is_enabledboolean
verification_tabstring

lantfly-⟨code⟩: the customer adds a tab with this name once (POST …/test checks it) to prove the spreadsheet is theirs; nothing is written before. A spreadsheet can be connected to one account only (422 otherwise).

verified_at(string | null)<date-time>nullable

Reset when spreadsheet_id changes

last_delivery_at(string | null)<date-time>nullable
last_errorstring | nullnullable
last_delivery object
oneOf
idstring
triggerstring

Possible values: [run, mentions, kpi, test]

run_idstring | nullnullable
statusstring

Possible values: [ACTIVE, SUCCEEDED, FAILED]

attemptsinteger
rows_appendedinteger
rows_updatedinteger
rows_skippedinteger

Items past the row limit, not written

errorstring | nullnullable
next_attempt_at(string | null)<date-time>nullable
created_at(string | null)<date-time>nullable
SheetIntegration
{
  "id": "string",
  "name": "string",
  "kind": "run",
  "spreadsheet_id": "string",
  "spreadsheet_url": "string",
  "sheet_name": "string",
  "condition": {
    "actor_id": "string",
    "task_id": "string"
  },
  "project_id": "string",
  "fields": [
    "string"
  ],
  "upsert_key": "string",
  "max_rows": 0,
  "row_limit": 0,
  "include_kpis": true,
  "kpi_sheet_name": "string",
  "is_enabled": true,
  "verification_tab": "string",
  "verified_at": "2024-07-29T15:51:28.071Z",
  "last_delivery_at": "2024-07-29T15:51:28.071Z",
  "last_error": "string",
  "last_delivery": {
    "id": "string",
    "trigger": "run",
    "run_id": "string",
    "status": "ACTIVE",
    "attempts": 0,
    "rows_appended": 0,
    "rows_updated": 0,
    "rows_skipped": 0,
    "error": "string",
    "next_attempt_at": "2024-07-29T15:51:28.071Z",
    "created_at": "2024-07-29T15:51:28.071Z"
  }
}