COcontentstudio
🔗 Analytics Share Links

Create a shareable analytics link

Changed on

Creates a link that anyone holding the URL can open without a ContentStudio account. It grants READ access to the workspace, platform and account it was created for, and nothing else. Set is_password_protected with a password to require one; the password is stored hashed and never returned.

post/api/v1/workspaces/{workspace_id}/analytics/share-links

Request

  • Base URL
    https://api.contentstudio.io
  • URL
    https://api.contentstudio.io/api/v1/workspaces/{workspace_id}/analytics/share-links
  • Auth
    API key in header X-API-Key

Path parameters

workspace_idstring required
Example:610a1e660cb41530ca40d372

Workspace Id

Request body

titlestring required
platform'overview' | 'facebook' | 'instagram' | 'linkedin' | 'tiktok' | 'youtube' | 'pinterest' | 'twitter' | 'gmb' | 'meta_ads' | 'google_ads' required
account_idstring nullable
overview_accountsstring[] nullable
is_date_range_fixedboolean
date_rangestring nullable

Required when is_date_range_fixed is true. A fixed link keeps showing the period it was made for.

is_account_switching_enabledboolean
is_password_protectedboolean
passwordstring

Write-only. Stored hashed, never returned.

expires_atstring nullable

Optional deadline (date or datetime, must be in the future). After it passes the link stops opening and the viewer is told it expired. Omit for a link that lives until disabled or deleted.

Response

Created; the response carries share_url.

object required

Changes