arcodash
Start free trial
PlatformConnectorsPricingSecurityDocs
Sign inStart free trial
api reference

Embeds

Public, tokenized embed links for a dashboard or visualization, plus the org-wide switch that governs them.

POST/api/embeds

Create an embed for a dashboard or visualization, optionally anonymous, with locked parameters and/or an expiry.

Request

{
  "object_type": "dashboard",
  "object_id": 9,
  "anonymous": true,
  "locked_params": { "region": "us-east" },
  "expires_at": "2026-12-31T00:00:00Z"
}

Response

{
  "id": 5,
  "object_type": "dashboard",
  "object_id": 9,
  "mode": "public",
  "token": "e5f6...",
  "public_url": "https://acme.arcodash.com/public/embed/e5f6...",
  "locked_params": { "region": "us-east" },
  "expires_at": "2026-12-31T00:00:00Z",
  "anon_authorized": true,
  "revoked_at": null,
  "created_at": "2026-07-17T12:00:00Z"
}

GET/api/embeds

List embeds for one object.

ParamTypeRequiredDescription
object_typestringYes"dashboard" or "visualization".
object_idintegerYesThe object's id.

GET/api/embeds/active_count

Count of active (non-revoked, non-expired) public embeds for a query — the query editor's "N public embeds" warning.

ParamTypeRequiredDescription
query_idintegerYesThe query id.

Response

{ "count": 2 }

DELETE/api/embeds/{id}

Revoke an embed. Returns 204.

GET/api/orgs/me/embed_settings

Whether the org's public/embed URLs are currently enabled. A missing settings row reads as enabled — this endpoint always returns a value.

Response

{ "public_urls_enabled": true }

POST/api/orgs/me/embed_settings

Toggle the org's public/embed URLs on or off. Admin only. Turning this off is a soft, reversible pause — it doesn't revoke or delete any individual embed.

Request

{ "public_urls_enabled": false }

Response

{ "public_urls_enabled": false }