{"info":{"_postman_id":"7622ad38-a077-c20c-cedb-561e3e8e9084","name":"CrankWheel RESTful API","description":"

The CrankWheel RESTful API allows you to retrieve usage history in various forms, manage your users, update your account configuration, and generate or retrieve session and embedding links of several types.

Start by logging into your CrankWheel account as an administrator, and retrieve either a read-only API key or a read/write API key using the API tab.

With the read-only API key, you can perform actions on many of the Crankwheel API as per the examples here, although for several you need a read/write key.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1953706","collectionId":"7622ad38-a077-c20c-cedb-561e3e8e9084","publishedId":"713cbLC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-03-27T14:17:08.000Z"},"item":[{"name":"Usage history","item":[{"name":"Retrieve demo request history","id":"c093afd2-d68b-f353-9bf6-1d6a283c6eea","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"from\": \"2018-01-01T00:00:00Z\", \"to\": \"2018-02-28T23:59:59Z\"}"},"url":"{{server-url}}/ss/api/demo_usage","description":"

This API endpoint allows you to retrieve a history of demo requests made to your account in a given time period.

Request

Note the to= and from= query parameters, which are timestamps. If they are not given, the last 28 days of history will be retrieved.

For authentication, set your own API key in your environment or paste it instead of {{crankwheel-api-key}} in the value for the Authorization header under the Headers tab.

Response

The response is a JSON document.

The top level shows the number of cancelled demo requests during the period as total_canceled_requests.

It also has a list indexed as sessions.

Each session in the list shows:

start_ts: The timestamp of the start of the session
\n
last_event_ts: The timestamp of the last event received during the session, i.e. roughly when the session ended
\n
availability_bucket: Which bucket of availability the CrankWheel system believed it was in. Values can be full_capacity if it believed that more than 50% of agents were available to do a demo, half_capacity if it believed that 50% or fewer were available, and no_capacity if it believed no agents were available. Availability is determined based on whether an agent has been active at their computer in the last 10 minutes, and also based on whether they are already screen sharing using CrankWheel.
\n
seconds_to_respondHow many seconds it took to respond to the request, i.e. until an agent said they would handle it. If no agent handled the request (yet), the value will be never.
\n
handled_by will be present if an agent handled the request and will show the agent's email address.
\n
call_confirmed: Whether a call was confirmed. Values can be true, false or if the request was never responded to, n/a.
\n
screenshared: Whether a screenshare was initiated after the call commenced. Values can be true, false or if a call was never initiated, n/a. Note that these screen shares are also listed by the \"Retrieve usage history\" API (although it makes no mention that they were due to an Instant Demos request).
\n
accepted_from shows a value of extension, email or n/a.
\n

Lastly, the session contains a prospect_info object.

The fixed prospect_info keys are:

prospect-phone: The phone number entered by the prospect.
\n
prospect-request-origin: The web page the request originated on. If originated from an email campaign, it will look like https://meeting.is/ss/showu/COMPANYSHORTNAME, possibly with parameters after the company's short name.
\n
prospect-utm-source, prospect-utm-medium, prospect-utm-campaign, prospect-utm-term and prospect-utm-content: These reflect UTM parameters if they were present on the web page where the prospect requested a demo.
\n
prospect-location: Geographic location of the prospect as determined by their IP address.
\n

In addition, each lead capture question gets a key. Here is the default set, but keys for custom questions will inherit the name assigned to the question when it is created, e.g. prospect-shoesize for a question where you set the ID as shoesize:

prospect-name: The prospect's name as entered by themselves.
\n
prospect-email: The prospect's email address as entered by themselves.
\n
prospect-company: The prospect's company name as entered by themselves.
\n
prospect-job-title: The prospect's title as entered by themselves.
\n
prospect-website: The prospect's company's web page as entered by themselves.
\n

\n","urlObject":{"path":["ss","api","demo_usage"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"15bb24ae-b0f1-2725-2578-250f704767e2","name":"Retrieve demo request history","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://meeting.is/ss/api/demo_usage?from=2017-09-27T00:00:00Z&to=2017-09-27T23:59:59Z","protocol":"https","host":["meeting","is"],"path":["ss","api","demo_usage"],"query":[{"key":"from","value":"2017-09-27T00:00:00Z"},{"key":"to","value":"2017-09-27T23:59:59Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive","description":""},{"key":"Content-Encoding","value":"gzip","description":""},{"key":"Content-Type","value":"application/json; charset=utf-8","description":""},{"key":"Date","value":"Thu, 28 Sep 2017 12:21:19 GMT","description":""},{"key":"Server","value":"nginx","description":""},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains","description":""},{"key":"Transfer-Encoding","value":"chunked","description":""},{"key":"Vary","value":"Accept-Encoding","description":""},{"key":"cache-control","value":"max-age=0, private, must-revalidate","description":""},{"key":"x-request-id","value":"cldv9ea60fd36mc2t6no77sqbqig0pf9","description":""}],"cookie":[],"responseTime":"205","body":"{\n \"total_canceled_requests\": 2,\n \"sessions\": [\n {\n \"start_ts\": \"2017-09-27T22:49:21.507365\",\n \"seconds_to_respond\": 53,\n \"screenshared\": true,\n \"prospect_info\": {\n \"prospect-request-origin\": \"crankwheel.com/\",\n \"prospect-phone\": \"+354 54321\",\n \"prospect-name\": \"Jói\",\n \"prospect-location\": \"Kopavogur, Iceland\",\n \"prospect-email\": \"joi@crankwheel.com\"\n },\n \"last_event_ts\": \"2017-09-27T22:51:00.875003\",\n \"id\": 22599,\n \"handled_by\": \"somebody@example.com\",\n \"call_confirmed\": true,\n \"availability_bucket\": \"half_capacity\",\n \"accepted_from\": \"extension\"\n },\n {\n \"start_ts\": \"2017-09-27T16:19:59.273625\",\n \"seconds_to_respond\": \"never\",\n \"screenshared\": \"n/a\",\n \"prospect_info\": {\n \"prospect-website\": \"\",\n \"prospect-request-origin\": \"crankwheel.com/\",\n \"prospect-phone\": \"+354 54321\",\n \"prospect-name\": \"\",\n \"prospect-location\": \"Iceland\",\n \"prospect-job-title\": \"\",\n \"prospect-email\": \"\",\n \"prospect-company\": \"\"\n },\n \"last_event_ts\": \"2017-09-27T16:20:11.594782\",\n \"id\": 22487,\n \"handled_by\": \"none\",\n \"call_confirmed\": \"n/a\",\n \"availability_bucket\": \"full_capacity\",\n \"accepted_from\": \"n/a\"\n }\n ]\n}"}],"_postman_id":"c093afd2-d68b-f353-9bf6-1d6a283c6eea"},{"name":"Older API - retrieve usage history","id":"a3f29756-c0cb-430f-8bd3-9e8bd1f8cae5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{server-url}}/ss/api/usage?from=2020-09-01T00:00:00Z&to=2020-09-28T23:59:59Z","description":"

This retrieves screen sharing usage history from your CrankWheel account (screen shares only). It includes both stand-alone screen shares as well as screen shares that may have resulted from an Instant Demos request.

Note the to= and from= query parameters which are timestamps. If they are not given, the last 28 days of history will be retrieved.

For authentication, set your own API key in your environment or paste it instead of {{crankwheel-api-key}} in the value for the Authorization header under the Headers tab.

\n","urlObject":{"path":["ss","api","usage"],"host":["{{server-url}}"],"query":[{"key":"from","value":"2020-09-01T00:00:00Z"},{"key":"to","value":"2020-09-28T23:59:59Z"}],"variable":[]}},"response":[],"_postman_id":"a3f29756-c0cb-430f-8bd3-9e8bd1f8cae5"},{"name":"New retrieve usage history","id":"5f15c79e-6981-4f36-8d0b-6b5ae8c738a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{server-url}}/ss/api/usage_new?from=2020-11-23T00:00:00Z&to=2024-11-23T23:59:59Z","description":"

Note the to= and from= query parameters which are timestamps. If they are not given, the last 28 days of history will be retrieved.

For authentication, set your own API key in your environment or paste it instead of {{crankwheel-api-key}} in the value for the Authorization header under the Headers tab.

\n","urlObject":{"path":["ss","api","usage_new"],"host":["{{server-url}}"],"query":[{"key":"from","value":"2020-11-23T00:00:00Z"},{"key":"to","value":"2024-11-23T23:59:59Z"},{"disabled":true,"description":{"content":"

Optional, defaults to false. If true, show all users including those with 0 usage.

\n","type":"text/plain"},"key":"include_all_users","value":"true"}],"variable":[]}},"response":[{"id":"23dd539c-06f3-46b5-b6ad-02b759721b37","name":"New retrieve usage history","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{server-url}}/ss/api/usage_new?from=2020-09-01T00:00:00Z&to=2020-09-28T23:59:59Z","host":["{{server-url}}"],"path":["ss","api","usage_new"],"query":[{"key":"from","value":"2020-09-01T00:00:00Z"},{"key":"to","value":"2020-09-28T23:59:59Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.17.10"},{"key":"Date","value":"Fri, 09 Oct 2020 13:55:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"25260"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"7bu49vcf55lj7e78eb0ufgvhfjqmpbo1"}],"cookie":[],"responseTime":null,"body":"{\n \"stats\": {\n \"user_stats\": [\n {\n \"joi+admin@crankwheel.com\": {\n \"total_sec\": 10333,\n \"total_count\": 138\n }\n }\n ],\n \"total_sec\": 10333,\n \"total_count\": 138\n },\n \"sessions\": [\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T15:25:08.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T15:27:53.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 165\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T15:23:42.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T15:24:09.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 27\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T15:22:38.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T15:23:28.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 50\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 10\n },\n \"start_date\": \"2020-09-25T15:19:31.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T15:19:53.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 22\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T15:13:37.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T15:13:42.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 5\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T15:06:52.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T15:07:43.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 51\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T15:06:00.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T15:06:51.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 51\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T14:18:06.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T14:18:54.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 48\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T14:14:38.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T14:15:24.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 46\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T14:11:55.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T14:12:20.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 25\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T14:10:08.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T14:10:30.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 22\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T14:04:05.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T14:04:27.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 22\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T14:01:22.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T14:01:44.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 22\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T14:00:43.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T14:00:59.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 16\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:58:21.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:59:30.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 69\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:54:24.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:55:09.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 45\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:50:06.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:50:28.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 22\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:49:42.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:49:49.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 7\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:40:30.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:45:39.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 309\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:26:41.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:28:37.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 116\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:20:45.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:24:54.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 249\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:14:18.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:14:43.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 25\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:13:21.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:13:30.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 9\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:07:14.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:07:29.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 15\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-25T13:06:15.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-25T13:06:27.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 12\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T20:14:33.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T20:14:40.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 7\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T14:33:36.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T14:33:38.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 2\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:52:06.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:55:10.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 184\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:51:03.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:51:37.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 34\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:47:27.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:48:39.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 72\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:45:24.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:46:20.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 56\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:44:47.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:45:09.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 22\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:44:29.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:44:36.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 7\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:43:04.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:44:14.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 70\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:35:34.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:37:16.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 102\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:33:36.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:35:01.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 85\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:29:49.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:31:04.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 75\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:25:43.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:26:07.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 24\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T13:17:28.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:17:45.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 17\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T12:59:18.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T13:00:21.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 63\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T11:27:55.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T11:29:01.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 66\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T11:25:48.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T11:26:32.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 44\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T11:16:33.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T11:23:42.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 429\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T11:12:17.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T11:14:00.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 103\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T11:11:35.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T11:11:48.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 13\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-23T11:08:35.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-23T11:11:18.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 163\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-22T12:16:07.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-22T12:16:22.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 15\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-22T12:13:44.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-22T12:13:50.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 6\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 2\n },\n \"start_date\": \"2020-09-22T11:58:21.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-22T11:59:02.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 41\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-22T11:54:41.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-22T11:55:11.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 30\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-22T11:53:47.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-22T11:54:21.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 34\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-22T11:52:44.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-22T11:53:46.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 62\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-22T11:49:00.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-22T11:50:26.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 86\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-18T11:20:31.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-18T11:20:39.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 8\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-18T11:20:01.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-18T11:20:05.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 4\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-16T11:04:35.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-16T11:05:28.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 53\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-15T10:27:49.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-15T10:29:49.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 120\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-14T11:29:02.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-14T11:29:19.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 17\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-11T14:24:55.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-11T14:24:58.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 3\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-11T13:50:11.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-11T13:50:18.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 7\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-10T17:41:49.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-10T17:41:53.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 4\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-09T20:29:34.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-09T20:29:37.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 3\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-09T20:28:07.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-09T20:28:08.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 1\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-09T15:32:07.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-09T15:32:18.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 11\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-09T13:20:46.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-09T13:26:50.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 364\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-07T13:24:00.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-07T13:26:51.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 171\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T14:33:28.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T14:33:32.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 4\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T14:29:59.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T14:30:03.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 4\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T13:51:52.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T13:51:53.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 1\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T13:51:34.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T13:51:36.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 2\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T13:27:09.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T13:27:24.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 15\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T13:10:42.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T13:12:03.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 81\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T13:01:58.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T13:06:08.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 250\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T12:57:06.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T13:01:39.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 273\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T12:44:04.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T12:54:56.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 652\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T12:40:40.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T12:43:36.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 176\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T12:39:19.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T12:40:28.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 69\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T12:37:03.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T12:37:37.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 34\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T12:34:44.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T12:36:20.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 96\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T12:27:25.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T12:27:41.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 16\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T12:25:46.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T12:25:59.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 13\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-06T12:25:04.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-06T12:25:16.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 12\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T17:20:41.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T17:21:11.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 30\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T17:19:23.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T17:20:26.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 63\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T16:59:43.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T17:01:34.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 111\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T16:58:06.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T16:58:17.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 11\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T16:56:37.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T16:56:48.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 11\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T16:55:33.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T16:55:45.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 12\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T16:53:48.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T16:53:59.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 11\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T16:52:18.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T16:52:33.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 15\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T16:06:32.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T16:20:32.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 840\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T16:04:41.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T16:05:52.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 71\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T16:01:42.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T16:02:47.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 65\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T16:00:11.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T16:01:32.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 81\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T15:59:47.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T15:59:59.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 12\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T15:59:04.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T15:59:28.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 24\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T15:52:49.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T15:53:42.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 53\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T15:52:13.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T15:52:26.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 13\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T15:47:49.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T15:48:02.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 13\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T15:45:52.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T15:46:07.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 15\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T15:45:31.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T15:45:38.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 7\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T15:45:00.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T15:45:05.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 5\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T15:36:43.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T15:40:08.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 205\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T14:49:57.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T14:50:43.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 46\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T14:49:04.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T14:49:40.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 36\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T14:48:28.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T14:48:41.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 13\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T14:47:31.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T14:48:01.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 30\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T14:45:34.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T14:46:10.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 36\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-04T11:19:00.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-04T11:19:08.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 8\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T15:04:47.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T15:07:54.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 187\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T14:53:07.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T14:53:08.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 1\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T14:44:30.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T14:44:33.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 3\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T14:42:56.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T14:43:00.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 4\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T14:29:02.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T14:29:10.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 8\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T14:21:25.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T14:28:34.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 429\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T14:17:48.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T14:19:10.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 82\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T14:14:05.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T14:15:10.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 65\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T14:07:23.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T14:08:13.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 50\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:49:35.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:49:48.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 13\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:47:27.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:49:22.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 115\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:45:49.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:46:08.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 19\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:40:41.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:40:53.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 12\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:34:43.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:36:09.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 86\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:29:17.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:34:34.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 317\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:24:31.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:24:48.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 17\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:22:59.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:24:13.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 74\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:18:16.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:20:15.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 119\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:17:08.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:18:04.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 56\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T11:09:24.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:12:10.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 166\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T10:56:12.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T11:03:25.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 433\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T10:52:46.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T10:55:30.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 164\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T10:21:17.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T10:22:46.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 89\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T10:20:32.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T10:21:01.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 29\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-03T10:19:13.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-03T10:20:15.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 62\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-01T17:01:04.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-01T17:01:05.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 1\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-01T16:52:02.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-01T16:52:27.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 25\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-01T10:10:48.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-01T10:11:10.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 22\n },\n {\n \"viewer_info\": {\n \"max_viewer_count\": 1\n },\n \"start_date\": \"2020-09-01T10:10:43.000000Z\",\n \"logs\": [],\n \"end_date\": \"2020-09-01T10:11:05.000000Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"duration\": 22\n }\n ]\n}"},{"id":"1f119f2e-dbba-46f8-b005-fd72bca6b765","name":"New retrieve usage history - with recording link on one session","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{server-url}}/ss/api/usage_new?from=2022-05-07T00:00:00Z&to=2022-05-07T23:59:59Z","host":["{{server-url}}"],"path":["ss","api","usage_new"],"query":[{"key":"from","value":"2022-05-07T00:00:00Z"},{"key":"to","value":"2022-05-07T23:59:59Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.4"},{"key":"Date","value":"Mon, 09 May 2022 12:55:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"3394"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"Fu1xEckiCIOP2DYAAXII"}],"cookie":[],"responseTime":null,"body":"{\n \"sessions\": [\n {\n \"duration\": 5,\n \"email\": \"joi+admin@crankwheel.com\",\n \"end_date\": \"2022-05-07T14:59:53.000000Z\",\n \"end_time\": \"2022-05-07T14:59:53.000000Z\",\n \"links\": {\n \"recording\": \"https://joitest.crankwheel.com/ss/api/company_content/37\"\n },\n \"logs\": [\n {\n \"content\": \"\",\n \"date\": \"2022-05-07T14:59:48.390629Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"screen\"\n }\n ],\n \"rtc_seconds\": 4,\n \"session_ended\": true,\n \"start_date\": \"2022-05-07T14:59:48.000000Z\",\n \"start_time\": \"2022-05-07T14:59:48.000000Z\",\n \"viewer_info\": {\n \"locations\": [\n \"*\"\n ],\n \"max_viewer_count\": 1,\n \"viewer_count\": 1\n },\n \"webcam_s\": 0\n },\n {\n \"duration\": 28,\n \"email\": \"joi+admin@crankwheel.com\",\n \"end_date\": \"2022-05-07T13:30:35.000000Z\",\n \"end_time\": \"2022-05-07T13:30:35.000000Z\",\n \"logs\": [\n {\n \"content\": \"\",\n \"date\": \"2022-05-07T13:30:34.157737Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"screen\"\n },\n {\n \"content\": \"36|HLS recording\",\n \"date\": \"2022-05-07T13:30:26.489693Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"projector\"\n },\n {\n \"content\": \"\",\n \"date\": \"2022-05-07T13:30:20.998169Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"screen\"\n },\n {\n \"content\": \"35|Older MP4 recording\",\n \"date\": \"2022-05-07T13:30:14.764001Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"projector\"\n },\n {\n \"content\": \"\",\n \"date\": \"2022-05-07T13:30:07.831731Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"screen\"\n }\n ],\n \"rtc_seconds\": 9,\n \"session_ended\": true,\n \"start_date\": \"2022-05-07T13:30:07.000000Z\",\n \"start_time\": \"2022-05-07T13:30:07.000000Z\",\n \"viewer_info\": {\n \"locations\": [\n \"*\"\n ],\n \"max_viewer_count\": 1,\n \"viewer_count\": 1\n },\n \"webcam_s\": 0\n },\n {\n \"duration\": 40,\n \"email\": \"joi+admin@crankwheel.com\",\n \"end_date\": \"2022-05-07T13:28:18.000000Z\",\n \"end_time\": \"2022-05-07T13:28:18.000000Z\",\n \"logs\": [\n {\n \"content\": \"\",\n \"date\": \"2022-05-07T13:28:17.954659Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"screen\"\n },\n {\n \"content\": \"36|HLS recording\",\n \"date\": \"2022-05-07T13:28:09.480450Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"projector\"\n },\n {\n \"content\": \"\",\n \"date\": \"2022-05-07T13:28:03.083075Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"screen\"\n },\n {\n \"content\": \"35|Older MP4 recording\",\n \"date\": \"2022-05-07T13:27:56.749509Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"projector\"\n },\n {\n \"content\": \"\",\n \"date\": \"2022-05-07T13:27:38.979985Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"screen\"\n }\n ],\n \"rtc_seconds\": 21,\n \"session_ended\": true,\n \"start_date\": \"2022-05-07T13:27:38.000000Z\",\n \"start_time\": \"2022-05-07T13:27:38.000000Z\",\n \"viewer_info\": {\n \"locations\": [\n \"*\"\n ],\n \"max_viewer_count\": 1,\n \"viewer_count\": 1\n },\n \"webcam_s\": 0\n },\n {\n \"duration\": 49,\n \"email\": \"joi+admin@crankwheel.com\",\n \"end_date\": \"2022-05-07T13:25:30.000000Z\",\n \"end_time\": \"2022-05-07T13:25:30.000000Z\",\n \"logs\": [\n {\n \"content\": \"\",\n \"date\": \"2022-05-07T13:25:18.980093Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"screen\"\n },\n {\n \"content\": \"36|HLS recording\",\n \"date\": \"2022-05-07T13:25:10.697551Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"projector\"\n },\n {\n \"content\": \"\",\n \"date\": \"2022-05-07T13:25:05.546827Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"screen\"\n },\n {\n \"content\": \"35|Older MP4 recording\",\n \"date\": \"2022-05-07T13:24:49.782575Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"projector\"\n },\n {\n \"content\": \"\",\n \"date\": \"2022-05-07T13:24:42.080847Z\",\n \"email\": \"joi+admin@crankwheel.com\",\n \"type\": \"screen\"\n }\n ],\n \"rtc_seconds\": 10,\n \"session_ended\": true,\n \"start_date\": \"2022-05-07T13:24:41.000000Z\",\n \"start_time\": \"2022-05-07T13:24:41.000000Z\",\n \"viewer_info\": {\n \"locations\": [\n \"*\"\n ],\n \"max_viewer_count\": 1,\n \"viewer_count\": 1\n },\n \"webcam_s\": 0\n }\n ],\n \"stats\": {\n \"total_count\": 4,\n \"total_sec\": 122,\n \"user_stats\": {\n \"joi+admin@crankwheel.com\": {\n \"total_count\": 4,\n \"total_sec\": 122\n }\n }\n }\n}"}],"_postman_id":"5f15c79e-6981-4f36-8d0b-6b5ae8c738a1"},{"name":"Video usage history","id":"d12a7e8e-bb4b-4c7f-8d3d-aadbc14c0b25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"{{server-url}}/ss/api/usage_shares?from=2020-11-23T00:00:00Z&to=2024-11-23T23:59:59Z","description":"

This retrieves video sharing usage history from your CrankWheel account (video shares only). It shows the number of new shares created in the specified period, and the number of times any shares created by the user (created in or outside the specified period) were played back in the given period.

Note the to and from query parameters which are timestamps.

The include_all_users query parameter is optional, defaults to false. When set to true, all registered users will be included in the usage report, even those with zero usage.

For authentication, set your own API key in your environment or paste it instead of {{crankwheel-api-key}} in the value for the Authorization header under the Headers tab.

\n","urlObject":{"path":["ss","api","usage_shares"],"host":["{{server-url}}"],"query":[{"key":"from","value":"2020-11-23T00:00:00Z"},{"key":"to","value":"2024-11-23T23:59:59Z"},{"disabled":true,"description":{"content":"

Optional, defaults to false. If true, show all users including those with 0 usage.

\n","type":"text/plain"},"key":"include_all_users","value":"true"}],"variable":[]}},"response":[{"id":"0ee00686-3f00-4e28-8d06-7fdcb50a0826","name":"Video usage history","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{server-url}}/ss/api/usage_shares?from=2020-11-23T00:00:00Z&to=2024-11-23T23:59:59Z","host":["{{server-url}}"],"path":["ss","api","usage_shares"],"query":[{"key":"from","value":"2020-11-23T00:00:00Z"},{"key":"to","value":"2024-11-23T23:59:59Z"},{"key":"include_all_users","value":"true","description":"Optional, defaults to false. If true, show all users including those with 0 usage.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.25.1"},{"key":"Date","value":"Fri, 24 May 2024 14:07:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1175"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F9I07I3--7GQ1WkAARwD"}],"cookie":[],"responseTime":null,"body":"{\n \"from\": \"2020-11-23T00:00:00Z\",\n \"include_all_users\": false,\n \"stats\": {\n \"by_user\": [\n {\n \"email\": \"example1@crankwheel.com\",\n \"name\": \"Example Oneson\",\n \"plays_count\": 617,\n \"shares_count\": 253\n },\n {\n \"email\": \"example2@crankwheel.com\",\n \"name\": \"Example Twomund\",\n \"plays_count\": 609,\n \"shares_count\": 59\n }\n ],\n \"total_plays\": 1226,\n \"total_shares\": 312\n },\n \"to\": \"2024-11-23T23:59:59Z\"\n}"},{"id":"e9973e12-556f-495c-b61c-a053740ca70f","name":"Video usage history all users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":{"raw":"{{server-url}}/ss/api/usage_shares?from=2020-11-23T00:00:00Z&to=2024-11-23T23:59:59Z&include_all_users=true","host":["{{server-url}}"],"path":["ss","api","usage_shares"],"query":[{"key":"from","value":"2020-11-23T00:00:00Z"},{"key":"to","value":"2024-11-23T23:59:59Z"},{"key":"include_all_users","value":"true","description":"Optional, defaults to false. If true, show all users including those with 0 usage."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.25.1"},{"key":"Date","value":"Fri, 24 May 2024 14:07:32 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1175"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F9I07I3--7GQ1WkAARwD"}],"cookie":[],"responseTime":null,"body":"{\n \"from\": \"2020-11-23T00:00:00Z\",\n \"include_all_users\": false,\n \"stats\": {\n \"by_user\": [\n {\n \"email\": \"example1@crankwheel.com\",\n \"name\": \"Example Oneson\",\n \"plays_count\": 617,\n \"shares_count\": 253\n },\n {\n \"email\": \"example2@crankwheel.com\",\n \"name\": \"Example Twomund\",\n \"plays_count\": 609,\n \"shares_count\": 59\n },\n {\n \"email\": \"example3@crankwheel.com\",\n \"name\": \"Example Threemaker\",\n \"plays_count\": 0,\n \"shares_count\": 0\n }\n ],\n \"total_plays\": 1226,\n \"total_shares\": 312\n },\n \"to\": \"2024-11-23T23:59:59Z\"\n}"}],"_postman_id":"d12a7e8e-bb4b-4c7f-8d3d-aadbc14c0b25"}],"id":"f94d1fa6-e6a4-48c4-82b5-51163aec2e31","description":"

This set of APIs lets you retrieve information on how CrankWheel is being used at your organization, including the full details of demo requests made via Instant Demos.

A read-only API key is sufficient for these APIs.

\n","event":[{"listen":"prerequest","script":{"id":"aa355ac0-ae42-418b-b801-78fccc0a8af8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1d5ec64f-ff68-4901-b152-cd11631b31fd","type":"text/javascript","exec":[""]}}],"_postman_id":"f94d1fa6-e6a4-48c4-82b5-51163aec2e31"},{"name":"User management","item":[{"name":"List company users","id":"565ed1f2-7be4-4917-8057-6544f1cc6fa7","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{server-url}}/ss/api/user_access","description":"

Retrieve a full list of all users in your company account. For each user, their email address, privilege level and whether they are in your pool of users handling demo requests is shown.

Possible values for privilege are:

user (a normal user of the system)
admin (a user who can invite others, change configuration of the company account, and more)
owner (an admin who is also the billing contact for the company)
reporting (a non-admin who has access to reporting functionality only)

Possible values for in_demo_pool are true, false and null which should be considered the same as false.

The users' email address is shown in the email attribute.

\n","urlObject":{"path":["ss","api","user_access"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"04e0a726-aaa7-4f9c-8ea4-528083de4d65","name":"List company users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":"https://meeting.is/ss/api/user_access"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Encoding","value":"gzip","name":"Content-Encoding","description":"The type of encoding used on the data."},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 16 Mar 2018 13:25:28 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"Transfer-Encoding","value":"chunked","name":"Transfer-Encoding","description":"The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."},{"key":"Vary","value":"Accept-Encoding","name":"Vary","description":"Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server."},{"key":"cache-control","value":"max-age=0, private, must-revalidate","name":"cache-control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"x-request-id","value":"1kgr59gach0qcppt06bod32l3ugenp0n","name":"x-request-id","description":"Custom header"}],"cookie":[{"expires":"Sat Mar 17 2018 13:24:56 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"meeting.is","path":"/","secure":true,"value":"QTEyOEdDTQ.c99FYUbFrp7ho67A9cZb1d50myYV3mp1Doam7dhv3cArOeJg8zrGaVc2GVo.TQqyIINAH5KKCHTL.l-AxrhOT8bbVkMUnus2eL-lQzxzx4NU12MdF-aQiQIN_sS048S2AYDumYu65GFiCbTPGm2liHh5VsON1QVrmQcpj_bkoNCdWt1_7vXi_-bpHncXArqw3YWUk2g8AgBD0ECVLnjqyeRyEcyVtSfdVCz-gLRnG4KoUco5xsQ.fzo2IGFUXp_wMbix-eajqg","key":"_ss_key"}],"responseTime":null,"body":"[{\"privilege\":\"owner\",\"in_demo_pool\":null,\"email\":\"joi@crankwheel.com\"},{\"privilege\":\"admin\",\"in_demo_pool\":true,\"email\":\"jane@crankwheel.com\"},{\"privilege\":\"user\",\"in_demo_pool\":false,\"email\":\"john@crankwheel.com\"}]"}],"_postman_id":"565ed1f2-7be4-4917-8057-6544f1cc6fa7"},{"name":"Show company user","id":"f8f48616-0307-4fce-98af-98cd99432608","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"url":"{{server-url}}/ss/api/user_access/:email","description":"

Retrieve a single user in your company account. Their email address, privilege level and whether they are in your pool of users handling demo requests is shown.

Possible values for privilege are:

user (a normal user of the system)
admin (a user who can invite others, change configuration of the company account, and more)
owner (an admin who is also the billing contact for the company)
reporting (a non-admin who has access to reporting functionality only)

Possible values for in_demo_pool are true, false and null which should be considered the same as false.

The users' email address is shown in the email attribute.

\n","urlObject":{"path":["ss","api","user_access",":email"],"host":["{{server-url}}"],"query":[],"variable":[{"type":"any","value":"user@example.com","key":"email"}]}},"response":[{"id":"b34aa319-ccff-4276-a0c2-58f7e7ebcb64","name":"Show company user","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","disabled":false}],"url":{"raw":"https://meeting.is/ss/api/user_access/:email","protocol":"https","host":["meeting","is"],"path":["ss","api","user_access",":email"],"variable":[{"key":"email","value":"user@example.com"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"77","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 16 Mar 2018 13:28:41 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Server","value":"nginx","name":"Server","description":"A name for the server"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains","name":"Strict-Transport-Security","description":"A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains."},{"key":"cache-control","value":"max-age=0, private, must-revalidate","name":"cache-control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"x-request-id","value":"u1rtetmsbfd824fo615cua3jtgt28q2n","name":"x-request-id","description":"Custom header"}],"cookie":[{"expires":"Sat Mar 17 2018 13:24:56 GMT+0000 (Coordinated Universal Time)","httpOnly":true,"domain":"meeting.is","path":"/","secure":true,"value":"QTEyOEdDTQ.c99FYUbFrp7ho67A9cZb1d50myYV3mp1Doam7dhv3cArOeJg8zrGaVc2GVo.TQqyIINAH5KKCHTL.l-AxrhOT8bbVkMUnus2eL-lQzxzx4NU12MdF-aQiQIN_sS048S2AYDumYu65GFiCbTPGm2liHh5VsON1QVrmQcpj_bkoNCdWt1_7vXi_-bpHncXArqw3YWUk2g8AgBD0ECVLnjqyeRyEcyVtSfdVCz-gLRnG4KoUco5xsQ.fzo2IGFUXp_wMbix-eajqg","key":"_ss_key"}],"responseTime":null,"body":"{\n \"privilege\": \"admin\",\n \"in_demo_pool\": true,\n \"email\": \"use@example.com\"\n}"}],"_postman_id":"f8f48616-0307-4fce-98af-98cd99432608"},{"name":"Create company user","id":"b1af1481-bf95-48f1-b4f8-c63d8f6fb133","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"user_access\":\n {\"email\": \"testaccount10@gmail.com\",\n \"privilege\": \"user\",\n \"send_onboarding_email\": \"false\"}}"},"url":"{{server-url}}/ss/api/user_access","description":"

Create a single new user in your company account.

POST with a form-data body with a single parameter user_access containing as a JSON object the user's email, privilege and in_demo_pool attributes as well as a send_onboarding_email attribute.

Possible values for privilege are:

user (a normal user of the system)
admin (a user who can invite others, change configuration of the company account, and more)
owner (an admin who is also the billing contact for the company)
reporting (a non-admin who has access to reporting functionality only)

Possible values for in_demo_pool are true and false.

The users' email address is set as the email attribute.

Note that you can also send an application/json body where the parameters above are wrapped in an object named user_access.

On a successful create, this endpoint will respond with a 201 Created response code, and the body of the response will be JSON showing the email, privilege and in_demo_pool attributes of the created user.

Note that \"creating\" a company user technically just lists their email as being allowed to access the company. The actual user account that stores their credentials and so on will only get created if they either click on the link in the email they receive if you set send_onboarding_email to true and choose a password, or if they initiate registration using the same email address and continue through to account creation. Feel free to email us at support@crankwheel.com if this is confusing.

\n","urlObject":{"path":["ss","api","user_access"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"117e57d3-d1ad-4bef-9986-0989af71c01f","name":"Create company user, email already taken (409 response)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"user_access\":\n {\"email\": \"joi@crankwheel.com\",\n \"privilege\": \"user\",\n \"in_demo_pool\": \"true\",\n \"send_onboarding_email\": \"false\",\n \"display_name\": \"John Doe\"}}"},"url":"{{server-url}}/ss/api/user_access"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Fri, 14 Jun 2019 15:39:13 GMT"},{"key":"content-length","value":"47"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"so98nsd03k2gvv34gf82d66e6jr2k52k"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": {\n \"email\": [\n \"has already been taken\"\n ]\n }\n}"},{"id":"b3cd5b9d-acba-4daa-8d4c-43d6fc2dcddf","name":"Create company user","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}","disabled":false},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://meeting.is/ss/api/user_access"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"max-age=0, private, must-revalidate","name":"cache-control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"content-length","value":"80","name":"content-length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"content-type","value":"application/json; charset=utf-8","name":"content-type","description":"The mime type of this content"},{"key":"date","value":"Fri, 16 Mar 2018 16:34:07 GMT","name":"date","description":"The date and time that the message was sent"},{"key":"server","value":"Cowboy","name":"server","description":"A name for the server"},{"key":"x-request-id","value":"e0a5n9lrq6mc80gcf0qp1qushdo9snjt","name":"x-request-id","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"{\"privilege\":\"user\",\"in_demo_pool\":true,\"email\":\"testaccount@example.com\"}"},{"id":"e8a954fa-0165-4634-8bfd-541b5c75eaa4","name":"Create company user","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"user_access\":\n {\"email\": \"testaccount3@example.com\",\n \"privilege\": \"user\",\n \"in_demo_pool\": \"true\",\n \"send_onboarding_email\": \"false\"}}"},"url":"{{server-url}}/ss/api/user_access"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2019 14:08:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"75"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"fcgfqphsp32bn698477k57hr6hfrao00"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"privilege\": \"user\",\n \"in_demo_pool\": true,\n \"email\": \"testaccount3@example.com\"\n}"}],"_postman_id":"b1af1481-bf95-48f1-b4f8-c63d8f6fb133"},{"name":"Update company user","id":"ee2b8c90-6a37-4c21-af4f-9cc3536de833","request":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"user_access\":\n {\n \t\"display_name\": \"Jói Sigurdsson\",\n \"headline\": \"Happy to help you out!\",\n \"picture_url\": \"booboo\"\n }\n}"},"url":"{{server-url}}/ss/api/user_access/:email","description":"

Update a single user in your company account.

PATCH with the email encoded in the URL, and form data for the user's privilege and in_demo_pool attributes, as shown in the example.

You can also set any part of the user's user profile (display_name, headline and picture_url). Any of these that you fail to set will be set to blank.

Possible values for privilege are:

user (a normal user of the system)
admin (a user who can invite others, change configuration of the company account, and more)
owner (an admin who is also the billing contact for the company)
reporting (a non-admin who has access to reporting functionality only)

Possible values for in_demo_pool are true and false.

Note that you can also send an application/json body where the parameters above are wrapped in a user_access object.

Responds with a 204 No Content response code on success, along with a JSON-encoded body showing the updated entry for the user.

\n","urlObject":{"path":["ss","api","user_access",":email"],"host":["{{server-url}}"],"query":[],"variable":[{"type":"string","value":"joi+admin@crankwheel.com","key":"email"}]}},"response":[{"id":"af997702-9b08-4b2b-a281-aa4267cf2c70","name":"Update company user","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"user_access\":\n {\n \"privilege\": \"admin\",\n \"in_demo_pool\": \"true\"\n }\n}"},"url":{"raw":"{{server-url}}/ss/api/user_access/:email","host":["{{server-url}}"],"path":["ss","api","user_access",":email"],"variable":[{"key":"email","value":"testaccount3@example.com"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2019 14:10:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"uvn14c84u1m26u5feg7ulv1goak0nebr"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"privilege\": \"admin\",\n \"in_demo_pool\": true,\n \"email\": \"testaccount3@example.com\"\n}"}],"_postman_id":"ee2b8c90-6a37-4c21-af4f-9cc3536de833"},{"name":"Delete company user","id":"601735c1-147d-4b85-bfd0-3157651f669c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{server-url}}/ss/api/user_access/:email","description":"

Removes a single email from the list of allowed emails on your company account. Note that this does not actually delete their user account, but they can no longer act as part of the company account.

Responds with 204 No Content on success, and a body of \"User access deleted successfully.\"

\n","urlObject":{"path":["ss","api","user_access",":email"],"host":["{{server-url}}"],"query":[],"variable":[{"type":"string","value":"testaccount3@example.com","key":"email"}]}},"response":[{"id":"9169e8bc-f699-4c84-b4f3-932520afbe15","name":"Delete company user","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}","disabled":false},{"key":"Content-Type","value":"application/x-www-form-urlencoded","disabled":false}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"https://meeting.is/ss/api/user_access/:email","protocol":"https","host":["meeting","is"],"path":["ss","api","user_access",":email"],"variable":[{"key":"email","value":"testaccount@example.com"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"cache-control","value":"max-age=0, private, must-revalidate","name":"cache-control","description":"Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"},{"key":"content-length","value":"35","name":"content-length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"content-type","value":"application/json; charset=utf-8","name":"content-type","description":"The mime type of this content"},{"key":"date","value":"Fri, 16 Mar 2018 16:41:12 GMT","name":"date","description":"The date and time that the message was sent"},{"key":"server","value":"Cowboy","name":"server","description":"A name for the server"},{"key":"x-request-id","value":"14kn36frjvtng9pcvvg36og771oppsr7","name":"x-request-id","description":"Custom header"}],"cookie":[],"responseTime":null,"body":"\"User access deleted successfully.\""}],"_postman_id":"601735c1-147d-4b85-bfd0-3157651f669c"}],"id":"774e53ed-58f0-4ff2-8aff-8e2eba1bf5de","description":"

This set of APIs lets you list, view, create, update and delete user accounts within your company account.

A read-only API key is sufficient for list and show. A read/write API key is required for create, update and delete.

\n","event":[{"listen":"prerequest","script":{"id":"3390e925-63e0-466f-8b67-378e570c027c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6ce35134-3cb6-462b-9aab-03d2fd70179f","type":"text/javascript","exec":[""]}}],"_postman_id":"774e53ed-58f0-4ff2-8aff-8e2eba1bf5de"},{"name":"Company Content","item":[{"name":"List company content","id":"90b2d667-9734-4ad9-a2f7-90b47d2c795e","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"body":{"mode":"formdata","formdata":[]},"url":"{{server-url}}/ss/api/company_content?from=2023-11-23T00:00:00Z&to=2023-11-23T23:59:00Z&view=active","description":"

Retrieve all company content items available in your company account that were created within a specified date range and that belong to an optional view (either \"active\" (default) or \"soft_deleted\").

For each item, details are shown as per the example given.

The types of content include \"upload\" (an external video uploaded to CrankWheel for storage and sharing), \"recording\" (a video recorded using CrankWheel, i.e. a meeting recording or a screencast recording), \"redirect\" (a post-session redirect URL) and \"cta\" (a call-to-action URL).

\n","urlObject":{"path":["ss","api","company_content"],"host":["{{server-url}}"],"query":[{"description":{"content":"

required

\n","type":"text/plain"},"key":"from","value":"2023-11-23T00:00:00Z"},{"description":{"content":"

required

\n","type":"text/plain"},"key":"to","value":"2023-11-23T23:59:00Z"},{"description":{"content":"

optional: Values can be either \"active\" or \"soft_deleted\"

\n","type":"text/plain"},"key":"view","value":"active"}],"variable":[]}},"response":[{"id":"ff62a7df-e34d-4384-9c6e-873083dfc2c8","name":"List company content","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"url":"{{server-url}}/ss/api/company_content"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.4"},{"key":"Date","value":"Sat, 07 May 2022 14:00:08 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2596"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"FuzXaNXoBkijYqwAADGB"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"created_by\": null,\n \"events\": [],\n \"id\": 8,\n \"name\": \"Stuff\",\n \"recorded_at\": null,\n \"runtime_ms\": 0,\n \"state\": null,\n \"tag\": null,\n \"type\": \"video\",\n \"url\": \"http://media.w3.org/2010/05/sintel/trailer.mp4\"\n },\n {\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [],\n \"id\": 28,\n \"name\": \"joi+admin@crankwheel.com 2022-3-24 7-51\",\n \"recorded_at\": \"2022-03-24T07:51:07Z\",\n \"runtime_ms\": 0,\n \"state\": \"created\",\n \"tag\": \"bfcfe45a-bf63-465e-b981-22e8a53afe82\",\n \"type\": \"recording\",\n \"url\": null\n },\n {\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [],\n \"id\": 29,\n \"name\": \"joi+admin@crankwheel.com 2022-3-24 7-54\",\n \"recorded_at\": \"2022-03-24T07:54:26Z\",\n \"runtime_ms\": 0,\n \"state\": \"ready\",\n \"tag\": \"2a8aa1e9-37ce-4bb7-a7f3-942117afc5ff\",\n \"type\": \"recording\",\n \"url\": null\n },\n {\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [],\n \"id\": 30,\n \"name\": \"joi+admin@crankwheel.com 2022-3-24 8-49\",\n \"recorded_at\": \"2022-03-24T08:49:40Z\",\n \"runtime_ms\": 0,\n \"state\": \"ready\",\n \"tag\": \"679ae6b6-1e29-445a-9a48-b64981dd2909\",\n \"type\": \"recording\",\n \"url\": null\n },\n {\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [],\n \"id\": 31,\n \"name\": \"joi+admin@crankwheel.com 2022-3-25 7-35\",\n \"recorded_at\": \"2022-03-25T07:35:00Z\",\n \"runtime_ms\": 0,\n \"state\": \"ready\",\n \"tag\": \"27cd40c2-83cf-4af8-beae-8936495692ae\",\n \"type\": \"recording\",\n \"url\": null\n },\n {\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [],\n \"id\": 32,\n \"name\": \"joi+admin@crankwheel.com 2022-3-25 10-25\",\n \"recorded_at\": \"2022-03-25T10:25:24Z\",\n \"runtime_ms\": 0,\n \"state\": \"ready\",\n \"tag\": \"f5ac9640-f094-4388-8b2f-56088f2e1a40\",\n \"type\": \"recording\",\n \"url\": null\n },\n {\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [\n {\n \"name\": \"started\",\n \"time\": 0\n },\n {\n \"name\": \"ended\",\n \"time\": 1183\n }\n ],\n \"id\": 34,\n \"name\": \"joi+admin@crankwheel.com 2022-5-7 13-14\",\n \"recorded_at\": \"2022-05-07T13:14:19Z\",\n \"runtime_ms\": 1183,\n \"state\": \"ready\",\n \"tag\": \"f586d69f-0de2-413c-a9da-861776fb0850\",\n \"type\": \"recording\",\n \"url\": null\n },\n {\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [\n {\n \"name\": \"started\",\n \"time\": 0\n },\n {\n \"name\": \"ended\",\n \"time\": 7046\n }\n ],\n \"id\": 35,\n \"name\": \"Older MP4 recording\",\n \"recorded_at\": \"2022-05-07T13:18:19Z\",\n \"runtime_ms\": 0,\n \"state\": \"ready\",\n \"tag\": \"8368059b-a79f-40f3-b9ec-b3bca220997e\",\n \"type\": \"recording\",\n \"url\": null\n },\n {\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [],\n \"id\": 33,\n \"name\": \"joi+admin@crankwheel.com 2022-3-29 9-36\",\n \"recorded_at\": \"2022-03-29T09:36:13Z\",\n \"runtime_ms\": 0,\n \"state\": \"ready\",\n \"tag\": \"8368059b-a79f-40f3-b9ec-b3bca220\",\n \"type\": \"recording\",\n \"url\": null\n },\n {\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [\n {\n \"name\": \"started\",\n \"time\": 0\n },\n {\n \"name\": \"ended\",\n \"time\": 4099\n }\n ],\n \"id\": 36,\n \"name\": \"HLS recording\",\n \"recorded_at\": \"2022-05-07T13:20:40Z\",\n \"runtime_ms\": 4099,\n \"state\": \"ready\",\n \"tag\": \"5bbcc79f-7c58-43d4-a274-e938741fa5b8\",\n \"type\": \"recording\",\n \"url\": null\n }\n]"}],"_postman_id":"90b2d667-9734-4ad9-a2f7-90b47d2c795e"},{"name":"Show company content","id":"d62028b0-3019-4ba2-b66f-00f7ff6ea0a1","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"url":"{{server-url}}/ss/api/company_content/:id","description":"

Show a single company content record.

The id parameter is as per the \"List company content\" API, or from a HATEOAS link in the \"New retrieve usage history\" API.

Most of the response fields are self-explanatory, see example response.

Further explanation as follows:

url will be set only if the company content is a link, in which case it will be the URL for the link
events contains a list of started/paused/resumed/ended events with relative timestamps in milliseconds from the start of the recording. This information along with the recorded_at timestamp (which we attempt to set as accurately as possible) is intended to be sufficient to sync the CrankWheel recording to external reecordings
state can be one of \"created\" (meaning it's created but has not started processing), \"processing\" (has been uploaded and is currently being transcoded) or \"ready\"

\n","urlObject":{"path":["ss","api","company_content",":id"],"host":["{{server-url}}"],"query":[],"variable":[{"type":"any","value":"37","key":"id"}]}},"response":[{"id":"5a44e815-a718-4fd4-a41c-4c1b25f92284","name":"Show company content","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"url":{"raw":"{{server-url}}/ss/api/company_content/:id","host":["{{server-url}}"],"path":["ss","api","company_content",":id"],"variable":[{"key":"id","value":"36"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.4"},{"key":"Date","value":"Sat, 07 May 2022 14:01:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"286"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"FuzXejXaKGhg-ygAAEVC"}],"cookie":[],"responseTime":null,"body":"{\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [\n {\n \"name\": \"started\",\n \"time\": 0\n },\n {\n \"name\": \"ended\",\n \"time\": 4099\n }\n ],\n \"id\": 36,\n \"name\": \"HLS recording\",\n \"recorded_at\": \"2022-05-07T13:20:40Z\",\n \"runtime_ms\": 4099,\n \"state\": \"ready\",\n \"tag\": \"5bbcc79f-7c58-43d4-a274-e938741fa5b8\",\n \"type\": \"recording\",\n \"url\": null\n}"}],"_postman_id":"d62028b0-3019-4ba2-b66f-00f7ff6ea0a1"},{"name":"Create company content (video upload)","id":"af75b1f9-2de9-4d84-8eee-51ae87f2d397","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"title\": \"Name of company content\", \"type\": \"upload\", \"created_by\": \"username@example.com\"}"},"url":"{{server-url}}/ss/api/company_content","description":"

Creates a company content video upload record.

The title parameter will be used as the human-readable name for the content.

The type parameter must be \"upload\".

The created_by parameter should be an email address, and must match an account registered for CrankWheel use or the API call will fail.

You will receive back a JSON object with details on the created record, including its id which you can then use with the Upload company content data API.

\n","urlObject":{"path":["ss","api","company_content"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"723d734b-17c3-4b97-8fd9-0d68d219a366","name":"Show company content","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"url":{"raw":"{{server-url}}/ss/api/company_content/:id","host":["{{server-url}}"],"path":["ss","api","company_content",":id"],"variable":[{"key":"id","value":"36"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.21.4"},{"key":"Date","value":"Sat, 07 May 2022 14:01:23 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"286"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"FuzXejXaKGhg-ygAAEVC"}],"cookie":[],"responseTime":null,"body":"{\n \"created_by\": \"joi+admin@crankwheel.com\",\n \"events\": [\n {\n \"name\": \"started\",\n \"time\": 0\n },\n {\n \"name\": \"ended\",\n \"time\": 4099\n }\n ],\n \"id\": 36,\n \"name\": \"HLS recording\",\n \"recorded_at\": \"2022-05-07T13:20:40Z\",\n \"runtime_ms\": 4099,\n \"state\": \"ready\",\n \"tag\": \"5bbcc79f-7c58-43d4-a274-e938741fa5b8\",\n \"type\": \"recording\",\n \"url\": null\n}"}],"_postman_id":"af75b1f9-2de9-4d84-8eee-51ae87f2d397"},{"name":"Download company content","id":"09cd1fab-d87d-4c27-81b9-a205b0cde987","request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"url":"{{server-url}}/ss/api/company_content/:id/data","description":"

Download a recording or uploaded video file, as an .mp4

The id parameter is as per the \"List company content\" API, or from a HATEOAS link in the \"New retrieve usage history\" API.

A successful response will have a status code of 200 OK, and the Content-Type header set to \"video/mp4; charset=utf-8\".

\n","urlObject":{"path":["ss","api","company_content",":id","data"],"host":["{{server-url}}"],"query":[],"variable":[{"type":"any","value":"975","key":"id"}]}},"response":[],"_postman_id":"09cd1fab-d87d-4c27-81b9-a205b0cde987"},{"name":"Upload company content data","id":"fbb81701-51c1-40b0-922c-6e009586ed80","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"body":{"mode":"formdata","formdata":[{"key":"data","type":"file","src":"/Users/joi/Downloads/Recording 2023-08-31 13-06.mp4"}]},"url":"{{server-url}}/ss/uploads/company_content/:id/data","description":"

Uploads the binary video file to be used for the company content upload file record with identifier id, previously created using the Create company content API.

\n","urlObject":{"path":["ss","uploads","company_content",":id","data"],"host":["{{server-url}}"],"query":[],"variable":[{"id":"6b001b62-1df7-462c-bf7c-4eaaa4efe5a5","type":"any","value":"975","key":"id"}]}},"response":[],"_postman_id":"fbb81701-51c1-40b0-922c-6e009586ed80"},{"name":"Upload external audio recording","id":"90abcb3b-ee5f-401c-9288-4bb2131e4c68","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}"}],"body":{"mode":"formdata","formdata":[{"key":"data","type":"file","src":"/private/tmp/call_recording.mp3"}]},"url":"{{server-url}}/ss/uploads/company_content/external_audio?agent_email=user@example.com&started_iso_extended_z=2023-08-13T13:48:01Z","description":"

Uploads an external audio recording, for example from your VoIP system, for a given agent (agent_email), with a given timestamp in extended UTC format, which should be accurate at least down to the second (started_iso_extended_z).

The uploaded recording should be uploaded as form-data under the key data, and the file should be in MP3 format.

If CrankWheel finds a session for the CrankWheel user identified by agent_email, with a CrankWheel recording that overlaps with the uploaded audio file, it will create a combined recording of the external audio and the native CrankWheel audio, and link to that recording from the original CrankWheel recording for the session.

If the original CrankWheel session includes an audio track (which it will if the agent allows access to their microphone), then the audio from the CrankWheel session will be used to correlate exactly with the audio from the external audio file, down to a few milliseconds accuracy, for perfect synchronization between the recordings.

If no relevant CrankWheel recording is found, the recording will simply be stored by CrankWheel.

\n","urlObject":{"path":["ss","uploads","company_content","external_audio"],"host":["{{server-url}}"],"query":[{"description":{"content":"

Should match the log-in email that the agent uses to log in to CrankWheel

\n","type":"text/plain"},"key":"agent_email","value":"user@example.com"},{"description":{"content":"

UTC timestamp

\n","type":"text/plain"},"key":"started_iso_extended_z","value":"2023-08-13T13:48:01Z"}],"variable":[]}},"response":[],"_postman_id":"90abcb3b-ee5f-401c-9288-4bb2131e4c68"},{"name":"Delete company content","id":"c6fb08a7-520e-424c-90c0-9f62bb2a12cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"}],"url":"{{server-url}}/ss/api/company_content/:id","description":"

Removes a single email from the list of allowed emails on your company account. Note that this does not actually delete their user account, but they can no longer act as part of the company account.

Responds with 204 No Content on success, and a body of \"User access deleted successfully.\"

\n","urlObject":{"path":["ss","api","company_content",":id"],"host":["{{server-url}}"],"query":[],"variable":[{"type":"any","value":"47755","key":"id"}]}},"response":[{"id":"c641fd79-22e1-44ce-bb56-13a11c23e590","name":"Delete company content","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"}],"body":{"mode":"formdata","formdata":[]},"url":{"raw":"{{server-url}}/ss/api/company_content/:id","host":["{{server-url}}"],"path":["ss","api","company_content",":id"],"variable":[{"key":"id","value":"28"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.21.4"},{"key":"Date","value":"Sat, 07 May 2022 14:02:53 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"FuzXjylgNyAMxX8AADSH"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c6fb08a7-520e-424c-90c0-9f62bb2a12cf"}],"id":"4bd4dad3-7301-4baf-83cb-58168ee0a941","description":"

This set of APIs lets you list, view, create, update and delete user accounts within your company account.

A read-only API key is sufficient for list and show. A read/write API key is required for create, update and delete.

\n","event":[{"listen":"prerequest","script":{"id":"3390e925-63e0-466f-8b67-378e570c027c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6ce35134-3cb6-462b-9aab-03d2fd70179f","type":"text/javascript","exec":[""]}}],"_postman_id":"4bd4dad3-7301-4baf-83cb-58168ee0a941"},{"name":"Sessions","item":[{"name":"Get public link","id":"d808cbc1-373c-4894-b4d2-db39a2b028b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"}],"url":"{{server-url}}/ss/api/public_link","description":"

Retrieves the public link for your account. This is the same for all presenters on the account, but may change from time to time (it is editable by administrators on your account).

\n","urlObject":{"path":["ss","api","public_link"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"9156d1f4-1106-4069-8355-2756db0dd644","name":"Get public link","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"}],"url":"{{server-url}}/ss/api/public_link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2019 14:11:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"ka3kh91o6cr8a4di82gq716j4nukerlq"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"public_link_url\": \"https://meeting.is/cw\"\n}"}],"_postman_id":"d808cbc1-373c-4894-b4d2-db39a2b028b2"},{"name":"Get all ongoing sessions","id":"35339a5d-be67-4b42-a4be-6e469d7fd163","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"}],"url":"{{server-url}}/ss/api/ongoing_sessions?hl=fr","description":"

Retrieves a list of all currently-ongoing sessions for your company, regardless of whether the sessions have a viewer connected or not.

Rather than the usual base DNS name for APIs, the DNS name of the request must be the same as the hostname that meeting links for the agent resolve to. To retrieve this DNS name, start a meeting as the agent, click 'Copy link' and paste it into a browser and hit Enter. Sometimes it will resolve to the usual DNS name, other times to something like 'us1.crankwheel.com'.

A successful request will receive a 200 OK response, and a body of JSON which is a list of sessions. Each session is an object with the following keys:

agent_email: The email address of the agent hosting the session.

session_id: The identifier of the session.

viewer_link: A link that could be used by a viewer to join the session without further authentication. The link's hl parameter will match whatever hl parameter you pass as a query parameter when calling this API, and will default to \"en\" if you pass no such parameter.

\n","urlObject":{"path":["ss","api","ongoing_sessions"],"host":["{{server-url}}"],"query":[{"description":{"content":"

Defaults to \"en\" if not present

\n","type":"text/plain"},"key":"hl","value":"fr"}],"variable":[]}},"response":[{"id":"67cb79b8-cafb-4c03-859c-e4af7bc87bad","name":"Get public link","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"}],"url":"{{server-url}}/ss/api/public_link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2019 14:11:20 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"43"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"ka3kh91o6cr8a4di82gq716j4nukerlq"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"public_link_url\": \"https://meeting.is/cw\"\n}"},{"id":"ddaff911-b104-49a2-93c2-f65fa0ce08fa","name":"Two sessions ongoing","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"}],"url":{"raw":"{{server-url}}/ss/api/ongoing_sessions?hl=fr","host":["{{server-url}}"],"path":["ss","api","ongoing_sessions"],"query":[{"key":"hl","value":"fr","description":"Defaults to \"en\" if not present"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.25.1"},{"key":"Date","value":"Sat, 27 Jan 2024 12:59:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"288"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F641qOSh7g6OX7AAAFkD"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"agent_email\": \"agent1@example.com,\n \"session_id\": \"i1GSMp6evna-\",\n \"viewer_link\": \"https://us1.crankwheel.com/demo?hl=fr&c=i1GSMp6evna-\"\n },\n {\n \"agent_email\": \"agent2@example.com\",\n \"session_id\": \"lawf_X8_dx0c\",\n \"viewer_link\": \"https://us1.crankwheel.com/demo?hl=fr&c=lawf_X8_dx0c\"\n }\n]"}],"_postman_id":"35339a5d-be67-4b42-a4be-6e469d7fd163"},{"name":"Create scheduled meeting link","id":"2e3b21f1-92c1-4978-956a-fdcb00e13167","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"name\": \"Meeting Name\", \"email\": \"testaccount3@example.com\", \"audio\": \"call\"}"},"url":"{{server-url}}/ss/api/schedule_meeting","description":"

This has the same effect as the \"Schedule a Meeting\" button in a presenter's user interface.

It returns the URL for the meeting, as well as a list of dial-in phone numbers (if phone conferencing is set) and the raw ID of the meeting (useful only to build URLs).

Audio parameter

With the inclusion of web based audio you can specify the audio channel you wish to use for the meeting. call is the default value if none is specified, referring to a standard phone call. conference refers to the use of phone conferencing and web refers to the use of CrankWheel's web based audio feature, handling the audio in the browser.

\n","urlObject":{"path":["ss","api","schedule_meeting"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"ea601e2e-83c2-4af1-a37a-4c3ffaf969a7","name":"Create scheduled meeting link","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"name\": \"Meeting Name\", \"email\": \"testaccount3@example.com\", \"audio\": \"call\"}"},"url":"{{server-url}}/ss/api/schedule_meeting"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 27 Mar 2019 14:11:59 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"mcmsaq2qmge5smn5peah8r7mrcjvb4kg"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://meeting.is/cw?hl=en&c=2TY9DUKyFes\",\n \"uid\": \"2TY9DUKyFes\",\n \"numbers\": \"Australia: 02-89990964\\nAustria: 0820-400600\\nCanada: 1-647-503-4016\\nChina: 010-53876269\\nFrance: 0825-000328\\nGermany: 01803-127127\\nHong Kong: 3018-4589\\nIceland: 539-0601\\nIndonesia: 0855-7467-0764\\nIreland: 1520-932995\\nNetherlands: 0900-1998\\nNew Zealand: 09-9518334\\nRussia: 499-7043569\\nSingapore: 3138-9320\\nSouth Africa: 087-2318992\\nSpain: 902-559217\\nSwitzerland (german): 0840-444888\\nUK: 0843 373 0843\\nUK (mobile): 83000\\nUSA: 1-213-603-9096\\n\"\n}"}],"_postman_id":"2e3b21f1-92c1-4978-956a-fdcb00e13167"},{"name":"Create noauth link","id":"aaab899b-c305-43ad-9be5-496e39642356","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"email\": \"testaccount444@example.com\", \"within_seconds\": \"30\"}"},"url":"{{server-url}}/ss/api/make_noauth_link","description":"

A noauth link is valid, without further authentication, to join a session that is started in the timeframe between the moment the API request is processed, and the time within_seconds seconds after that.

As of March 27th 2022, a noauth link is bound to the first session joined using the link, after which it cannot be used to join any other session without authentication even if the other session is also started within the number of seconds specified in the API request.

For sessions started outside of the timeframe described in the first paragraph, as well as for any session other than the session that the link has been tightly bound to (if it has previously been used to join a session), a noauth link works just like any older link (scheduled or instant) in that it will require the viewer to tell the presenter a number, and for the presenter to accept the viewer by clicking a button next to that number in their list of waiting viewers (in the background, this is a security handshake based on a large, cryptographically-generated shared secret).

The parameter truncate_older_links is optional and defaults to false, meaning that older noauth links will be left unchanged when generating a new noauth link. As of March 27th 2022, if this parameter is set to true, this will trigger the behavior that any older noauth link for the given email address will have its last moment of validity set to the moment this API call is processed, if and only if its previous stored validity would have extended until after that moment. Consistently using this parameter avoids the possibility of overlap in the validity intervals of noauth links.

One other API (the \"Delete meeting link\" API) accepts a uid parameter. The uid of the noauth link is the value of the c= parameter returned in the noauth URL, when successful.

You may delete previously-generated noauth links by using the \"Delete meeting link\" API. This goes further than making them revert to requiring authentication and instead makes them not work at all. Viewers will see a message similar to \"The presenter has stopped sharing their screen\" if they try to use a deleted link.

The parameter create_hook is optional and defaults to the empty string (which means, do nothing). If specified, this string should be an https URL that CrankWheel will make a GET request to, when a session is created for this noauth link.

The parameter viewer_hook is optional and defaults to the empty string (which means, do nothing). If specified, this string should be an https URL that CrankWheel will make a GET request to, when the first viewer joins the session created for this noauth link.

\n","urlObject":{"path":["ss","api","make_noauth_link"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"349db4d3-c408-49aa-b06b-4197698c3fb5","name":"Create noauth link","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"email\": \"example@acme.com\", \"within_seconds\": \"30\"}"},"url":"{{server-url}}/ss/api/make_noauth_link"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 03 Mar 2019 14:45:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"qfv6v1fjpiqso86tcjl4gu4ij2hnj615"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\n \"url\": \"https://meeting.is/acme?hl=en&c=3-Aqer24hRs=\"\n}"}],"_postman_id":"aaab899b-c305-43ad-9be5-496e39642356"},{"name":"Set post-meeting URL","id":"f4502712-a867-4929-ab8a-0a9d277ea2f7","request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"email\": \"user@example.com\", \"url\": \"https://nike.com\"}"},"url":"{{server-url}}/ss/api/post_session_redirect","description":"

This API sets the post-session URL (the URL that viewers are redirected to at the end of a session) for the current ongoing session hosted by a given agent.

Parameter email should be the email address that the agent in question uses as their log-in identifier to CrankWheel.

Parameter url, should be a URL starting with http:// or https://.

The API will look for that agent's current session, and set the post-session URL for the session to the specified URL (which does not need to be pre-configured as one of the available URLs for the agent to choose from the list in our control panel for the session).

If parameters are valid and an ongoing session is found for the agent, you will get a 200 response code.

If either parameter is invalid, you will get a 400 response code.

If the provided agent email is not for an agent who is part of your company, you will get a 403 response code.

If you provided a valid agent email but there is no ongoing session for the agent, you will get a 404 response code.

For any other error you will get a 500 resposne code.

\n","urlObject":{"path":["ss","api","post_session_redirect"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"1cefee4a-c829-40a4-b7ae-1723f4912db7","name":"Not found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"email\": \"testaccount444@example.com\", \"within_seconds\": \"30\"}"},"url":{"raw":"{{server-url}}/ss/api/post_session_redirect?email=joi+admin@crankwheel.com&url=https://nike.com/","host":["{{server-url}}"],"path":["ss","api","post_session_redirect"],"query":[{"key":"email","value":"joi+admin@crankwheel.com"},{"key":"url","value":"https://nike.com/"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 19 Nov 2023 08:22:02 GMT"},{"key":"Content-Length","value":"64"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5j4h-1ZJrQeQs8ADSgB"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"Error setting post session url - no session found for that agent"},{"id":"d92c0c36-aa7a-483f-b365-ce8c3cca8625","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"email\": \"user@example.com\", \"url\": \"https://nike.com\"}"},"url":"{{server-url}}/ss/api/post_session_redirect"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Sun, 19 Nov 2023 08:34:49 GMT"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"F5j5OpU2sBNhqoUAAAaB"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"Ok"}],"_postman_id":"f4502712-a867-4929-ab8a-0a9d277ea2f7"},{"name":"Delete meeting link","id":"20bd9d78-0dc2-47f3-a802-bec44942a656","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"}],"body":{"mode":"raw","raw":""},"url":"{{server-url}}/ss/api/schedule_meeting/:uid","description":"

This deletes a previously created link based on its uid.

Returns either 200 with a message, or 404 if the link does not exist; see examples.

\n","urlObject":{"path":["ss","api","schedule_meeting",":uid"],"host":["{{server-url}}"],"query":[],"variable":[{"type":"any","value":"nonexistent","key":"uid"}]}},"response":[{"id":"387526a1-fb81-4fd3-9994-e636d4b01787","name":"Delete scheduled meeting link, link exists","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{server-url}}/ss/api/schedule_meeting/:uid","host":["{{server-url}}"],"path":["ss","api","schedule_meeting",":uid"],"variable":[{"key":"uid","value":"qTHEKBsRxRA"}]}},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Oct 2021 11:51:37 GMT"},{"key":"Content-Length","value":"40"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"FrIvjSOjSFachr0AAALi"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\"message\":\"Meeting deleted succesfuly\"}"},{"id":"a3abed5b-6ff3-4a88-b7aa-ede67c595543","name":"Delete scheduled meeting link, uid nonexistent","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{server-url}}/ss/api/schedule_meeting/:uid","host":["{{server-url}}"],"path":["ss","api","schedule_meeting",":uid"],"variable":[{"key":"uid","value":"nonexistent"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Thu, 28 Oct 2021 11:52:27 GMT"},{"key":"Content-Length","value":"29"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"FrIvmLXIiEsJGboAAANC"},{"key":"Strict-Transport-Security","value":"max-age=15768000; includeSubDomains"}],"cookie":[],"responseTime":null,"body":"{\"error\":\"Meeting not found\"}"}],"_postman_id":"20bd9d78-0dc2-47f3-a802-bec44942a656"}],"id":"78d1474f-a00b-44b7-b709-8a01f918ea53","description":"

Generate links for meetings

\n","_postman_id":"78d1474f-a00b-44b7-b709-8a01f918ea53"},{"name":"Instant Demos","item":[{"name":"Get Instant Demo Details","id":"51b4a71e-fd5d-4fbc-aba5-615f621959bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"}],"url":"{{server-url}}/ss/api/demo_info","description":"

Retrieves details on whether Instant Demos are enabled on the account, and if so, the JavaScript snippet to use, the URL for email campaigns, the URL for links on a website (where the JavaScript snippet is also present), and the demo ID for advanced applications.

\n","urlObject":{"path":["ss","api","demo_info"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"1bdbc3a2-b6c0-4044-885f-6b3be60fb04f","name":"Get Instant Demo Details","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"}],"url":"{{server-url}}/ss/api/demo_info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Sat, 09 Mar 2019 10:09:07 GMT"},{"key":"content-length","value":"768"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"ivtv9me007tic7dvaqhptu276altukuv"}],"cookie":[],"responseTime":null,"body":"{\n \"website_url\": \"https://meeting.is/ss/showu/cw#crankwheel-com-showu-launch-button\",\n \"js_snippet\": \"(function(i,c,a,n,s,h,o,w,u){if(typeof i.showu === 'object'){i.showu.reInitialize()}else{i.showu = {'_q':[]}; i._ishowuSettings={id:'DT66biLU',d:a}; s=c.getElementsByTagName('head')[0];h=c.createElement('script');h.async=1; h.type = 'text/javascript'; h.src=a+n; s.appendChild(h);o = ['launch', 'onEvent', 'getCapacity', 'populateFields', 'reInitialize']; function p(f) {i.showu[f] = function(){i.showu._q.push([f].concat(Array.prototype.slice.call(arguments, 0)));};} for (w = 0; w < o.length; w++) {p(o[w]);}}})(window,document,'https://meeting.is','/ss/js/showu_app.js')\",\n \"is_enabled\": true,\n \"email_campaign_url\": \"https://meeting.is/ss/showu/cw\",\n \"demo_id\": \"DT66biLU\"\n}"}],"_postman_id":"51b4a71e-fd5d-4fbc-aba5-615f621959bf"},{"name":"Enable Instant Demos","id":"05133b58-0c08-4504-ab32-f5bccf1a8892","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}","type":"text"}],"url":"{{server-url}}/ss/api/demo_enable","description":"

Calling this API enables Instant Demos on your account, and returns an object with status set to enabled (unless something went wrong) and was_previously_enabled set to true if the feature was already enabled, false if it was turned on just now.

\n","urlObject":{"path":["ss","api","demo_enable"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"2e134fab-31ec-4607-bb16-ecb7dd455e42","name":"Enable Instant Demos","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}","type":"text"}],"url":"{{server-url}}/ss/api/demo_enable"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Sat, 09 Mar 2019 09:34:58 GMT"},{"key":"content-length","value":"50"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"gn7312au62emouh68d0qf8ddhk7e19bv"}],"cookie":[],"responseTime":null,"body":"{\n \"was_previously_enabled\": true,\n \"status\": \"enabled\"\n}"}],"_postman_id":"05133b58-0c08-4504-ab32-f5bccf1a8892"}],"id":"d916f185-946b-42ab-afc2-86cca9aee960","event":[{"listen":"prerequest","script":{"id":"b37291b6-e725-4bae-871b-a0242db2f700","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fd09f920-bc8e-46a4-997a-d38ba48ae319","type":"text/javascript","exec":[""]}}],"_postman_id":"d916f185-946b-42ab-afc2-86cca9aee960","description":""},{"name":"Integrations","item":[{"name":"List API keys","id":"3c379a5a-3d6f-4311-8343-5c3df03ed229","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"}],"url":"{{server-url}}/ss/api/api_access","description":"

Lists the API tokens on your company

\n","urlObject":{"path":["ss","api","api_access"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"5ae65385-2039-4c20-8a06-b4643bfe092f","name":"List API keys","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"}],"url":"{{server-url}}/ss/api/api_access"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 09 Apr 2019 14:03:18 GMT"},{"key":"content-length","value":"323"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"14q5ddaqigpseq1j0piigrm7jigoggg3"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"write\": false,\n \"key\": \"NLBMmGd8my-7njNjcrGBBmvSKstO402GgvcY8lbJ\"\n },\n {\n \"write\": true,\n \"key\": \"068Y_yRRM5Jl-bR9HaLGJiJkMITQVZsNeMc-DD_1\"\n }\n]"}],"_postman_id":"3c379a5a-3d6f-4311-8343-5c3df03ed229"},{"name":"Create new API key","id":"68c0fee4-98c5-421e-8397-f8f42d72f0a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":"{{server-url}}/ss/api/api_access?write_access=true","description":"

The write_access parameter is mandatory and must be either true (for a read/write key) or false (for a read-only key).

\n","urlObject":{"path":["ss","api","api_access"],"host":["{{server-url}}"],"query":[{"key":"write_access","value":"true"}],"variable":[]}},"response":[{"id":"65b70742-b21b-4192-9240-bc3501774adf","name":"Create new API key","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{server-url}}/ss/api/api_access?write_access=true","host":["{{server-url}}"],"path":["ss","api","api_access"],"query":[{"key":"write_access","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 09 Apr 2019 14:02:47 GMT"},{"key":"content-length","value":"63"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"0kgl88tvh5jublla3r79tgg7scemq7ri"}],"cookie":[],"responseTime":null,"body":"{\n \"write\": true,\n \"key\": \"068Y_yRRM5Jl-bR9HaLGJiJkMITQVZsNeMc-DD_1\"\n}"}],"_postman_id":"68c0fee4-98c5-421e-8397-f8f42d72f0a3"},{"name":"Delete API key","id":"1d79fdad-97e7-48f8-b22a-bc55fafd4c20","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Basic {{crankwheel-api-key-readwrite}}"}],"url":"{{server-url}}/ss/api/api_access/:key","urlObject":{"path":["ss","api","api_access",":key"],"host":["{{server-url}}"],"query":[],"variable":[{"type":"string","value":"068Y_yRRM5Jl-bR9HaLGJiJkMITQVZsNeMc-DD_1","key":"key"}]}},"response":[{"id":"df073a5d-960f-4dbd-ab84-e6970c6605f4","name":"Delete API key","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Basic {{crankwheel-api-key-readwrite}}"}],"url":{"raw":"{{server-url}}/ss/api/api_access/:key","host":["{{server-url}}"],"path":["ss","api","api_access",":key"],"variable":[{"key":"key","value":"068Y_yRRM5Jl-bR9HaLGJiJkMITQVZsNeMc-DD_1"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Tue, 09 Apr 2019 14:03:02 GMT"},{"key":"content-length","value":"9"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"2ujm1pgjc4hoo9nvdj5or6gajluhk54o"}],"cookie":[],"responseTime":null,"body":"\"deleted\""}],"_postman_id":"1d79fdad-97e7-48f8-b22a-bc55fafd4c20"},{"name":"List webhooks","id":"5fcdb35f-6073-400c-ad9b-90e78a2f50d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic {{crankwheel-api-key}}"}],"url":"{{server-url}}/ss/api/webhooks","description":"

Lists the web hooks configured for your company

\n","urlObject":{"path":["ss","api","webhooks"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"b205150e-f6f5-4feb-89db-671a0b066ddc","name":"List webhooks","originalRequest":{"method":"GET","header":[{"key":"Authorization","type":"text","value":"Basic {{crankwheel-api-key}}"}],"url":"{{server-url}}/ss/api/webhooks"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Wed, 10 Apr 2019 10:57:44 GMT"},{"key":"content-length","value":"89"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"vuko0uq6iai1ibffktmshbgv2aulhfsl"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"url\": \"http://requestbin.fullcontact.com/1chj0rs1\",\n \"id\": 10,\n \"access_token\": \"woof woof\"\n }\n]"}],"_postman_id":"5fcdb35f-6073-400c-ad9b-90e78a2f50d4"},{"name":"Add webhook","id":"1e2b858a-3200-4c56-aed9-026a657b859d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"url\": \"http://requestbin.fullcontact.com/1chj0rs1\", \"access_token\": \"woof woof\"}"},"url":"{{server-url}}/ss/api/webhooks","description":"

Lists the web hooks configured for your company

\n","urlObject":{"path":["ss","api","webhooks"],"host":["{{server-url}}"],"query":[],"variable":[]}},"response":[{"id":"41d80324-5d14-4b70-b1e6-7ffbac1b9c93","name":"Add webhook","originalRequest":{"method":"POST","header":[{"key":"Authorization","type":"text","value":"Basic {{crankwheel-api-key-readwrite}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"url\": \"http://requestbin.fullcontact.com/1chj0rs1\", \"access_token\": \"woof woof\"}"},"url":"{{server-url}}/ss/api/webhooks"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Wed, 10 Apr 2019 11:10:48 GMT"},{"key":"content-length","value":"16"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"lvrgibgkhij4d03o85830gm61n5h56sk"}],"cookie":[],"responseTime":null,"body":"\"Added webhook.\""}],"_postman_id":"1e2b858a-3200-4c56-aed9-026a657b859d"},{"name":"Delete webhook","id":"9ad4c0f5-de5b-4f16-8d1c-2ff1769c32e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Basic {{crankwheel-api-key-readwrite}}"}],"url":"{{server-url}}/ss/api/webhooks/:id","description":"

Delete a webhook by ID.

\n","urlObject":{"path":["ss","api","webhooks",":id"],"host":["{{server-url}}"],"query":[],"variable":[{"type":"string","value":"10","key":"id"}]}},"response":[{"id":"fa31e486-78b3-4b89-8bcd-23658f81058b","name":"Delete webhook","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Basic {{crankwheel-api-key-readwrite}}"}],"body":{"mode":"raw","raw":""},"url":{"raw":"{{server-url}}/ss/api/webhooks/:id","host":["{{server-url}}"],"path":["ss","api","webhooks",":id"],"variable":[{"key":"id","value":"10"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"server","value":"Cowboy"},{"key":"date","value":"Wed, 10 Apr 2019 10:59:23 GMT"},{"key":"content-length","value":"31"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"crc3o1t6hcbku3nf9mc8vrbhpdf3hh4o"}],"cookie":[],"responseTime":null,"body":"\"Webhook deleted successfully.\""}],"_postman_id":"9ad4c0f5-de5b-4f16-8d1c-2ff1769c32e9"}],"id":"630f165b-e4ef-4d16-b8cb-aaa9f78581a3","_postman_id":"630f165b-e4ef-4d16-b8cb-aaa9f78581a3","description":""},{"name":"Video Shares","item":[{"name":"List Shares (with Engagement)","id":"eec62230-9ea6-4c9a-9ce1-87dcdec97d84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{server-url}}/ss/api/company_content/shares?from=2026-01-01T00:00:00Z&to=2026-04-22T23:59:59Z&page=1&page_size=25","description":"

Returns a paginated list of shares with engagement data (visits, plays, CTA clicks, engagement score) for the authenticated company.

Response:

{\n  \"data\": [\n    {\n      \"slug\": \"abc123\",\n      \"visits\": 10,\n      \"plays\": 7,\n      \"avg_percent_watched\": 0.85,\n      \"cta_clicks\": 3,\n      \"has_cta\": true,\n      \"engagement_score_v1\": 72.5\n    }\n  ],\n  \"pagination\": {\n    \"page\": 1,\n    \"page_size\": 25,\n    \"total\": 42\n  },\n  \"from\": \"2026-01-01T00:00:00Z\",\n  \"to\": \"2026-04-22T23:59:59Z\"\n}\n

\n","urlObject":{"path":["ss","api","company_content","shares"],"host":["{{server-url}}"],"query":[{"description":{"content":"

Optional. Start of date range (ISO 8601). Defaults to 29 days ago.

\n","type":"text/plain"},"key":"from","value":"2026-01-01T00:00:00Z"},{"description":{"content":"

Optional. End of date range (ISO 8601). Defaults to now.

\n","type":"text/plain"},"key":"to","value":"2026-04-22T23:59:59Z"},{"description":{"content":"

Optional. Page number (default: 1)

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Optional. Results per page (default: 25)

\n","type":"text/plain"},"key":"page_size","value":"25"},{"disabled":true,"description":{"content":"

Optional. Filter by creator email

\n","type":"text/plain"},"key":"created_by","value":""},{"disabled":true,"description":{"content":"

Optional. Set to 'true' to include inactive shares

\n","type":"text/plain"},"key":"inactive","value":"true"}],"variable":[]}},"response":[{"id":"b257d260-31f3-46af-a14d-29916bba4921","name":"List Shares (with Engagement)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{server-url}}/ss/api/company_content/shares?from=2026-01-01T00:00:00Z&to=2026-04-22T23:59:59Z&page=1&page_size=25","host":["{{server-url}}"],"path":["ss","api","company_content","shares"],"query":[{"key":"from","value":"2026-01-01T00:00:00Z","description":"Optional. Start of date range (ISO 8601). Defaults to 29 days ago."},{"key":"to","value":"2026-04-22T23:59:59Z","description":"Optional. End of date range (ISO 8601). Defaults to now."},{"key":"page","value":"1","description":"Optional. Page number (default: 1)"},{"key":"page_size","value":"25","description":"Optional. Results per page (default: 25)"},{"key":"created_by","value":"","description":"Optional. Filter by creator email","disabled":true},{"key":"inactive","value":"true","description":"Optional. Set to 'true' to include inactive shares","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Date","value":"Wed, 22 Apr 2026 16:43:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"489"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GKi7gKUAJNKX6W4AAAsC"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"data\": [\n {\n \"avg_percent_watched\": 0,\n \"company_content_id\": 1038,\n \"content_name\": \"example@crankwheel.com 2022-6-8 11-10\",\n \"created_at\": \"2022-07-17T09:47:58.000000Z\",\n \"created_by_email\": \"example@crankwheel.com\",\n \"created_by_name\": \"John Doe\",\n \"cta_clicks\": 0,\n \"engagement_score_v1\": 10,\n \"has_cta\": false,\n \"plays\": 0,\n \"segment\": null,\n \"slug\": \"d6a55fc8-dac1-4b2c-8d6a-652d5804f88f\",\n \"visits\": 1\n }\n ],\n \"from\": \"2026-01-01T00:00:00Z\",\n \"pagination\": {\n \"page\": 1,\n \"page_size\": 25,\n \"total\": 1\n },\n \"to\": \"2026-04-22T23:59:59Z\"\n}"}],"_postman_id":"eec62230-9ea6-4c9a-9ce1-87dcdec97d84"},{"name":"Share Detail (with Engagement)","id":"a35fa81f-60b2-4c4a-8e27-4789fde7b92f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{server-url}}/ss/api/company_content/shares/:slug?from=2026-01-01T00:00:00Z&to=2026-04-22T23:59:59Z","description":"

Returns detailed engagement data for a single share, including per-session breakdown and engagement score.

Response:

{\n  \"slug\": \"abc123\",\n  \"segment\": \"demo-video\",\n  \"has_cta\": true,\n  \"content_runtime_ms\": 225000,\n  \"summary\": {\n    \"total_visits\": 10,\n    \"total_plays\": 7,\n    \"avg_percent_watched\": 0.85,\n    \"cta_clicks\": 3,\n    \"engagement_score_v1\": 72.5\n  },\n  \"sessions\": [\n    { ... }\n  ]\n}\n

\n","urlObject":{"path":["ss","api","company_content","shares",":slug"],"host":["{{server-url}}"],"query":[{"description":{"content":"

Optional. Start of date range (ISO 8601). Omit for all-time.

\n","type":"text/plain"},"key":"from","value":"2026-01-01T00:00:00Z"},{"description":{"content":"

Optional. End of date range (ISO 8601). Omit for all-time.

\n","type":"text/plain"},"key":"to","value":"2026-04-22T23:59:59Z"}],"variable":[{"description":{"content":"

The share slug identifier

\n","type":"text/plain"},"type":"any","value":"d6a55fc8-dac1-4b2c-8d6a-652d5804f88f","key":"slug"}]}},"response":[{"id":"d6a15e78-5f8f-4e4b-832f-1fea7a212dfd","name":"Share Detail (with Engagement)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key-readwrite}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{server-url}}/ss/api/company_content/shares/:slug?from=2026-01-01T00:00:00Z&to=2026-04-22T23:59:59Z","host":["{{server-url}}"],"path":["ss","api","company_content","shares",":slug"],"query":[{"key":"from","value":"2026-01-01T00:00:00Z","description":"Optional. Start of date range (ISO 8601). Omit for all-time."},{"key":"to","value":"2026-04-22T23:59:59Z","description":"Optional. End of date range (ISO 8601). Omit for all-time."}],"variable":[{"key":"slug","value":"d6a55fc8-dac1-4b2c-8d6a-652d5804f88f","description":"The share slug identifier"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Date","value":"Wed, 22 Apr 2026 16:44:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"413"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GKi7jNkBtxqD9pIAAApD"}],"cookie":[],"responseTime":null,"body":"{\n \"content_runtime_ms\": 1606,\n \"has_cta\": false,\n \"segment\": null,\n \"sessions\": [\n {\n \"cta_clicked\": false,\n \"percent_watched\": 0,\n \"played\": false,\n \"visit_id\": \"a34301e3a7448887\",\n \"visited_at\": \"2026-03-27T15:12:05.000000Z\",\n \"watch_time_sec\": 0\n }\n ],\n \"slug\": \"d6a55fc8-dac1-4b2c-8d6a-652d5804f88f\",\n \"summary\": {\n \"avg_percent_watched\": 0,\n \"avg_watch_time_ms\": 0,\n \"cta_clicks\": 0,\n \"engagement_score_v1\": 10,\n \"play_rate\": 0,\n \"total_plays\": 0,\n \"total_visits\": 1\n }\n}"}],"_postman_id":"a35fa81f-60b2-4c4a-8e27-4789fde7b92f"},{"name":"Share Details (with CRM Details)","id":"b26ae302-51c2-4a48-8f70-08b6812d965f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{server-url}}/ss/api/share_details?from=2026-01-01T00:00:00Z&to=2026-04-22T23:59:59Z","description":"

Returns share details for the authenticated company within a date range. Both from and to are required.

Response:

{\n  \"shares\": [\n    {\n      \"id\": 123,\n      \"created_at\": \"2026-03-15T10:30:00Z\",\n      \"customer_account_id\": \"ACCT-001\",\n      \"content_created_by\": \"agent@example.com\",\n      \"content_recorded_at\": \"2026-03-14T09:00:00Z\",\n      \"content_runtime\": \"00:03:45\",\n      \"video_url\": \"https://server/ss/share/abc123\",\n      \"access_sharing_enabled\": true\n    }\n  ]\n}\n

\n","urlObject":{"path":["ss","api","share_details"],"host":["{{server-url}}"],"query":[{"description":{"content":"

Required. Start of date range (ISO 8601)

\n","type":"text/plain"},"key":"from","value":"2026-01-01T00:00:00Z"},{"description":{"content":"

Required. End of date range (ISO 8601)

\n","type":"text/plain"},"key":"to","value":"2026-04-22T23:59:59Z"}],"variable":[]}},"response":[{"id":"d70a7357-a6cf-42f0-a32a-4bbb171e43ba","name":"Share Details (with CRM Details)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Basic {{crankwheel-api-key}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{server-url}}/ss/api/share_details?from=2026-01-01T00:00:00Z&to=2026-04-22T23:59:59Z","host":["{{server-url}}"],"path":["ss","api","share_details"],"query":[{"key":"from","value":"2026-01-01T00:00:00Z"},{"key":"to","value":"2026-04-22T23:59:59Z"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[{"key":"Server","value":"nginx/1.27.5"},{"key":"Date","value":"Wed, 22 Apr 2026 16:48:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"1792"},{"key":"Connection","value":"keep-alive"},{"key":"cache-control","value":"max-age=0, private, must-revalidate"},{"key":"x-request-id","value":"GKi7xvKuaDEaT4QAAGOC"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"shares\": [\n {\n \"access_sharing_enabled\": false,\n \"content_created_by\": \"example1@crankwheel.com\",\n \"content_recorded_at\": \"2026-04-01T12:45:51Z\",\n \"content_runtime\": \"00:00:04\",\n \"created_at\": \"2026-04-01T13:00:06.000000Z\",\n \"customer_account_id\": \"abracadabra\",\n \"id\": \"b1e36cf7-e73f-4e1e-a2f0-37eb1e5bf65a\",\n \"video_url\": \"https://meeting.is/ss/share/b1e36cf7-e73f-4e1e-a2f0-37eb1e5bf65a\"\n },\n {\n \"access_sharing_enabled\": true,\n \"content_created_by\": \"example2@crankwheel.com\",\n \"content_recorded_at\": \"2025-03-13T11:06:47Z\",\n \"content_runtime\": \"00:07:24\",\n \"created_at\": \"2026-04-01T13:03:11.000000Z\",\n \"customer_account_id\": null,\n \"id\": \"84a70b2e-5962-4c03-8e03-eb3d64051c61\",\n \"video_url\": \"https://meeting.is/ss/share/84a70b2e-5962-4c03-8e03-eb3d64051c61\"\n },\n {\n \"access_sharing_enabled\": true,\n \"content_created_by\": \"example2@crankwheel.com\",\n \"content_recorded_at\": \"2024-07-23T11:30:36Z\",\n \"content_runtime\": \"00:00:39\",\n \"created_at\": \"2026-04-01T13:04:01.000000Z\",\n \"customer_account_id\": null,\n \"id\": \"2d46f1aa-c3ce-4413-8016-1654a11e1818\",\n \"video_url\": \"https://meeting.is/ss/share/2d46f1aa-c3ce-4413-8016-1654a11e1818\"\n },\n {\n \"access_sharing_enabled\": true,\n \"content_created_by\": \"example2@crankwheel.com\",\n \"content_recorded_at\": \"2024-09-12T10:55:06Z\",\n \"content_runtime\": \"00:02:01\",\n \"created_at\": \"2026-04-01T13:07:43.000000Z\",\n \"customer_account_id\": null,\n \"id\": \"cdf542fe-dae3-48f6-8d5a-924931de2267\",\n \"video_url\": \"https://meeting.is/ss/share/cdf542fe-dae3-48f6-8d5a-924931de2267\"\n },\n {\n \"access_sharing_enabled\": true,\n \"content_created_by\": \"example3@crankwheel.com\",\n \"content_recorded_at\": \"2024-06-27T16:47:10Z\",\n \"content_runtime\": \"00:00:26\",\n \"created_at\": \"2026-04-01T13:09:06.000000Z\",\n \"customer_account_id\": \"1234567890\",\n \"id\": \"623fb55e-949f-463c-bdbd-671db89efcc3\",\n \"video_url\": \"https://meeting.is/ss/share/623fb55e-949f-463c-bdbd-671db89efcc3\"\n }\n ]\n}"}],"_postman_id":"b26ae302-51c2-4a48-8f70-08b6812d965f"}],"id":"e8898c89-74d5-4c18-b69b-ab28083bcd52","_postman_id":"e8898c89-74d5-4c18-b69b-ab28083bcd52","description":""}],"event":[{"listen":"prerequest","script":{"id":"e6a7df46-b808-4e96-b0f0-850f20f5ba77","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f4230895-be7a-47b7-aa9b-916f2f129c89","type":"text/javascript","exec":[""]}}]}