Embedded

Create Session

Initializes an embedded session for the specified user. The system will provision a new user account if one does not exist and associate it with the provided variables. Set attribute values to <code>null</code> if they have been previously configured. Use <code>[]</code> for attribute if you want a user without attribute. The URL with nonce is only valid for 2 minutes. <b><a target='_blank' href='https://evidence.dev/pricing'>Enterprise Only</a></b>

post/v1/embedded

Request

Base URL: https://management.evidence.studio
URL: https://management.evidence.studio/v1/embedded
Auth: one of:
- API key in header Authorization
- API key in cookie wos-session

Request body

userIdstring required

An arbitrary unique string associated with the user/group. Passing a new value provisions a new user (which can take a few seconds) so reuse when the same data access is needed. For direct connectors with RLS support, pass the RLS role name

pageIdstring required

Page ID can be found on the page settings

pathstring required

path to the page

ttlnumber

Time to live in seconds of the embedded session, min 5 minutes, max 7 days

cookielessboolean

Use false to store sessions as HTTP cookies. Defaults to true due to widespread third-party cookie blocking in modern browsers.

testModeboolean

Removes security on cookie. If you are working on localhost

preventSessionShareboolean

Restricts sessions to the original device and network to prevent unauthorized reuse (enabled by default)

language'aa' | 'ab' | 'ae' | 'af' | 'ak' | 'am' | 'an' | 'ar' | 'as' | 'av' | 'ay' | 'az' | 'ba' | 'be' | 'bg' | 'bh' | 'bi' | 'bm' | 'bn' | 'bo' | 'br' | 'bs' | 'ca' | 'ce' | 'ch' | 'co' | 'cr' | 'cs' | 'cu' | 'cv' | 'cy' | 'da' | 'de' | 'dv' | 'dz' | 'ee' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'ff' | 'fi' | 'fj' | 'fo' | 'fr' | 'fy' | 'ga' | 'gd' | 'gl' | 'gn' | 'gu' | 'gv' | 'ha' | 'he' | 'hi' | 'ho' | 'hr' | 'ht' | 'hu' | 'hy' | 'hz' | 'ia' | 'id' | 'ie' | 'ig' | 'ii' | 'ik' | 'io' | 'is' | 'it' | 'iu' | 'ja' | 'jv' | 'ka' | 'kg' | 'ki' | 'kj' | 'kk' | 'kl' | 'km' | 'kn' | 'ko' | 'kr' | 'ks' | 'ku' | 'kv' | 'kw' | 'ky' | 'la' | 'lb' | 'lg' | 'li' | 'ln' | 'lo' | 'lt' | 'lu' | 'lv' | 'mg' | 'mh' | 'mi' | 'mk' | 'ml' | 'mn' | 'mr' | 'ms' | 'mt' | 'my' | 'na' | 'nb' | 'nd' | 'ne' | 'ng' | 'nl' | 'nn' | 'no' | 'nr' | 'nv' | 'ny' | 'oc' | 'oj' | 'om' | 'or' | 'os' | 'pa' | 'pi' | 'pl' | 'ps' | 'pt' | 'qu' | 'rm' | 'rn' | 'ro' | 'ru' | 'rw' | 'sa' | 'sc' | 'sd' | 'se' | 'sg' | 'si' | 'sk' | 'sl' | 'sm' | 'sn' | 'so' | 'sq' | 'sr' | 'ss' | 'st' | 'su' | 'sv' | 'sw' | 'ta' | 'te' | 'tg' | 'th' | 'ti' | 'tk' | 'tl' | 'tn' | 'to' | 'tr' | 'ts' | 'tt' | 'tw' | 'ty' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zh' | 'zu'

The language in which the dashboard content will be displayed

colorScheme'light' | 'dark'

Color scheme: 'light' (default when absent) or 'dark'

Example request

{
  "userId": "ud_123456",
  "pageId": "5f732e9b-2d6a-49c5-b726-3870125d6abc",
  "path": "org_12345/my-project/home",
  "attributes": [
    {
      "key": "employee_id",
      "value": 1102
    },
    {
      "key": "region",
      "value": "Canada"
    },
    {
      "key": "departements",
      "value": [
        "Sales",
        "Marketing"
      ]
    },
    {
      "key": "zone_id",
      "value": [
        193,
        992,
        19183
      ]
    },
    {
      "key": "isAdmin",
      "value": false
    }
  ],
  "cookieless": true,
  "testMode": true,
  "language": "fr",
  "colorScheme": "dark"
}

Response

Data returning...

unknown required

Example response

{
  "url": "https://evidence.studio/v1/embedded/bdadopkef508ac25a870c27b0d9425d689kwofasokp12i90iowjdiom"
}

Changes

No recorded changes to this operation across all 1 revision of this API.