{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"1b079a64-7848-4682-90b2-74ff8ad67405","name":"Cognitive3D API (Public)","description":"Public API Collection for the Cognitive3D API\n\nData Collector API Documentation can be found [here](https://documenter.getpostman.com/view/10564952/VUxNQng7).\n\nSupport is avaliable by email: `support@cognitive3d.com`\n\n_Disclaimer: This documentation is a work-in-progress. Not all routes are documented yet, and some information may be unavaliable or incomplete_\n\n## Authentication\n\nRequest can be authenticated via an API Key. To create an API Key you will require admin access to the organization that you are trying to access (see \"Roles\" below for a description).\n\nClick on the \"gear\" icon in the top right corner, then \"Organization Settings\", then \"Manage API Keys\" then \"Create API Key\". The API Key is treated as a password and once the window is closed you will no longer be able to retrieve it, make sure you copy it. It is recommended to keep it as a \"read\" only useless you specifically need otherwise.\n\n**Using the API key**  \nAdd a header with the key \"Authorization\" and the value \"{your key}\" where {your key} is subsituted with your actual key. This will only give you access for that specific organiztion and all the Projects, Scenes, and Sessions of that Organization.  \n  \nNOTE: You must include the `orgkey-` prefix in your api key authorization header  \nNOTE: Organization keys issued before May 2025 (without the `orgkey-` prefix) must have this alternate prefix added: \"APIKEY:ORGANIZATION {your key}\"\n\n## Roles\n\nEach user has one or more roles. There are various scopes a role can have. Note that some roles can be _observer_ roles which are read-only.\n\nThere are various scopes a role can have. These scopes are a hierarchy; for example if you have _Organization_\\-level access, you will also have _Project,_ and _Scene_ level access.\n\n**Domain**\n\nThis is the highest level permission a user can have. This is only avaliable if you have a whitelabel agreement with us. This scope allows access to domain settings.\n\n**Organization**\n\nThe organization scope allows viewing/editing organization settings, such as adding/changing organization members (and their roles), viewing the organization audit log, configuring third-party connections, etc.\n\n**Project**\n\nProject scope allows viewing and editing project-level settings, and allows access to all scenes. This also covers access to Objectives, ExitPoll, Media Library, etc.\n\n**Scene**\n\nAllows viewing/editing a scene and its contents. This includes the scenes dynamic objects, sessions, aggregate data, and media.\n\n**User**\n\nAll users have access to their own account, this allows things such as fetching their own information, updating their password, etc.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"23149462","team":3982777,"collectionId":"1b079a64-7848-4682-90b2-74ff8ad67405","publishedId":"2s935rK3Ju","public":true,"publicUrl":"https://docs.api.cognitive3d.com","privateUrl":"https://go.postman.co/documentation/23149462-1b079a64-7848-4682-90b2-74ff8ad67405","customColor":{"top-bar":"FFFFFF","right-sidebar":"281773","highlight":"281773"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2023-03-07T00:04:29.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Production","id":"ccdc2733-8851-4b9c-ac6f-638d680f3c57","owner":"23149320","values":[{"key":"api","value":"https://api.cognitive3d.com","enabled":true,"type":"default"},{"key":"domain","value":"api.cognitive3d.com","enabled":true,"type":"default"},{"key":"email","value":"example@example.com","enabled":true,"type":"default"},{"key":"password","value":"my-password","enabled":true,"type":"secret"},{"key":"mfa_session","value":"asdf","enabled":true,"type":"secret"},{"key":"csrf","value":"foo","enabled":true,"type":"secret"},{"key":"organizationId","value":"[organizationId]","enabled":true,"type":"default"},{"key":"participantId","value":"ABC123","enabled":true,"type":"default"},{"key":"projectId","value":"[projectId]","enabled":true,"type":"default"},{"key":"objectiveVersionId","value":"[objectiveVersionId]","enabled":true,"type":"default"},{"key":"questionSetName","value":"","enabled":true,"type":"default"},{"key":"questionSetVersion","value":"","enabled":true,"type":"default"},{"key":"ssoLoginCode","value":"foo","enabled":true,"type":"secret"},{"key":"elasticsearch_pass","value":"foo","enabled":true,"type":"secret"},{"key":"elasticsearch_host","value":"http://localhost:9190","enabled":true,"type":"default"},{"key":"user_id","value":"123456","enabled":true,"type":"default"},{"key":"userId","value":"123456","enabled":true,"type":"default"},{"key":"pbi_api","value":"http://c3d-powerbi-functions-prod.azurewebsites.net/api","enabled":true,"type":"secret"},{"key":"versionId","value":"123456","enabled":true,"type":"default"},{"key":"apiKeyId","value":"123456","enabled":true,"type":"default"},{"key":"apiKey","value":"asdf","enabled":true,"type":"secret"},{"key":"hmd.type","value":"","enabled":true,"type":"default"},{"key":"sceneId","value":"abc123-def456-abc123-def456-xcv456","enabled":true,"type":"default"},{"key":"time_now_milliseconds","value":"","enabled":true,"type":"any"},{"key":"time_1h_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"time_6h_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"time_12h_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"time_24h_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"time_7d_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"time_30d_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"time_now_iso","value":"","enabled":true,"type":"any"},{"key":"time_90d_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"time_180d_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"time_365d_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"time_1000d_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"milliseconds_start_of_current_month_gmt","value":"","enabled":true,"type":"any"},{"key":"milliseconds_end_of_current_month_gmt","value":"","enabled":true,"type":"any"},{"key":"milliseconds_start_of_previous_month_gmt","value":"","enabled":true,"type":"any"},{"key":"milliseconds_end_of_previous_month_gmt","value":"","enabled":true,"type":"any"},{"key":"sdkSessionId","value":"","enabled":true,"type":"any"},{"key":"apiData","value":"","enabled":true,"type":"default"},{"key":"milliseconds_start_of_month_gmt","value":"","enabled":true,"type":"any"},{"key":"milliseconds_end_of_month_gmt","value":"","enabled":true,"type":"any"},{"key":"backofficeApiKey","value":"","enabled":true,"type":"secret"},{"key":"developerKey","value":"","enabled":true,"type":"secret"},{"key":"backofficeKey","value":"","enabled":true,"type":"default"},{"key":"categoryGroupId","value":"[categoryGroupId]","enabled":true,"type":"default"},{"key":"benchmarkMetricName","value":"[benchmarkMetricName]","enabled":true,"type":"default"},{"key":"time_60d_ago_milliseconds","value":"","enabled":true,"type":"any"},{"key":"c3d.participant.id","value":"","enabled":true,"type":"default"},{"key":"c3d.participant.name","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/64429da8aad1b20118a24a44f20bae1b0087d6c71d2665a6b6ea9a7768187d06","favicon":"https://res.cloudinary.com/postman/image/upload/v1771970303/team/426cd4deecb79d36b78b78b6dc0cdad0.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Production","value":"23149320-ccdc2733-8851-4b9c-ac6f-638d680f3c57"}],"canonicalUrl":"https://docs.api.cognitive3d.com/view/metadata/2s935rK3Ju"}