The Right-Hand Public API provides programmatic access to manage authentication, tenant access, and system metadata for Right-Hand Cybersecurity platforms. Designed for customers who want to integrate Right-Hand with their internal applications, these RESTful APIs allow partners to authenticate admin accounts, generate user tokens, and retrieve system settings such as available time zones.
\nhttps://api.right-hand.ai/public\n\nTo interact with the Right-Hand Public API, you must complete the authorization workflow using Bearer Token authentication.
\nContact the Right-Hand Support team to obtain your Account Token (ACCOUNT_TOKEN) and a service account email to pass in SERVICE_ACCOUNT_EMAIL.
\nSend a POST request to the authentication endpoint using your credentials to generate a session token for the user that can be used for other api endpoits.
/public/authenticationsHeaders:
\nContent-Type: application/json { \n \"tenant_token\": \"ACCOUNT_TOKEN\", \n \"email\": \"SERVICE_ACCOUNT_EMAIL\"\n }\n\ncurl --location 'https://api.right-hand.ai/public/authentications' \n--header 'Content-Type: application/json' \n--data '{\n \"tenant_token\": \"ACCOUNT_TOKEN\",\n \"email\": \"SERVICE_ACCOUNT_EMAIL\"\n}'\n\n{\n \"code\":200,\n \"message\":\"OK\",\n \"details\":{\n \"user_token\":\"TENANT_TOKEN\"\n }\n}\n\n\n\nDo not forget to use logout request once you are done with your API usage
\n
The API uses standard HTTP response codes to indicate the success or failure of an API request.
\n| HTTP Code | Description | Meaning / Troubleshooting |
| 200 | Success | Request was processed successfully. |
| 400 | Invalid Request | Malformed body, missing parameters, or improper formatting. |
| 401 | User Not Authorized | Missing, invalid, or expired Bearer token. |
| 404 | Record Not Found | The requested endpoint or resource does not exist. |
| 422 | Validation Error | Payload failed parameter validation. |
| 500 | Internal Server Error | An internal server issue occurred; retry or contact support. |
Generate Session Token for User
\nPurpose: Generates a user access token (user_token) required to authorize subsequent API requests.
Request Body: Requires tenant_token (string) and email (service account email string).
Response: Returns a 200 OK status with the session user_token inside the response details.
Remove Session Token for User
\nPurpose: Revokes and invalidates the active user session token once API operations are complete.
\nRequest Body: Requires tenant_token and email payload.
Response: Returns a 200 OK status with user_token set to nil.
ID of company you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"},{"id":"ae81160d-8abd-4875-b470-6cde6d7610ae","description":{"content":"ID of campaign you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_id"}]}},"response":[{"id":"4163b493-299f-4cf5-86d2-5b67a943917f","name":"Get Campaign Detail","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.right-hand.ai/public/companies/:company_id/competitions/:campaign_id","host":["https://api.right-hand.ai"],"path":["public","companies",":company_id","competitions",":campaign_id"],"variable":[{"key":"company_id","value":"","description":"ID of company you want to query"},{"key":"campaign_id","value":"","description":"ID of campaign you want to query"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"competition\": {\n \"id\": 1,\n \"title\": \"August 2020 - Campaign 1\",\n \"created_at\": \"2020-10-10 10:10 PM\",\n \"updated_at\": \"2020-10-10 10:10 PM\",\n \"starts_at\": \"2020-10-10 10:10 PM\",\n \"end_at\": \"2020-10-10 10:10 PM\",\n \"is_published\": true,\n \"is_attach_leaderboard\": false,\n \"avatar_url\": null,\n \"competition_type\": \"training\",\n \"campaign_group_id\": 1,\n \"user_count\": 2,\n \"included_compliance_section_names\": \"\",\n \"error_message\": null,\n \"risk_score\": 100.0,\n \"campaign_group_title\": \"August 2020\",\n \"send_report_enable\": false,\n \"is_expire_competitions\": false,\n \"schedule_timezone\": null,\n \"has_training_enabled\": true,\n \"execute_at\": \"2020-10-10 10:10 PM\",\n \"status\": \"completed\",\n \"campaign_sending_interval\": \"instant\",\n \"training_id\": 1,\n \"compliance_title\": null,\n \"compliance_id\": null,\n \"training_name\": \"Training 1\"\n }\n}"}],"_postman_id":"4075b83e-a8fb-4d23-8092-19029708578e"},{"name":"Generate campaign report in PDF","id":"9bd221a9-10d7-4bd4-9e14-adbc5a73cc70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.right-hand.ai/public/companies/:company_id/competitions/:campaign_id/export?type=pdf","description":"It will generate PDF report of a campaign.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ID of company you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"},{"id":"5166335d-783f-4c20-8668-1e67bccdcd66","description":{"content":"ID of campaign you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_id"}]}},"response":[{"id":"92b24184-78ca-45c4-be2e-673ae2e76493","name":"Generate campaign report in PDF","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.right-hand.ai/public/companies/:company_id/competitions/:campaign_id/export?type=pdf","host":["https://api.right-hand.ai"],"path":["public","companies",":company_id","competitions",":campaign_id","export"],"query":[{"key":"type","value":"pdf"}],"variable":[{"key":"company_id","value":"","description":"ID of company you want to query"},{"key":"campaign_id","value":"","description":"ID of campaign you want to query"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"success\": true,\n \"url\": \"URL_OR_PDF_FILE\"\n }\n}"}],"_postman_id":"9bd221a9-10d7-4bd4-9e14-adbc5a73cc70"},{"name":"Get user engagement trends in the campaign","id":"5e68288e-5e9c-4961-bd97-22a3d37e0e2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/javascript","type":"text"}],"url":"https://api.right-hand.ai/public/companies/:company_id/competitions/:campaign_id/competition_trends?duration=one_week","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"available options one_week, one_month, six_months, one_year
\n","type":"text/plain"},"key":"duration","value":"one_week"}],"variable":[{"id":"d5b3598b-495f-4d6f-a8ec-3e06cad3a9b6","description":{"content":"ID of company you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"},{"id":"b8ae4615-d748-4a4e-8b81-aeebff90af49","description":{"content":"ID of campaign you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_id"}]}},"response":[{"id":"a341edcb-780c-43e9-9ead-6664d2f4a1ef","name":"Get user engagement trends in the campaign","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.right-hand.ai/public/companies/:company_id/competitions/:campaign_id/competition_trends?duration=one_week","host":["https://api.right-hand.ai"],"path":["public","companies",":company_id","competitions",":campaign_id","competition_trends"],"query":[{"key":"duration","value":"one_week","description":"available options one_week, one_month, six_months, one_year"}],"variable":[{"key":"company_id","value":"","description":"ID of company you want to query"},{"key":"campaign_id","value":"","description":"ID of campaign you want to query"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"trends\": {\n \"delivered\": [\n 0,\n 0,\n 0,\n 0,\n 0,\n 2,\n 0\n ],\n \"completed\": [\n 0,\n 0,\n 0,\n 0,\n 0,\n 1,\n 0\n ],\n \"passed\": [\n 0,\n 0,\n 0,\n 0,\n 0,\n 0,\n 0\n ],\n \"failed\": [\n 0,\n 0,\n 0,\n 0,\n 0,\n 1,\n 0\n ],\n \"titles\": [\n \"24 Feb 2021\",\n \"25 Feb 2021\",\n \"26 Feb 2021\",\n \"27 Feb 2021\",\n \"28 Feb 2021\",\n \"01 Mar 2021\",\n \"02 Mar 2021\"\n ]\n }\n }\n}"}],"_postman_id":"5e68288e-5e9c-4961-bd97-22a3d37e0e2e"},{"name":"Get Campaign Training Statistics","id":"a4921b0d-570d-4709-aa25-e562a1215da3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.right-hand.ai/public/companies/:company_id/competitions/:campaign_id/competition_training_stats","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ID of company you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"},{"id":"ce3116fd-5dfd-46d1-92ae-9b37af4b2385","description":{"content":"ID of campaign you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_id"}]}},"response":[{"id":"2220eddd-16fa-47ff-b2a7-9ce47951f810","name":"Get Campaign Training Statistics","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.right-hand.ai/public/companies/:company_id/competitions/:campaign_id/competition_training_stats","host":["https://api.right-hand.ai"],"path":["public","companies",":company_id","competitions",":campaign_id","competition_training_stats"],"variable":[{"key":"company_id","value":"","description":"ID of company you want to query"},{"key":"campaign_id","value":"","description":"ID of campaign you want to query"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"metrix\": {\n \"total\": 2,\n \"completed\": 1,\n \"passed\": 0,\n \"failed\": 1\n }\n }\n}"}],"_postman_id":"a4921b0d-570d-4709-aa25-e562a1215da3"}],"id":"b67321ec-0aac-4ce3-84a4-a75b75d2c1e1","_postman_id":"b67321ec-0aac-4ce3-84a4-a75b75d2c1e1","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ID of company where you want to add a new user
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"}]}},"response":[{"id":"4114069c-8844-4f2a-afae-2f0c6f4695f5","name":"Add a new user","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"employee\": {\n \"first_name\": \"STRING\", // Required\n \"last_name\": \"STRING\", // Optional\n \"email\": \"EMAIL\", // Required - Valid Email Address\n \"role\": \"STRING\", // Optional (default: 'employee') Available options: (admin, employee)\n \"send_invite\": \"BOOLEAN\" // Optional, default: false , it will send an invite to user with an onboarding link\n }\n }","options":{"raw":{"language":"json"}}},"url":{"raw":"POST https://api.right-hand.ai/public/companies/:company_id/employees","host":["POST https://api.right-hand.ai"],"path":["public","companies",":company_id","employees"],"variable":[{"key":"company_id","value":"","description":"ID of company where you want to add a new user"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"employee\": {\n \"id\": 1,\n \"first_name\": \"Demo\",\n \"last_name\": \"User\",\n \"email\": \"demo@domain.com\",\n \"role\": \"employee\"\n }\n }\n }"}],"_postman_id":"55956a35-fe95-48b6-ad26-37f370a12ec4"},{"name":"Send onboarding instructions to an existing employee","id":"e73537ee-54fa-42ac-93e0-f83ad44a13fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://api.right-hand.ai/public/employees/:user_id/invitations","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ID of user you want to onboard
\n","type":"text/plain"},"type":"any","value":"","key":"user_id"}]}},"response":[{"id":"6f0852f3-f3b1-4920-b025-eab9cd5c6190","name":"Send onboarding instructions to an existing employee","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.right-hand.ai/public/employees/:user_id/invitations","host":["https://api.right-hand.ai"],"path":["public","employees",":user_id","invitations"],"variable":[{"key":"user_id","value":"","description":"ID of user you want to onboard"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"success\": true\n }\n }"}],"_postman_id":"e73537ee-54fa-42ac-93e0-f83ad44a13fc"},{"name":"Import a CSV file","id":"7ed61ab2-8aae-4bd0-bb15-33f8ef8b3cc4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":"https://api.right-hand.ai/public/companies/:id/imported_files","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ID of account where you want to import users
\n","type":"text/plain"},"type":"any","value":null,"key":"id"}]}},"response":[{"id":"c15e134a-81d1-4313-b653-61878027dc0c","name":"Import a CSV file","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","value":null}]},"url":{"raw":"https://api.right-hand.ai/public/companies/:id/imported_files","host":["https://api.right-hand.ai"],"path":["public","companies",":id","imported_files"],"variable":[{"key":"id","value":null,"description":"ID of account where you want to import users"}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"success\": true\n }\n}"}],"_postman_id":"7ed61ab2-8aae-4bd0-bb15-33f8ef8b3cc4"},{"name":"Update an Existing User","id":"ca193723-0e11-4cca-a358-4bd217796136","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"employee\": {\n \"attribute_name\": \"attribute_value\"\n }\n} \n"},"url":"https://api.right-hand.ai/public/companies/:company_id/employees/:user_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Id of company where.you want to update user
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"},{"id":"4cdfcbb1-7df9-43ad-b2cb-8d81c60a0ae8","description":{"content":"Id of user you want to update
\n","type":"text/plain"},"type":"any","value":"","key":"user_id"}]}},"response":[{"id":"e19dc3d5-3a19-4ed8-9ab4-c6b5b334a1cf","name":"Update an Existing User","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"employee\": {\n \"attribute_name\": \"attribute_value\"\n }\n} \n"},"url":{"raw":"https://api.right-hand.ai/public/companies/:company_id/employees/:user_id","host":["https://api.right-hand.ai"],"path":["public","companies",":company_id","employees",":user_id"],"variable":[{"key":"company_id","value":""},{"key":"user_id","value":""}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"employee\": {\n \"id\": integer,\n \"first_name\": string,\n \"last_name\": string,\n \"email\": string,\n \"role\": string,\n \"risk_score\": x\n }\n }\n}"}],"_postman_id":"ca193723-0e11-4cca-a358-4bd217796136"},{"name":"Archive User(s)","id":"5ea87daa-6772-4757-939c-0f4c9283d7a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": []\n} "},"url":"https://api.right-hand.ai/public/companies/:company_id/send_multiple_archives","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ID of account where you want to archive users.
\n","type":"text/plain"},"type":"any","value":null,"key":"company_id"}]}},"response":[{"id":"3112095e-17ee-4775-89d8-a97727c94ff1","name":"Archive User(s)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": []\n} "},"url":{"raw":"https://api.right-hand.ai/public/companies/:company_id/send_multiple_archives","host":["https://api.right-hand.ai"],"path":["public","companies",":company_id","send_multiple_archives"],"variable":[{"key":"company_id","value":"","description":"ID of company where you want to archive users."}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"success\": true\n }\n}\n"}],"_postman_id":"5ea87daa-6772-4757-939c-0f4c9283d7a0"},{"name":"Delete Existing User(s)","id":"64cee57f-9087-4f58-a134-7a74b11c183e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": [] // array of user ids\n} "},"url":"https://api.right-hand.ai/public/companies/:company_id/send_multiple_deletes","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ID of company where you want to delete users.
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"}]}},"response":[{"id":"dbc73fbd-a9d0-4133-b2d8-43187545556d","name":"Delete Existing User(s)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": [] // array of user ids\n} "},"url":{"raw":"https://api.right-hand.ai/public/companies/:company_id/send_multiple_deletes","host":["https://api.right-hand.ai"],"path":["public","companies",":company_id","send_multiple_deletes"],"variable":[{"key":"company_id","value":"","description":"ID of company where you want to delete users."}]}},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"success\": true\n }\n}"}],"_postman_id":"64cee57f-9087-4f58-a134-7a74b11c183e"},{"name":"List of employees in a company","id":"c38a36a5-c04e-40bd-ae8a-b75cb7ba10c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.right-hand.ai/public/companies/:company_id/employees?page=1&size_per_page=10&sort_field=first_name&sort_order=asc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Page No
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Number of records per page
\n","type":"text/plain"},"key":"size_per_page","value":"10"},{"description":{"content":"Default is first_name, available options (first_name, last_name, risk_score)
\n","type":"text/plain"},"key":"sort_field","value":"first_name"},{"description":{"content":"Default is asc, available options (asc, desc)
\n","type":"text/plain"},"key":"sort_order","value":"asc"}],"variable":[{"id":"49581929-40a1-4023-bb98-82c74f2693f7","description":{"content":"ID of company
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"}]}},"response":[{"id":"6704e266-1e8f-4977-a3d7-4251aeaf0a58","name":"List of employees in a company","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.right-hand.ai/public/companies/:company_id/employees?page=1&size_per_page=10&sort_field=first_name&sort_order=asc","host":["https://api.right-hand.ai"],"path":["public","companies",":company_id","employees"],"query":[{"key":"page","value":"1","description":"Page No"},{"key":"size_per_page","value":"10","description":"Number of records per page"},{"key":"sort_field","value":"first_name","description":"Default is first_name, available options (first_name, last_name, risk_score)"},{"key":"sort_order","value":"asc","description":"Default is asc, available options (asc, desc)"}],"variable":[{"key":"company_id","value":"","description":"ID of company "}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"employees\": [\n {\n \"id\": 1,\n \"first_name\": \"Demo\",\n \"last_name\": \"User\",\n \"name\": \"Demo User\"\",\n \"email\": \"demo@domain.com\",\n \"last_sign_in_at\": \"2022-07-27 09:06 PM\",\n \"department_title\": \"IT\",\n \"role_names\": \"employee\",\n \"risk_score\": 100,\n \"title_text\": \"Demo\",\n \"location_name\": \"Demo\",\n \"report_to\": \"Demo Manager\",\n \"is_admin\": false,\n \"is_archive\": false,\n \"invitation_accepted\": true,\n \"action_id\": 1\n }\n ],\n \"total_count\": 10,\n \"active_count\": 9,\n \"archived_count\": 1\n }\n}\n"}],"_postman_id":"c38a36a5-c04e-40bd-ae8a-b75cb7ba10c2"},{"name":"Training Statistics","id":"aaca73e1-d90b-4cee-bc7a-707d58573ab5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.right-hand.ai/public/companies/:company_id/employee_training_stats?size_per_page=10&page=1&user_id=","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ID of user
\n","type":"text/plain"},"key":"user_id","value":""}],"variable":[{"id":"819ecaa4-7891-415e-942a-9c5db1e70ac8","description":{"content":"ID of company where you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"}]}},"response":[{"id":"a1ecac48-9d4f-453a-bc78-88228b78b0f3","name":"Training Statistics","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.right-hand.ai/public/companies/:company_id/employee_training_stats?size_per_page=10&page=1&user_id=","host":["https://api.right-hand.ai"],"path":["public","companies",":company_id","employee_training_stats"],"query":[{"key":"size_per_page","value":"10"},{"key":"page","value":"1"},{"key":"user_id","value":"","description":"ID of user "}],"variable":[{"key":"company_id","value":"","description":"ID of company where you want to query"}]}},"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"user_trainings\": [\n {\n \"id\": 1,\n \"name\": \"Training 1\",\n \"category_name\": \"Category 1\",\n \"competition_title\": \"September 2022\",\n \"completed\": true,\n \"passed\": true\n }\n ],\n \"number_stats\": {\n \"0\": 100.0,\n \"1\": 0.0,\n \"2\": 0.0,\n \"3\": 0.0,\n \"incomplete_stats\": 0.0\n },\n \"completion_stats\": {\n \"daily_count\": 1,\n \"daily_percentage\": 100.0,\n \"weekly_count\": 1,\n \"weekly_percentage\": 100.0,\n \"monthly_count\": 1,\n \"monthly_percentage\": 100.0\n },\n \"total\": 2,\n \"completed\": 2,\n \"incomplete\": 0,\n \"passed\": 2,\n \"failed\": 0\n }\n}"}],"_postman_id":"aaca73e1-d90b-4cee-bc7a-707d58573ab5"}],"id":"24ace362-8d1e-434d-b351-02ed17d925da","_postman_id":"24ace362-8d1e-434d-b351-02ed17d925da","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"available options itself, link_clicked, form_filled, email_replied, attachment_opened
\n","type":"text/plain"},"key":"event_type","value":"itself"},{"disabled":true,"description":{"content":"YYYY-MM-DD T00:00:00+08:00 / YYYY-MM-DD T00%3A00%3A00%2B08%3A00
\n","type":"text/plain"},"key":"start_date","value":"2023-09-01T00%3A00%3A00%2B08%3A00"},{"disabled":true,"description":{"content":"YYYY-MM-DD T00:00:00+08:00 / YYYY-MM-DD T00%3A00%3A00%2B08%3A00
\n","type":"text/plain"},"key":"end_date","value":"2023-10-01T00%3A00%3A00%2B08%3A00"},{"key":"search","value":""},{"key":"engagement_count","value":""},{"description":{"content":"available options one_week, one_month, six_months, one_year , custom
\n","type":"text/plain"},"key":"interval","value":"one_month"}],"variable":[]}},"response":[{"id":"ddeb0393-68d6-4c2a-bb90-d52cf933b72d","name":"Repeat Offender","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"","type":"text"}],"url":{"raw":"{{URL_STG}}/public/reports/export.json?report_type=repeat_offenders&page=1&size_per_page=10&sort_field=engagement_count&sort_order=desc&type=json&event_type=itself&search=&engagement_count=&interval=one_month","host":["{{URL_STG}}"],"path":["public","reports","export.json"],"query":[{"key":"report_type","value":"repeat_offenders"},{"key":"page","value":"1"},{"key":"size_per_page","value":"10"},{"key":"sort_field","value":"engagement_count"},{"key":"sort_order","value":"desc"},{"key":"type","value":"json"},{"key":"event_type","value":"itself","description":"available options itself, link_clicked, form_filled, email_replied, attachment_opened"},{"key":"start_date","value":"2023-09-01T00%3A00%3A00%2B08%3A00","description":"YYYY-MM-DD T00:00:00+08:00 / YYYY-MM-DD T00%3A00%3A00%2B08%3A00","disabled":true},{"key":"end_date","value":"2023-10-01T00%3A00%3A00%2B08%3A00","description":"YYYY-MM-DD T00:00:00+08:00 / YYYY-MM-DD T00%3A00%3A00%2B08%3A00","disabled":true},{"key":"search","value":""},{"key":"engagement_count","value":""},{"key":"interval","value":"one_month","description":"available options one_week, one_month, six_months, one_year , custom"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 19 Oct 2023 11:21:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"afc6a513f92115c92e09f3ab5908543f\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_righthand_session=qQi3e15BgRw2xa2JXV3s9%2BrRM%2F%2BG7bpJNxCVf%2BAuPm4MGXX6XmZ%2F82hDrN%2BuC8ZvlzWNs3AXduDQ05bqQbrFGRIdg57T97oRi6rUDnNIbEo%2FtgjwJjKqSXmmWhmdGEwaacLvofKoCEJPvaJpso8kTeSOXgTeZSZRK3r2Ly5MwnXBJIasBIaF%2BqibtKYrh18ow%2BEgtu%2FOqo3iGPemEFfXghZe1u8eibUkCoxU9WxeYJL64oV%2FSprO9C1%2Bh%2F9dSSAQTuwLuw4Egtt3IGk9oWDM--GF1KK3NRWCL63Z26--0hdh6NDvZ%2FZyxTszWylQLg%3D%3D; path=/; HttpOnly"},{"key":"X-Request-Id","value":"c5ac9723-06d8-44f3-8dca-1e4b0a140885"},{"key":"X-Runtime","value":"0.053798"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": INTEGER,\n \"name\": \"STRING\",\n \"manager\": \"STRING\",\n \"email\": \"demo@yourcompany.com\",\n \"engagement_count\": INTEGER\n }\n ],\n \"total_count\": 1,\n \"engagement_graph\": [\n {\n \"month\": \"Oct, 2023\",\n \"count\": 1\n }\n ]\n}"}],"_postman_id":"75682b77-db4b-4a40-91d7-350a449c5254"},{"name":"Behavior Analysis","id":"f12b4eca-0756-44c2-a820-f032ecd9594e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.right-hand.ai/public/reports/export.json?size_per_page=10&type=json&sort_field=risk_score&sort_order=desc&format=json&report_type=email_templates","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"available option email_templates, attacker_profiles
\n","type":"text/plain"},"key":"report_type","value":"email_templates"}],"variable":[]}},"response":[{"id":"9bccfd71-f351-484f-8e53-87567f96fdc9","name":"Behavior Analysis","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text","disabled":true}],"url":{"raw":"https://api.right-hand.ai/public/reports/export.json?size_per_page=10&type=json&sort_field=risk_score&sort_order=desc&format=json&report_type=email_templates","host":["https://api.right-hand.ai"],"path":["public","reports","export.json"],"query":[{"key":"size_per_page","value":"10"},{"key":"type","value":"json"},{"key":"sort_field","value":"risk_score"},{"key":"sort_order","value":"desc"},{"key":"format","value":"json"},{"key":"report_type","value":"email_templates","description":"available option email_templates, attacker_profiles"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 19 Oct 2023 08:57:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"ETag","value":"W/\"b3c599b8c7486f2d7e77ee27df986a47\""},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate"},{"key":"Set-Cookie","value":"_righthand_session=WpNJJ%2FJTMxtJEBuf3svoZ7BHm3ponn%2F3R%2FaTPwsxLTwNB7p%2BYyVu82bTd1yoKbckBE8xLCUSeYY6XUVxCRhYtCTEUvcxq1l29wBCPyuXkkHD%2FngMz3PqcRg8fcjjaSe7ELMAflbB1B2pfBdKtHfCjNhHkI6fzHtnhTmPIeiuug7pV8zraGs46ljDi0Yuumg2uidbcQ%2Fb2JJDFPRoS23cu1a2ZlhCM1LUhWBnXH4PiXIkVVWjnbfx6n7Z2q1BWhZo32%2BLOSvnX1FbruWVhlMk--sL3Janpa1IziUe9k--r9arnqmgiQkBg3lyYDbEmQ%3D%3D; path=/; HttpOnly"},{"key":"X-Request-Id","value":"1d9e07b1-0405-4d23-898e-1e27b5b6b055"},{"key":"X-Runtime","value":"0.056469"},{"key":"Vary","value":"Origin"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": INTEGER,\n \"risk_score\": 0,\n \"name\": \"STRING\",\n \"subject\": \"STRING\",\n \"content\": \"STRING\",\n \"link_clicked\": 0,\n \"form_filled\": 0,\n \"email_replied\": 0,\n \"attachment_opened\": 0,\n \"email_reported\": 0\n }\n ],\n \"total_count\": INTEGER\n}"}],"_postman_id":"f12b4eca-0756-44c2-a820-f032ecd9594e"}],"id":"dc6c4105-0dfe-439e-a7f3-e50cda4eb228","_postman_id":"dc6c4105-0dfe-439e-a7f3-e50cda4eb228","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"available options itself, completed, incompleted, passed, failed
\n","type":"text/plain"},"key":"event_type","value":"failed"},{"key":"training_count","value":""},{"description":{"content":"YYYY-MM-DD T00:00:00+08:00 / YYYY-MM-DD T00%3A00%3A00%2B08%3A00
\n","type":"text/plain"},"key":"start_date","value":"2023-10-01T00%3A00%3A00%2B08%3A00"},{"description":{"content":"YYYY-MM-DD T00:00:00+08:00 / YYYY-MM-DD T00%3A00%3A00%2B08%3A00
\n","type":"text/plain"},"key":"end_date","value":"2023-11-01T00%3A00%3A00%2B08%3A00"},{"key":"search ","value":""}],"variable":[]}},"response":[{"id":"b9b9f7d3-d7ee-47db-92c2-b0f5f8fa4f3e","name":"Training Stats","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.right-hand.ai/public/reports/export.json?report_type=targeted_trainings&page=1&size_per_page=10&sort_field=completed_count&sort_order=desc&type=json&interval=custom&event_type=failed&training_count=&start_date=2023-10-01T00%3A00%3A00%2B08%3A00&end_date=2023-11-01T00%3A00%3A00%2B08%3A00&search ","host":["https://api.right-hand.ai"],"path":["public","reports","export.json"],"query":[{"key":"report_type","value":"targeted_trainings"},{"key":"page","value":"1"},{"key":"size_per_page","value":"10"},{"key":"sort_field","value":"completed_count"},{"key":"sort_order","value":"desc"},{"key":"type","value":"json"},{"key":"interval","value":"custom"},{"key":"event_type","value":"failed","description":"available options itself, completed, incompleted, passed, failed"},{"key":"training_count","value":""},{"key":"start_date","value":"2023-10-01T00%3A00%3A00%2B08%3A00","description":"YYYY-MM-DD T00:00:00+08:00 / YYYY-MM-DD T00%3A00%3A00%2B08%3A00"},{"key":"end_date","value":"2023-11-01T00%3A00%3A00%2B08%3A00","description":"YYYY-MM-DD T00:00:00+08:00 / YYYY-MM-DD T00%3A00%3A00%2B08%3A00"},{"key":"search ","value":null}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 19 Oct 2023 11:26:22 GMT"},{"key":"Server","value":"nginx"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"e1357a82-5b63-4e3d-85fa-bd1c830b4a06"},{"key":"X-Runtime","value":"0.007902"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Origin"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 bdcb0966d6e5d28eb31a406298268896.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SIN2-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"YPMTq5zjJ2sjNIFM8qphRD96IUngcBCcJnKI8MoElhmethTk0PB7nA=="},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": INTEGER,\n \"name\": \"STRING\",\n \"email\": \"demo@yourcompany.com\",\n \"manager\": \"STRING\",\n \"completed_count\": INTEGER,\n \"time_spent\": 30\n }\n ],\n \"total_count\": 1,\n \"total_assigned\": 4,\n \"engagement_graph\": [\n {\n \"month\": \"Aug, 2023\",\n \"count\": 7\n }\n ]\n}"}],"_postman_id":"781b78da-b67e-436a-b7a1-1ea0f6c8d7d6"}],"id":"b91c7fbe-92e4-4c83-8a60-027707bc1eb5","_postman_id":"b91c7fbe-92e4-4c83-8a60-027707bc1eb5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"user id of the employee
\n","type":"text/plain"},"key":"employee_id","value":":user_id"},{"description":{"content":"available options are employee_email_templates, employee_sender_profile
\n","type":"text/plain"},"key":"report_type","value":"employee_email_templates"},{"key":"type","value":"json"}],"variable":[]}},"response":[{"id":"52e24d86-898c-4bb7-91c2-5a71ad7eb480","name":"Phishing Email Templates / Sender Profiles","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer ","type":"text","disabled":true}],"url":{"raw":"https://api.right-hand.ai/public/reports/export.json?employee_id=:user_id&report_type=employee_email_templates&type=json","host":["https://api.right-hand.ai"],"path":["public","reports","export.json"],"query":[{"key":"employee_id","value":":user_id","description":"user id of the employee"},{"key":"report_type","value":"employee_email_templates","description":"available options are employee_email_templates, employee_sender_profile"},{"key":"type","value":"json"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Thu, 19 Oct 2023 11:36:18 GMT"},{"key":"Server","value":"nginx"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Permitted-Cross-Domain-Policies","value":"none"},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin"},{"key":"Cache-Control","value":"no-cache"},{"key":"X-Request-Id","value":"caab2960-3d98-44ef-9158-1fa5343ca516"},{"key":"X-Runtime","value":"0.009840"},{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Origin"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 475d669d6a669094dfa09def007f90d6.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"SIN2-P1"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"anjvjtuFNAhgESdAkMEf9lwP_Mx5Tn0ydj6xGlWCyzOyPFRvSS_9uA=="},{"key":"Strict-Transport-Security","value":"max-age=31536000"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": INTEGER,\n \"name\": \"demo@yourcompany.com\",\n \"link_clicked\": INTEGER,\n \"form_filled\": INTEGER,\n \"email_replied\": INTEGER,\n \"email_reported\": INTEGER,\n \"attachment_opened\": INTEGER\n }\n ],\n \"total_count\": INTEGER\n}"}],"_postman_id":"fac77fea-c20d-4c74-8b84-7a62c3bf4b61"}],"id":"f6ce19cc-46d5-43c1-9b5a-da6ea4f6150e","_postman_id":"f6ce19cc-46d5-43c1-9b5a-da6ea4f6150e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"