This API will help you to create an authentication token to access the data of your accounts. Please ask the Right-hand support team for your MSSP token.
\nStep 1: Click on Run on Postman in the top right corner.
\nStep 2: If you are an MSSP partner, get your partner token from Right-Hand support team.
\nThis endpoint generates an access token (bearer token) for authenticating subsequent API requests. It exchanges a tenant token and email credentials for a user-specific authentication token that can be used to access protected resources.
\nThis email is typically a service account created in your account by your success or support team. It would typically be an admin in your org or something generic: api_rh_service_account@mydomain.com
\nThis is typically the first endpoint you'll call in your API workflow to obtain the necessary credentials for other operations.
\n{\n \"tenant_token\": \"your_tenant_token_here\",\n \"email\": \"api_rh_service_account@mydomain.com\"\n}\n\nThe endpoint returns a JSON response containing the user token in the following structure:
\n{\n \"details\": {\n \"user_token\": \"generated_user_token_here\"\n }\n}\n\nCall this endpoint first in your API workflow to obtain authentication credentials
\nCache the token - Don't generate a new token for every request; reuse the token until it expires
\nSecure storage - Store both tenant tokens and user tokens securely using environment variables
\nError handling - Implement proper error handling for authentication failures
\nToken refresh - If you receive authentication errors in subsequent requests, regenerate the token using this endpoint
\nInitial authentication setup for API integration
\nService account authentication for automated workflows
\nToken refresh when existing tokens expire
\nMulti-tenant application authentication
\nRetrieves comprehensive training statistics for a specific competition campaign within a company. This endpoint provides insights into campaign performance, participant engagement, and training metrics.
\nThis endpoint requires authentication using a Bearer token. The token should be provided via the TOKEN variable in your environment or collection variables.
Authorization: Bearer \n\nMethod: GET
\nEndpoint: https://api.right-hand.ai/public/v2/companies/:company_id/competitions/:campaign_id/competition_training_stats
Content-Type: application/json
\nThe endpoint returns detailed training statistics for the specified campaign, including metrics such as:
\nParticipant engagement data
\nTraining completion rates
\nPerformance metrics
\nCampaign progress indicators
\nRefer to the saved example \"Get Campaign Statistics\" for a complete response structure.
\nGET https://api.right-hand.ai/public/v2/companies//competitions//competition_training_stats\nAuthorization: Bearer \nContent-Type: application/json\n\nEnsure that both company_id and campaign_id are valid and that the authenticated user has permission to access the specified campaign data.
The URL variable should point to the base API endpoint (e.g., production or staging environment).
ID of company you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"},{"description":{"content":"ID of campaign you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_id"}]}},"response":[{"id":"a58c3bb8-07d7-4339-91b1-84adb2585ae4","name":"Get Campaign Statistics","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://api.right-hand.ai/public/v2/companies/:company_id/competitions/:campaign_id/competition_training_stats","host":["https://api.right-hand.ai"],"path":["public","v2","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":""}]}},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"## Response Variations\n\nThis API returns different response structures based on the campaign type:\n\n### Training Campaigns\n- Returns training-specific metrics\n- Includes completion rates and scores\n\n### Phishing Campaigns \n- Returns phishing simulation results\n- Includes click rates and user interactions\n\n### Phishing Training Campaigns\n- Combines both training and phishing metrics\n- Includes comprehensive user behavior data\n\n{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"campaign\": {\n \"id\": campaign_id,\n \"name\": STRING,\n \"type\": \"training\" | \"phishing\" | \"phishing_training\",\n \"status\": \"completed | scheduled | in_progress\",\n \"campaign_risk\": \"x%\"\n },\n \"statistics\": {\n \"overview\": {\n \"delivered_emails\": {\n \"count\": INTEGER,\n \"percentage\": \"x%\"\n }\n },\n \"training_metrics\": {\n \"training_delivered\": {\n \"count\": INTEGER,\n \"percentage\": \"x%\"\n },\n \"training_attempted\": {\n \"count\": INTEGER,\n \"percentage\": \"x%\"\n },\n \"training_pending\": {\n \"count\": INTEGER,\n \"percentage\": \"x%\"\n },\n \"training_passed\": {\n \"count\": INTEGER,\n \"percentage\": \"x%\"\n },\n \"training_failed\": {\n \"count\": INTEGER,\n \"percentage\": \"x%\"\n }\n },\n \"phishing_metrics\": {\n \"opened\": {\n \"count\": INTEGER,\n \"total\": INTEGER,\n \"percentage\": \"x%\"\n },\n \"clicked\": {\n \"count\": INTEGER,\n \"total\": INTEGER,\n \"percentage\": \"x%\"\n },\n \"qr_code_scanned\": {\n \"count\": INTEGER,\n \"total\": INTEGER,\n \"percentage\": \"x%\"\n },\n \"data_submitted\": {\n \"count\": INTEGER,\n \"total\": INTEGER,\n \"percentage\": \"x%\"\n },\n \"attachment_opened\": {\n \"count\": INTEGER,\n \"total\": INTEGER,\n \"percentage\": \"x%\"\n },\n \"replied\": {\n \"count\": INTEGER,\n \"total\": INTEGER,\n \"percentage\": \"x%\"\n },\n \"reported\": {\n \"count\": INTEGER,\n \"total\": INTEGER,\n \"percentage\": \"x%\"\n }\n }\n }\n }\n}"}],"_postman_id":"804435cf-4d86-444f-a0a5-b2231350b944"}],"id":"d7e847e8-631b-42f5-b8bd-4802a49ec153","_postman_id":"d7e847e8-631b-42f5-b8bd-4802a49ec153","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint retrieves a list of campaigns (competitions) associated with a specific company. It returns campaign data that can be used to view and manage active competitions within the company's account.
\nGET https://api.right-hand.ai/public/companies//competitions\n\nNote: Ensure these variables are configured in your active environment before sending the request.
\nThis endpoint requires authentication via a Bearer token. The token should be included in the request headers.
\nContent-Type: application/jsonThe endpoint returns a JSON response with the following structure:
\nSuccess Response (200 OK):
\n{\n \"details\": {\n \"list\": [\n // Array of campaign objects\n ]\n }\n}\n\nThe response contains a details object with a list array containing the campaign/competition data.
The request includes automated tests that verify:
\nResponse status is 200 (OK)
\nResponse body contains an array in details.list
Ensure the company_id corresponds to a valid company in the system
The endpoint is part of the public API and requires proper authentication
\nSee the saved example \"Get list of campaigns\" for a sample request and response.
\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"},{"description":{"content":"ID of campaign you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_id"}]}},"response":[{"id":"b7acad1d-60d8-477a-9df1-45d940e550b4","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":null,"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":"ca321cf0-ef29-4bb8-bc58-ce47f29301e9"},{"name":"Generate campaign report in PDF","id":"7b1fe6cb-7faf-42a2-b79e-4f1a29ac7340","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"},{"description":{"content":"ID of campaign you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_id"}]}},"response":[{"id":"09be9dfb-ea00-4d1a-9480-90f851b63dc3","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":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"success\": true,\n \"url\": \"URL_OR_PDF_FILE\"\n }\n}"}],"_postman_id":"7b1fe6cb-7faf-42a2-b79e-4f1a29ac7340"},{"name":"Get user engagement trends in the campaign","id":"ad745c70-2db2-4849-9b40-caa0a3c6a045","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":[{"description":{"content":"ID of company you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"},{"description":{"content":"ID of campaign you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_id"}]}},"response":[{"id":"ec28e94e-ed73-4700-aac6-92891b314d3b","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":null,"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":"ad745c70-2db2-4849-9b40-caa0a3c6a045"},{"name":"Get Campaign Training Statistics","id":"fd3adf4f-c770-40ea-a471-3476b343af3a","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"},{"description":{"content":"ID of campaign you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"campaign_id"}]}},"response":[{"id":"00458a38-ec9f-41af-a439-b2b647a59917","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":null,"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":"fd3adf4f-c770-40ea-a471-3476b343af3a"}],"id":"83061845-c762-4887-89e1-d87c8bb66fc7","_postman_id":"83061845-c762-4887-89e1-d87c8bb66fc7","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":"64c71f55-9272-4470-b68b-eb05f5710bb4","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"}]}},"code":200,"_postman_previewlanguage":null,"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":"26afe9f6-8656-4154-8065-f628eaa993d0"},{"name":"Send onboarding instructions to an existing employee","id":"9717f7bd-1e50-4f59-a56f-bfaf9cf73bce","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":"decbf72d-9eeb-44e5-a3c8-a0645708772d","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"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"success\": true\n }\n }"}],"_postman_id":"9717f7bd-1e50-4f59-a56f-bfaf9cf73bce"},{"name":"Import a CSV file","id":"4354e841-aeed-4726-bf93-9ee0f0e442b6","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":"4b92b769-dbcd-4394-a5e0-a1b1ce48adb3","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":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"success\": true\n }\n}"}],"_postman_id":"4354e841-aeed-4726-bf93-9ee0f0e442b6"},{"name":"Update an Existing User","id":"28c43609-ef3b-4407-bc80-c78817757620","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"},{"description":{"content":"Id of user you want to update
\n","type":"text/plain"},"type":"any","value":"","key":"user_id"}]}},"response":[{"id":"ff442b69-9fd6-4dc9-8eec-cf9a81cbf966","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":""}]}},"code":200,"_postman_previewlanguage":null,"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":"28c43609-ef3b-4407-bc80-c78817757620"},{"name":"Archive User(s)","id":"2e24a38f-acb6-407a-8ab9-1be9ab4e02a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","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":"5a55793a-b8b0-484b-839f-ee1566fba04d","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":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"success\": true\n }\n}\n"}],"_postman_id":"2e24a38f-acb6-407a-8ab9-1be9ab4e02a7"},{"name":"Delete Existing User(s)","id":"5fbb3821-87a5-49fa-98dc-d32f9f0ed956","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":"7f45550f-b6d0-4605-8a3c-33477b2dda0c","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":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"code\": 200,\n \"message\": \"OK\",\n \"details\": {\n \"success\": true\n }\n}"}],"_postman_id":"5fbb3821-87a5-49fa-98dc-d32f9f0ed956"},{"name":"List of employees in a company","id":"90fd91c6-fe21-467d-8813-732fb31ee17b","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":[{"description":{"content":"ID of company
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"}]}},"response":[{"id":"1d02b4e3-b131-4e2d-baa7-4f09a7449e45","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":null,"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":"90fd91c6-fe21-467d-8813-732fb31ee17b"},{"name":"Training Statistics","id":"3de3689f-93fb-40ac-837e-9392a6c2ae3f","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=&sort_field=id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"ID of user
\n","type":"text/plain"},"key":"user_id","value":""},{"key":"sort_field","value":"id"}],"variable":[{"description":{"content":"ID of company where you want to query
\n","type":"text/plain"},"type":"any","value":"","key":"company_id"}]}},"response":[{"id":"3fd26446-c58d-4055-af27-6faa11e32538","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=&sort_field=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 "},{"key":"sort_field","value":"id","type":"text"}],"variable":[{"key":"company_id","value":"","description":"ID of company where you want to query"}]}},"code":200,"_postman_previewlanguage":null,"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":"3de3689f-93fb-40ac-837e-9392a6c2ae3f"}],"id":"70fa1249-c995-4ef2-87cc-3477cbebebfc","_postman_id":"70fa1249-c995-4ef2-87cc-3477cbebebfc","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint exports detailed phishing campaign data based on specified filters and parameters. It allows you to retrieve comprehensive user engagement metrics from phishing campaigns and training exercises.
\nreport_type (string, required)
Type of report to generate
\nAvailable values: \"users\"
Specifies that the export will focus on user-level data
\nresponse_type (string, required)
Format of the response data
\nAvailable values: \"json\"
Determines the output format of the exported data
\npage (integer, required)
Page number for paginated results
\nExample: 1 (first page)
Use this to navigate through large datasets
\nsize_per_page (integer, required)
Number of records to return per page
\nExample: 100
Maximum recommended: 100 records per page for optimal performance
\nstart_at (integer, required)
Start date/time for the data range (Unix timestamp)
\nExample: 946684800 (January 1, 2000)
Filters campaigns that started on or after this timestamp
\nend_at (integer, required)
End date/time for the data range (Unix timestamp)
\nExample: 1729468800 (October 20, 2024)
Filters campaigns that ended on or before this timestamp
\nsort_field (string, required)
Field to sort results by
\nExample: \"user_name\"
Must be one of the columns included in the columns array
sort_order (string, required)
Sort direction
\nAvailable values: \"asc\" (ascending), \"desc\" (descending)
columns (array of strings, required)Specifies which data fields to include in the export
\nSelect only the columns you need to optimize response size
\nconditions (array of objects, optional)Array of filter conditions to narrow down results
\nEach condition object contains: column, operator, and value
{\n \"column\": \"field_name\",\n \"operator\": \"comparison_operator\",\n \"value\": \"filter_value\"\n}\n\nuser_id: Filter by specific user IDs (array of integers)
competition_id: Filter by competition/campaign ID (array of integers)
campaign_types: Filter by campaign type (array: \"phishing\", \"phishing_training\")
campaign_start_date: Filter by campaign start date (Unix timestamp)
email_delivered_at: Filter by email delivery date (date string: \"MM/DD/YYYY\")
office_location: Filter by office location names (array of strings)
email_opened: Filter by whether email was opened (boolean array)
email_opened_at: Filter by email open date (datetime string: \"MM/DD/YYYY HH:MM:SS\")
link_clicked: Filter by whether link was clicked (boolean array)
link_clicked_at: Filter by link click date (datetime string: \"MM/DD/YYYY\")
Export data for users who clicked on phishing links in campaigns that started in 2024, sorted by user name.
\nFilter by specific office locations and departments to analyze phishing susceptibility by location.
\nTrack email delivery, open rates, and click-through rates for specific campaigns using the competition_id filter.
\nUse date range filters (start_at, end_at) combined with engagement timestamps to identify patterns in user behavior over time.
The endpoint returns a JSON response containing the requested user data with the specified columns, filtered and sorted according to the provided parameters.
\n","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":"aa2d8719-ca27-4fbd-9f9c-298c3dd79bc5","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":"fc69a8a8-f834-484d-b1d1-e7ace8eccd80"},{"name":"Behavior Analysis","id":"177bd2be-568a-482b-af57-69fad720e5f4","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":"c4382ef7-4df3-4832-b418-ef66db0be237","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":"177bd2be-568a-482b-af57-69fad720e5f4"}],"id":"45f7e286-73a8-45f5-8c79-53fd378b860e","_postman_id":"45f7e286-73a8-45f5-8c79-53fd378b860e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint exports training data with customizable columns, filtering, sorting, and pagination options. It allows you to retrieve comprehensive training completion information for users across campaigns.
\nThis endpoint uses the https://rh-prd-shared.right-hand.ai variable for the base URL. Ensure you have proper authentication configured (typically via Bearer token or API key in headers).
You can include any combination of the following columns in the columns array:
User Information:
\nuser_name - Name of the user
email - User's email address
manager_name - Name of the user's manager
user_group - User's group assignment
department - User's department
employee_type - Type of employee
Location Information:
\noffice_location - Office location
office_location_city - City of office location
office_location_country - Country of office location
Campaign Information:
\ncampaign_name - Name of the training campaign
campaign_creator - Creator of the campaign
campaign_start_date - Campaign start date
campaign_end_date - Campaign end date
days_past_campaign_end_date - Days elapsed since campaign ended
Training Information:
\ntraining_title - Title of the training
training_source - Source of the training
training_assignment_date - Date training was assigned
training_completion_date - Date training was completed
obtained_training_score - Score obtained in training
risk_score - User's risk score
Status Information:
\ncompletion_status_column - Training completion status
completion_result - Result of the completion
reminder_sent - Whether reminder was sent
The endpoint returns a JSON response containing:
\nPaginated training data with the requested columns
\nMetadata about pagination (current page, total records, etc.)
\nFiltered and sorted according to the request parameters
\nExport basic user training completion:
\n[\"user_name\", \"email\", \"training_title\", \"completion_status_column\", \"training_completion_date\"]Export detailed campaign performance:
\n[\"campaign_name\", \"user_name\", \"training_title\", \"obtained_training_score\", \"completion_result\"]Export location-based training data:
\n[\"office_location_country\", \"office_location_city\", \"user_name\", \"completion_status_column\"]Use pagination to handle large datasets efficiently
\nThe conditions parameter allows for advanced filtering (structure depends on API implementation)
Ensure the sort_field value matches one of the columns in your columns array for best results
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":null}],"variable":[]}},"response":[{"id":"9682ddaf-cd99-489a-905a-f72015d28798","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}"},{"id":"a3b63eed-42e8-4aec-84f6-b92e8f6106fa","name":"Training Stats","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"response_type\": \"json\",\n \"page\": 1,\n \"size_per_page\": 20,\n \"columns\": [\"user_name\" , \"email\" ], \n \"conditions\": [ \n \n ],\n \"sort_field\": \"user_name\",\n \"sort_order\": \"desc\"\n}","options":{"raw":{"language":"json"}}},"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":"Unauthorized","code":401,"_postman_previewlanguage":null,"header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"66"},{"key":"Connection","value":"keep-alive"},{"key":"Date","value":"Wed, 04 Feb 2026 02:06:42 GMT"},{"key":"Access-Control-Allow-Origin","value":"https://cyberready.right-hand.ai"},{"key":"Set-Cookie","value":"AWSALB=OTaG/n6V7Aiejfz7PSta6tb2OABaKbKX98SjCurNV5knrpUqD1Of5u9hqS+/AnsHNyUyfBPC1mdId0a+JzW2XuuOu52xAQRhCiX5gvWfeKuMg5RhdK6E8yH5vKfO; Expires=Wed, 11 Feb 2026 02:06:42 GMT; Path=/"},{"key":"Set-Cookie","value":"AWSALBCORS=OTaG/n6V7Aiejfz7PSta6tb2OABaKbKX98SjCurNV5knrpUqD1Of5u9hqS+/AnsHNyUyfBPC1mdId0a+JzW2XuuOu52xAQRhCiX5gvWfeKuMg5RhdK6E8yH5vKfO; Expires=Wed, 11 Feb 2026 02:06:42 GMT; Path=/; SameSite=None; Secure"},{"key":"Server","value":"Werkzeug/2.2.2 Python/3.12.6"},{"key":"X-Cache","value":"Error from cloudfront"},{"key":"Via","value":"1.1 f91f0310a52084f5e83e3c1142ad882c.cloudfront.net (CloudFront)"},{"key":"X-Amz-Cf-Pop","value":"IAD61-P9"},{"key":"Alt-Svc","value":"h3=\":443\"; ma=86400"},{"key":"X-Amz-Cf-Id","value":"bByK_ItAPYzw97oaNw39O3bg8sPpH0aqtslkt82FnuXfIRwRmzHCBA=="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Token validation failed\",\n \"status_code\": 401\n}"}],"_postman_id":"a7ae5262-6628-4099-a69a-e4a4c0d8f432"}],"id":"5481dc06-7399-46b4-80ce-70e43d326c6e","_postman_id":"5481dc06-7399-46b4-80ce-70e43d326c6e","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":"93356d0b-0992-49d7-bdfb-dae2f7c51e75","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":"71501d13-2349-436e-b83e-e138755d7a38"}],"id":"30f20c50-3189-40fb-aba6-c3eb06da551e","_postman_id":"30f20c50-3189-40fb-aba6-c3eb06da551e","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"