Re-capture a public link snapshot as you

POST /dashboard/{id}/public-link/{linkId}/refresh

Body `{ consent }` is the reviewed refresh (Update now): re-captures as you, takes the link over and brings a suspended link back; captured with the link's own switches, so it neither adds forms nor takes them away, and `consent.editable_widget_keys` is required while rows_editable is on. Body `{}` refreshes the data only, keeping what the current publisher agreed to: needs `can_refresh_now` (a live link whose current publisher is you), changes nothing about who publishes, and never turns a link on or changes `live_tables` or the form switches (so `live_tables` needs a consent; 400 otherwise). 403 public_link_not_publisher, 409 public_link_expired / public_link_not_active / public_link_dashboard_changed (review it and use Update now) / public_link_switched (forms or row edits were switched while it ran; try again).

Path Parameters

idstring

required·

Resource id

linkIdstring

required·

Resource id

Request Body

consentobject

required

dashboard_revisioninteger

The revision the preview was made from.

editable_widget_keysstring[]

The forms whose rows visitors may see and change: a second, separate agreement, required when row edits are on.

widget_keysstring[]

The widgets the preview showed.

live_tablesboolean

Only with consent. The refresher becomes the publisher, so live queries would run as them. Absent: kept only if the refresher already was the publisher, otherwise switched off.

Response Body

can_change_refreshboolean

Only the link's current publisher (the person whose Update now made its current copy) may change how it updates; everyone else with can_refresh takes it over with refresh first.

can_enable_formsboolean

can_refresh, the link not expired, and form_count above 0.

can_enable_live_tablesboolean

May the caller switch live_tables on: the same rule as can_change_refresh. Switching off needs only can_manage.

can_enable_row_editsboolean

Also needs forms on and edit_form_count above 0.

can_manageboolean

can_refreshboolean

can_refresh_nowboolean

May the caller refresh the data now without a review: the link is live and the caller is its current publisher. Everyone else uses refresh with a consent, which takes the link over.

change_refresh_blocked_reasonstring,null

created_atstring

created_bystring

dashboard_idstring

edit_form_countinteger

Forms on the link's pages whose edit_rows is not off.

enable_live_tables_blocked_reasonstring,null

expires_atstring

feeding_automation_countinteger

feeding_automationsobject[]

At most 5 workflows that write a collection the dashboard reads, among those the caller may see.

enabledboolean

idstring

namestring

form_countinteger

Form widgets on the link's pages of the published dashboard; 0 means there is nothing to switch on.

forms_blocked_reasonstring,null

forms_enabledboolean

Visitors may fill in the dashboard's forms.

forms_problemstring,null

With forms on and the link live: why entries are refused right now, one sentence; null when they are taken.

hidden_countinteger

idstring

live_tablesboolean

Viewers may filter, sort, page and export the link's tables live; every query runs as the publisher (snapshot_by).

next_refresh_atstring,null

When the next capture of this link is due, or null when none is waiting. Reflects only the requests the link has received: a workflow run that finishes inside the workflow's own 15-minute gap arms a timer first and has not asked yet, so the link can show nothing pending for up to 15 minutes after such a run.

pagesstring[]

recommended_refreshstring

Possible values:

automationinterval

refreshstring

Possible values:

manualautomationinterval

refresh_blocked_reasonstring,null

refresh_interval_hoursinteger,null

Set exactly when refresh is interval.

Possible values:

161224null

refresh_now_blocked_reasonstring,null

refresh_pending_reasonstring,null

Why next_refresh_at is waiting: a workflow run asked inside the 15-minute minimum gap since the last capture (min_gap), the last capture failed and is retried (retry_after_failure), or the link's own schedule (interval).

Possible values:

min_gapretry_after_failureintervalnull

row_edits_blocked_reasonstring,null

rows_editableboolean

Visitors may see and change the rows of the link's editable forms.

shown_countinteger

snapshot_atstring,null

When the copy that is being served was captured.

snapshot_bystring,null

snapshot_by_display_namestring,null

statusstring

Possible values:

activepausedsuspendedexpiredrevoked

suspended_reasonstring,null

Possible values:

publisher_invalidpublisher_leftsettings_offdashboard_changednull

curl -X POST 'https://api.elaichi.ai/dashboard/<id>/public-link/<linkId>/refresh' \
  -H 'Authorization: Bearer $ELAICHI_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"consent":{},"live_tables":true}'

const body = {
  "consent": {},
  "live_tables": true
};

const response = await fetch('https://api.elaichi.ai/dashboard/<id>/public-link/<linkId>/refresh', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ' + process.env.ELAICHI_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);

import os
import requests

url = "https://api.elaichi.ai/dashboard/<id>/public-link/<linkId>/refresh"
headers = {
    "Authorization": f"Bearer {os.environ['ELAICHI_API_TOKEN']}",
    "Content-Type": "application/json",
}
payload = {
    "consent": {},
    "live_tables": True
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())