Teramind Tools
Written By Christopher Scaminaci
Last updated 7 days ago
Teramind Tools
teramind_ · 222 tools · Free 119 · Pro 103
Employee monitoring, insider-threat and user-behavior analytics, with workforce time tracking on the same instance. The credential is a single access token that inherits the authority of the dashboard user who created it and is rotated by hand; there is no scope model and no published expiry. The base address is your own instance - a cloud subdomain or a host you chose for an on-premises or private-cloud install - so a blank value is refused. Page size is capped at 200 as a safety limit; the vendor states no maximum. Two paging models split by family: report grids and business intelligence take a zero-based page with sort and filter, while some list reads take offset and limit. Neither is cursor-based. Pacing is deliberately conservative because concurrent sessions, not throughput, are the binding limit. Much of the business-intelligence surface is POST and still reads nothing but data, so those tools stay Free and read-only.
All connector tools · Teramind setup guide
Teramind tool groups
- Agent deployment — 1 tool
- Computers — 11 tools
- Departments — 5 tools
- Employees — 6 tools
- Licensing — 1 tool
- Server — 1 tool
- Report exports — 3 tools
- Reports — 23 tools
- Business intelligence — 24 tools
- Business intelligence filters — 12 tools
- Alerts — 2 tools
- Anomaly rules — 9 tools
- Behavior policies — 19 tools
- Monitoring policies — 5 tools
- Monitoring profiles — 4 tools
- Monitoring rules — 4 tools
- Shared lists — 6 tools
- Productivity profiles — 11 tools
- Schedules — 15 tools
- Tasks — 6 tools
- Time tracker tasks — 5 tools
- Time tracking reports — 6 tools
- Activities — 4 tools
- Session player — 1 tool
- Session tags — 5 tools
- Video exports — 3 tools
- Access tokens — 2 tools
- Data ingestion — 1 tool
- Instance — 3 tools
- LDAP directory — 5 tools
- Report settings — 18 tools
- SMTP — 1 tool
Agent deployment
teramind_get_agent_download_links details
teramind_get_agent_download_links details
[Teramind] Get agent download links. GET /tm-api/download/links. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Computers
teramind_create_computer_notification details
teramind_create_computer_notification details
[Teramind] DESTRUCTIVE: add notification. Why this is destructive: pushes an on-screen notification to the monitored endpoint — reaches a human. POST /tm-api/computer-notification. Send the request body as JSON; Teramind documents these fields: computer_id, mailto. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_computer details
teramind_delete_computer details
[Teramind] DESTRUCTIVE: computer - Delete computer. Why this is destructive: delete semantics. DELETE /tm-api/computer/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_computer_notification details
teramind_delete_computer_notification details
[Teramind] DESTRUCTIVE: delete notification. Why this is destructive: delete semantics. DELETE /tm-api/computer-notification/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_disable_computer_monitoring details
teramind_disable_computer_monitoring details
[Teramind] DESTRUCTIVE: disable computer monitoring. Why this is destructive: live change on a monitored endpoint; stops evidence capture. POST /tm-api/computer//disable-monitoring. Path parameters: id. Send the request body as JSON; Teramind documents these fields: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_enable_computer_monitoring details
teramind_enable_computer_monitoring details
[Teramind] DESTRUCTIVE: enable computer monitoring. Why this is destructive: live change on a monitored endpoint; starts surveillance capture on a person. POST /tm-api/computer//enable-monitoring. Path parameters: id. Send the request body as JSON; Teramind documents these fields: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_computer details
teramind_get_computer details
[Teramind] Get computer. GET /tm-api/computer/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_computer_notifications details
teramind_list_computer_notifications details
[Teramind] Get computer notifications. GET /tm-api/computer-notification. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_computers details
teramind_list_computers details
[Teramind] Get computers. GET /tm-api/computer. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_restore_computer details
teramind_restore_computer details
[Teramind] Restore computer. POST /tm-api/computer//restore. Path parameters: id. Send the request body as JSON; Teramind documents these fields: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_computer details
teramind_update_computer details
[Teramind] DESTRUCTIVE: update computer. PUT /tm-api/computer/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_computer_notification details
teramind_update_computer_notification details
[Teramind] DESTRUCTIVE: update notification. PUT /tm-api/computer-notification/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: computer_notification_rule_id, computer_id, mailto. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Departments
teramind_create_department details
teramind_create_department details
[Teramind] Create department. POST /tm-api/department. Send the request body as JSON; Teramind documents these fields: name, description, managers, agent_id, permission_mask, agents, preserve_agents. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_department details
teramind_delete_department details
[Teramind] DESTRUCTIVE: delete department. Why this is destructive: delete semantics. DELETE /tm-api/department/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_department details
teramind_get_department details
[Teramind] Single depatment. GET /tm-api/department/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_departments details
teramind_list_departments details
[Teramind] List departments. GET /tm-api/department. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_department details
teramind_update_department details
[Teramind] DESTRUCTIVE: update department. PUT /tm-api/department/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: name, description, managers, agents, preserve_agents. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Employees
teramind_create_agent details
teramind_create_agent details
[Teramind] DESTRUCTIVE: create Agent. Why this is destructive: creates a dashboard identity and can set role=Administrator — privilege-widening. POST /tm-api/agent. Send the request body as JSON; Teramind documents these fields: flags, rate, role, department_id, salary_type, name, deleted, __loaded, tracking_profile_id, first_name, last_name, email_Address. Teramind documents 5 more fields; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_agent details
teramind_delete_agent details
[Teramind] DESTRUCTIVE: delete agent. Why this is destructive: delete semantics. DELETE /tm-api/agent/. Path parameters: id. Optional filters: tempHash. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_agent details
teramind_get_agent details
[Teramind] Get agent data. GET /tm-api/v1/agents/. Path parameters: id. Optional filters: fields. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_agents details
teramind_list_agents details
[Teramind] List agents. GET /tm-api/agent. Optional filters: showDeleted. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_agents_detailed details
teramind_list_agents_detailed details
[Teramind] Get agents' data. GET /tm-api/v1/agents. Optional filters: fields. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_agent details
teramind_update_agent details
[Teramind] DESTRUCTIVE: update agent. Why this is destructive: PATCH partial merge, but can set role/flags — privilege-widening. PATCH /tm-api/agent/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: agent_id, current_task, default_agent_dashboard_id, default_task_id, default_wage, department_id, email_address, emergency_phone, face, face_lg, first_name, last_name. Teramind documents 14 more fields; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Licensing
teramind_get_license_usage details
teramind_get_license_usage details
[Teramind] Get license usage information. GET /tm-api/license/usage. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Server
teramind_get_server_time details
teramind_get_server_time details
[Teramind] Show server time. GET /tm-api/time. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Report exports
teramind_classify_activities details
teramind_classify_activities details
[Teramind] DESTRUCTIVE: classify activities. Why this is destructive: arbitrary "action" string over a bulk activity-id set. POST /tm-api/report/web-pages-applications/batch. Send the request body as JSON; Teramind documents these fields: ids, action, aggregate. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_deploy_batch_action details
teramind_deploy_batch_action details
[Teramind] DESTRUCTIVE: run Deploy Status Report batch actions. Why this is destructive: arbitrary "action" string — deploy/uninstall-class actions against endpoints. POST /tm-api/deploy/batch. Send the request body as JSON; Teramind documents these fields: action. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_employees_batch_action details
teramind_employees_batch_action details
[Teramind] DESTRUCTIVE: run Employees report batch actions. Why this is destructive: arbitrary "action" string over employee rows. POST /tm-api/report/employees/batch. Send the request body as JSON; Teramind documents these fields: action. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Reports
teramind_computers_report details
teramind_computers_report details
[Teramind] Computers report. POST /tm-api/report/computers/grid. Send the request body as JSON; Teramind documents these fields: computers, sortCol, sortDir, filter, viewMode. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_console_commands_report details
teramind_console_commands_report details
[Teramind] Console Commands report. POST /tm-api/report/cli/grid. Send the request body as JSON; Teramind documents these fields: agents, computers, departments, filter, page, periodStart, periodEnd, sortCol, sortDir. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_deploy_status_report details
teramind_deploy_status_report details
[Teramind] Deploy status report. POST /tm-api/report/deploy/grid. Send the request body as JSON; Teramind documents these fields: filter optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional, deploy_id optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_disappeared_report details
teramind_disappeared_report details
[Teramind] Disappeared Employees/Computers report. POST /tm-api/report/disappeared/grid. Send the request body as JSON; Teramind documents these fields: filter optional, agents optional, computers optional, periodStart optional, periodEnd optional, sortCol optional, sortDir optional, before optional, notMonitoredDaysCount, MonitoredDaysCount, type. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_emailing_report details
teramind_emailing_report details
[Teramind] Emailing report. POST /tm-api/report/emails/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, departments optional, filter optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional, attachmentsOnly optional, client optional, direction optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_employees_report details
teramind_employees_report details
[Teramind] Employees report. POST /tm-api/report/employees/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, departments optional, filter optional, page optional, periodStart, periodEnd, sortCol, sortDir, employeeStates, employeeRoles. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_file_transfers_report details
teramind_file_transfers_report details
[Teramind] File Transfers report. POST /tm-api/report/file-transfers/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, department optional, filter optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional, chartSeries optional, operation optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_report_export_status details
teramind_get_report_export_status details
[Teramind] Report export status. GET /tm-api/report/export/status. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_im_conversation_report details
teramind_im_conversation_report details
[Teramind] Conversation report. POST /tm-api/report/im/conversation. Send the request body as JSON; Teramind documents these fields: conversation, sourceType, periodStart, periodEnd, offset optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_instant_messaging_report details
teramind_instant_messaging_report details
[Teramind] Instant Messaging report. POST /tm-api/report/im/grid. Send the request body as JSON; Teramind documents these fields: agents, computers, departments, conversations, filter optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional, source optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_keystrokes_report details
teramind_keystrokes_report details
[Teramind] Keystrokes report. POST /tm-api/report/keystrokes/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, department optional, filter optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional, activity. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_report_exports details
teramind_list_report_exports details
[Teramind] List report export tasks. POST /tm-api/report/export/grid. Send the request body as JSON; Teramind documents these fields: sortColumn optional, sortDir optional, periodStart, periodEnd. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_network_monitoring_report details
teramind_network_monitoring_report details
[Teramind] Network Monitoring report. POST /tm-api/report/net-connections/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, departments optional, filter optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional, aggregate optional, http optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_notifications_report details
teramind_notifications_report details
[Teramind] Notificatons report. POST /tm-api/report/notifications/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, departments optional, periodStart, periodEnd, sortCol optional, sortDir optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_printing_report details
teramind_printing_report details
[Teramind] Printing report. POST /tm-api/report/printing/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, departments optional, filter optional, page optional, periodStart, periodEnd, sortCol, sortDir. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_searches_report details
teramind_searches_report details
[Teramind] Searches report. POST /tm-api/report/searches/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, departments optional, filter optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_sessions_report details
teramind_sessions_report details
[Teramind] Sessions report. POST /tm-api/report/sessions/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, departments optional, filter optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_social_media_report details
teramind_social_media_report details
[Teramind] Social Media report. POST /tm-api/report/sm/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, departments optional, filter optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional, source optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_storage_report details
teramind_storage_report details
[Teramind] Storage report. POST /tm-api/report/storage/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, periodStart, periodEnd, filter optional, sortCol optional, sortDir optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_system_log_audit_report details
teramind_system_log_audit_report details
[Teramind] System Log (Audit) report. POST /tm-api/report/audit/grid. Send the request body as JSON; Teramind documents these fields: agents optional, departments optional, computers optional, tasks optional, filter optional, sortCol optional, sortDir optional, page optional, periodStart, periodEnd, customFilter optional, partial optional. Teramind documents 3 more fields; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_video_export_report details
teramind_video_export_report details
[Teramind] Video Export report. POST /tm-api/report/video-export/grid. Send the request body as JSON; Teramind documents these fields: agents optional, departments, computers, tasks, sortCol, sortDir, page, periodStart, periodEnd, customFilter, partial, hideUnavailable. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_voip_monitoring_report details
teramind_voip_monitoring_report details
[Teramind] Voip monitoring report. POST /tm-api/report/voip/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, periodStart, periodEnd, filter optional, sortCol optional, sortDir optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_web_and_applications_report details
teramind_web_and_applications_report details
[Teramind] Web & Applications report. POST /tm-api/report/web-pages-applications/grid. Send the request body as JSON; Teramind documents these fields: agents optional, computers optional, departments optional, filter optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional, type optional, aggregate optional, classify optional. Teramind documents 1 more field; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Business intelligence
teramind_bi_add_new_widget details
teramind_bi_add_new_widget details
[Teramind] Add new widget. POST /tm-api/wip/tma-report/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: widgets, name, type, chart, query, order, dims, measures, cube, w, h, y. Teramind documents 1 more field; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_bi_autoexport details
teramind_bi_autoexport details
[Teramind] DESTRUCTIVE: autoexport. POST /tm-api/wip/tma-report/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: exports, settings, sameLayout, autoExport, enabled, period, emails, time, days, monthDay. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_bi_chart_application_and_webpages details
teramind_bi_chart_application_and_webpages details
[Teramind] Chart - Application & Webpages. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence activity cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_chart_behavior_alert details
teramind_bi_chart_behavior_alert details
[Teramind] Chart - Behavior alert. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence behavior_alert cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_chart_console_commands details
teramind_bi_chart_console_commands details
[Teramind] Chart - Console commands. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence console_cmd cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_chart_emails details
teramind_bi_chart_emails details
[Teramind] Chart - Emails. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_chart_input_rate details
teramind_bi_chart_input_rate details
[Teramind] Chart - Input rate. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence input_rate cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_chart_keystrokes details
teramind_bi_chart_keystrokes details
[Teramind] Chart - Keystrokes. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence keystrokes cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_chart_login_session details
teramind_bi_chart_login_session details
[Teramind] Chart - Login session. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence login_session cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_chart_printed_document details
teramind_bi_chart_printed_document details
[Teramind] Chart - Printed document. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence printed_doc cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_chart_social_media details
teramind_bi_chart_social_media details
[Teramind] Chart - Social media. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence social_media cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_chart_web_search details
teramind_bi_chart_web_search details
[Teramind] Chart - Web search. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence web_search cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_chart_work_time details
teramind_bi_chart_work_time details
[Teramind] Chart - Work time. POST /tm-api/wip/tma-chart. Queries the Teramind business-intelligence work_time cube and returns it as a chart series. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_clone_report details
teramind_bi_clone_report details
[Teramind] Clone Report. POST /tm-api/wip/tma-report. Send the request body as JSON; Teramind documents these fields: name, widgets, tabs, filters, h, w, x, y, cube, type, chart, query. Teramind documents 13 more fields; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_bi_grid_activity details
teramind_bi_grid_activity details
[Teramind] Grid - Activity. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence activity cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_grid_behavior_alert details
teramind_bi_grid_behavior_alert details
[Teramind] Grid - Behavior alert. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence behavior_alert cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_grid_console_cmd details
teramind_bi_grid_console_cmd details
[Teramind] Grid - Console cmd. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence console_cmd cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_grid_input_rate details
teramind_bi_grid_input_rate details
[Teramind] Grid - Input rate. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence input_rate cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_grid_keystrokes details
teramind_bi_grid_keystrokes details
[Teramind] Grid - Keystrokes. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence keystrokes cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_grid_login_session details
teramind_bi_grid_login_session details
[Teramind] Grid - Login session. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence login_session cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_grid_printed_doc details
teramind_bi_grid_printed_doc details
[Teramind] Grid - Printed doc. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence printed_doc cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_grid_social_media details
teramind_bi_grid_social_media details
[Teramind] Grid - Social media. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence social_media cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_grid_web_search details
teramind_bi_grid_web_search details
[Teramind] Grid - Web search. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence web_search cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_grid_work_time details
teramind_bi_grid_work_time details
[Teramind] Grid - Work time. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence work_time cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
Business intelligence filters
teramind_bi_filter_applications_and_webpages details
teramind_bi_filter_applications_and_webpages details
[Teramind] Applications & webpages filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence activity cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_behavior_alerts details
teramind_bi_filter_behavior_alerts details
[Teramind] Behavior alerts - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence behavior_alert cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_console_commands details
teramind_bi_filter_console_commands details
[Teramind] Console commands - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence console_cmd cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_emails details
teramind_bi_filter_emails details
[Teramind] Emails - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence mail cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_file_events details
teramind_bi_filter_file_events details
[Teramind] File events - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence file_event cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_keystrokes details
teramind_bi_filter_keystrokes details
[Teramind] Keystrokes - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence keystrokes cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_login_sessions details
teramind_bi_filter_login_sessions details
[Teramind] Login sessions - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence login_session cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_printing details
teramind_bi_filter_printing details
[Teramind] Printing - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence printed_doc cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_productivity details
teramind_bi_filter_productivity details
[Teramind] Productivity - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_searches details
teramind_bi_filter_searches details
[Teramind] Searches - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence web_search cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_social_media details
teramind_bi_filter_social_media details
[Teramind] Social media - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence social_media cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
teramind_bi_filter_web_file_events details
teramind_bi_filter_web_file_events details
[Teramind] Web file events - filter. POST /tm-api/wip/tma-query. Queries the Teramind business-intelligence web_file_event cube and returns it as a grid. The cube, its dimensions and its measures are built in — you supply only the date window (startDate and endDate as YYYY-MM-DD), and optionally a timezone and paging. Pass bodyJsonOverride ONLY to query a different cube or add non-date filters; it replaces the whole request body. This is a read: it creates and changes nothing. Returns raw Teramind JSON.
Alerts
teramind_list_alerts details
teramind_list_alerts details
[Teramind] List the behavior alerts raised against monitored users. GET /tm-api/v1/alerts. Optional filters: periodStart, periodEnd. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_alerts_descriptions details
teramind_list_alerts_descriptions details
[Teramind] Look up the descriptions behind behavior alerts. This is a POST that only reads: the body selects which alerts to describe. POST /tm-api/v1/alerts/descriptions. Send the request body as JSON, following Teramind's documented sample for this endpoint. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Anomaly rules
teramind_create_anomaly_rule details
teramind_create_anomaly_rule details
[Teramind] DESTRUCTIVE: create anomaly rule. Why this is destructive: arms an automated behavior rule (alert/warn/block/lock actions). POST /tm-api/behavior-rule. Send the request body as JSON; Teramind documents these fields: name, rule_type, rule_subtype, risk_quotient, accumulates_risk, max_count optional, notification_threshold optional, log_threshold optional, actions optional, action_type, action_params, triggers optional. Teramind documents 12 more fields; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_create_anomaly_rule_template details
teramind_create_anomaly_rule_template details
[Teramind] Create an anomaly rule template. Not destructive: a template is a starting point and enforces nothing until a rule is created from it. POST /tm-api/behavior-rule/templates. Send the request body as JSON; Teramind documents these fields: name, data. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_anomaly_rule details
teramind_delete_anomaly_rule details
[Teramind] DESTRUCTIVE: delete an anomaly rule. Why this is destructive: the rule is removed permanently, so the behavior it was detecting stops being detected and stops raising alerts. DELETE /tm-api/behavior-rule/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_anomaly_rule details
teramind_get_anomaly_rule details
[Teramind] Get one anomaly rule by id, with its triggers and its actions. GET /tm-api/behavior-rule/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_anomaly_rule_list details
teramind_get_anomaly_rule_list details
[Teramind] List the anomaly rules. These are the behavior-analytics rules, and each one can carry alert, warn, block or lock actions. GET /tm-api/behavior-rule. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_anomaly_rule_tags details
teramind_get_anomaly_rule_tags details
[Teramind] List the tags used on anomaly rules. GET /tm-api/behavior-rule/tags. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_anomaly_rule_template details
teramind_get_anomaly_rule_template details
[Teramind] Get one anomaly rule template by id. A template is a starting point and enforces nothing on its own. GET /tm-api/behavior-rule/templates/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_anomaly_rule_templates_tree details
teramind_get_anomaly_rule_templates_tree details
[Teramind] Get the anomaly rule templates as the dashboard tree. GET /tm-api/behavior-rule/templates. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_anomaly_rule details
teramind_update_anomaly_rule details
[Teramind] DESTRUCTIVE: update anomaly rule. Why this is destructive: changes an armed behavior rule. PATCH /tm-api/behavior-rule/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: name, rule_type, rule_subtype, risk_quotient, accumulates_risk, max_count optional, notification_threshold optional, log_threshold optional, actions optional, action_type, action_params, triggers optional. Teramind documents 13 more fields; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Behavior policies
teramind_clone_behavior_policy details
teramind_clone_behavior_policy details
[Teramind] DESTRUCTIVE: clone or move a behavior policy. Why this is destructive: the copy lands in a group where its warn, block and lock actions apply to real people, and it takes a place in the evaluation order that decides which rule wins. POST /tm-api/behavior-policy//clone. Path parameters: id. Send the request body as JSON; Teramind documents these fields: mode, group, withAssignments optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_create_behavior_group details
teramind_create_behavior_group details
[Teramind] Create a behavior policy group. Not destructive: an empty group enforces nothing until policies are added to it. POST /tm-api/behavior-group. Send the request body as JSON; Teramind documents these fields: name, assignments, assignment_type, assignment_id, exclude. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_create_policy details
teramind_create_policy details
[Teramind] DESTRUCTIVE: create policy. Why this is destructive: arms an enforcement policy that can warn/block/lock users. POST /tm-api/behavior-policy. Send the request body as JSON; Teramind documents these fields: behavior_group_id, active, draft, type, params, name, assignments, assignment_type, assignment_id, exclude, tags. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_behavior_group details
teramind_delete_behavior_group details
[Teramind] DESTRUCTIVE: delete a behavior policy group. Why this is destructive: the group is removed permanently, and the enforcement it carried stops applying to the people assigned to it. DELETE /tm-api/behavior-group/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_policy details
teramind_delete_policy details
[Teramind] DESTRUCTIVE: delete a behavior policy. Why this is destructive: the policy is removed permanently, so the warn, block and lock actions it applied to real people stop. DELETE /tm-api/behavior-policy/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_behavior_group details
teramind_get_behavior_group details
[Teramind] Get one behavior policy group by id, with the policies and the assignments it carries. GET /tm-api/behavior-group/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_behavior_policy_misc details
teramind_get_behavior_policy_misc details
[Teramind] Get the rule tags and the rule templates available to behavior policies, in one call. GET /tm-api/behavior-policy/misc. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_behavior_policy_rule_tags details
teramind_get_behavior_policy_rule_tags details
[Teramind] List the rule tags available to behavior policies. GET /tm-api/behavior-policy/tags. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_behavior_policy_rule_templates details
teramind_get_behavior_policy_rule_templates details
[Teramind] List the rule templates available to behavior policies. GET /tm-api/behavior-policy/templates. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_demo_policy details
teramind_get_demo_policy details
[Teramind] Get the vendor demo policy for a policy type. It is a read-only sample and enforces nothing. GET /tm-api/behavior-policy/demo/. Path parameters: type. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_policy details
teramind_get_policy details
[Teramind] Get one behavior policy by id, with its actions and its assignments. GET /tm-api/behavior-policy/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_import_behavior_policy_group details
teramind_import_behavior_policy_group details
[Teramind] DESTRUCTIVE: import a behavior policy group from a file. Why this is destructive: every policy inside the imported group arrives armed, so warn, block and lock actions can start applying to the people it is assigned to. POST /tm-api/behavior-group/import. Send the request body as JSON; Teramind documents these fields: file. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_import_behavior_policy_into_group details
teramind_import_behavior_policy_into_group details
[Teramind] DESTRUCTIVE: import a behavior policy into an existing group. Why this is destructive: the imported policy arrives armed and takes a place in that group evaluation order, so it changes what is warned, blocked or locked. POST /tm-api/behavior-group//import. Path parameters: id. Send the request body as JSON; Teramind documents these fields: file. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_behavior_groups details
teramind_list_behavior_groups details
[Teramind] List the behavior policy groups. Group order is evaluation order. GET /tm-api/behavior-group. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_policies details
teramind_list_policies details
[Teramind] List the behavior policies, flat. Use the tree-view tool when the group and the order matter. GET /tm-api/behavior-policy. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_policies_tree_view details
teramind_list_policies_tree_view details
[Teramind] List the behavior policies as the dashboard tree: groups with their policies, in evaluation order. GET /tm-api/behavior-policy/tree. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_reorder_behavior_groups details
teramind_reorder_behavior_groups details
[Teramind] DESTRUCTIVE: reorder groups. Why this is destructive: changes policy evaluation order = changes what is enforced. POST /tm-api/behavior-group/reorder. Send the request body as JSON; Teramind documents these fields: groups. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_behavior_group details
teramind_update_behavior_group details
[Teramind] DESTRUCTIVE: update a behavior policy group. Why this is destructive: the active flag arms or disarms every policy in the group, and the assignments decide which people those policies act on. PATCH /tm-api/behavior-group/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: name, active, assignments, assignment_type, assignment_id, exclude. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_policy details
teramind_update_policy details
[Teramind] DESTRUCTIVE: update a behavior policy. Why this is destructive: this rewrites a live enforcement policy, including its actions, its active flag and the people it applies to, so it changes what warns, blocks or locks a real person. PATCH /tm-api/behavior-policy/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: policy, name, active, draft, assignments, assignment_type, assignment_id, exclude, tags, behavior_group_id, type, params. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Monitoring policies
teramind_create_monitoring_policy details
teramind_create_monitoring_policy details
[Teramind] DESTRUCTIVE: add new policy. Why this is destructive: arms a monitoring/enforcement policy. POST /tm-api/policy. Send the request body as JSON; Teramind documents these fields: name, subjects, rules, id, features, feature, ac_rule, objects, ext_id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_monitoring_policy details
teramind_delete_monitoring_policy details
[Teramind] DESTRUCTIVE: delete a monitoring policy. Why this is destructive: the policy is removed permanently, and the monitoring and enforcement it applied to its subjects stops. DELETE /tm-api/policy/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_rename_monitoring_policy details
teramind_rename_monitoring_policy details
[Teramind] Rename a monitoring policy. Not destructive: the name is a label, and what the policy enforces is unchanged. PUT /tm-api/policy/name. Send the request body as JSON; Teramind documents these fields: id, name. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_set_monitoring_policy_subjects details
teramind_set_monitoring_policy_subjects details
[Teramind] DESTRUCTIVE: change policy subjects. Why this is destructive: changes WHO a monitoring/enforcement policy applies to. PUT /tm-api/policy/user. Send the request body as JSON; Teramind documents these fields: id, users. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_monitoring_policy details
teramind_update_monitoring_policy details
[Teramind] DESTRUCTIVE: update a monitoring policy, wholesale. Why this is destructive: the body replaces the policy rules, its subjects and its features, so it changes what is recorded about real people and what is enforced against them. PUT /tm-api/policy/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: id, policy, name, subjects, ext_type, ext_id, rules, objects, index, features, feature, access. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Monitoring profiles
teramind_create_monitoring_profile details
teramind_create_monitoring_profile details
[Teramind] Create a monitoring profile. Not destructive: the profile records nothing until it is assigned to a computer or an agent. POST /tm-api/v1/monitoring-profile. Optional filters: name, fields. Send the request body as JSON, following Teramind's documented sample for this endpoint. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_monitoring_profile details
teramind_delete_monitoring_profile details
[Teramind] DESTRUCTIVE: delete a monitoring profile. Why this is destructive: the profile is removed permanently, and the endpoints that used it stop recording what it defined. DELETE /tm-api/v1/monitoring-profile/. Path parameters: id. Optional filters: name, fields. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_monitoring_profiles details
teramind_list_monitoring_profiles details
[Teramind] List the monitoring profiles. A profile decides what an agent records on an endpoint, such as screen, keystrokes, email, web and file activity. GET /tm-api/v1/monitoring-profile. Optional filters: name, fields. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_monitoring_profile details
teramind_update_monitoring_profile details
[Teramind] DESTRUCTIVE: update monitoring profile. Why this is destructive: wholesale replace; changes what is recorded on live endpoints. PUT /tm-api/v1/monitoring-profile. Optional filters: name, fields. Send the request body as JSON; Teramind documents these fields: ad_group_id, agent_id, computer_id, department_id, details, tracking_profile_id, name, description, private. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Monitoring rules
teramind_create_monitoring_rule details
teramind_create_monitoring_rule details
[Teramind] DESTRUCTIVE: add new rule. Why this is destructive: arms a rule that can act on users. POST /tm-api/rule. Send the request body as JSON; Teramind documents these fields: policyId, users, features. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_monitoring_rule details
teramind_delete_monitoring_rule details
[Teramind] DESTRUCTIVE: delete a monitoring rule. Why this is destructive: the rule is removed permanently, so what it captured and enforced against its subjects stops. DELETE /tm-api/rule. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_monitoring_rule_features details
teramind_update_monitoring_rule_features details
[Teramind] DESTRUCTIVE: update the features of a monitoring rule. Why this is destructive: features decide what the rule captures and what it does, including blocking an action or locking the user out. PUT /tm-api/rule/features. Send the request body as JSON; Teramind documents these fields: id, features. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_monitoring_rule_subjects details
teramind_update_monitoring_rule_subjects details
[Teramind] DESTRUCTIVE: update the subjects of a monitoring rule. Why this is destructive: this changes WHO the rule applies to, and anyone added here is monitored and acted on from the next evaluation. PUT /tm-api/rule/user. Send the request body as JSON; Teramind documents these fields: id, users. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Shared lists
teramind_create_or_update_shared_list details
teramind_create_or_update_shared_list details
teramind_create_or_update_shared_list_entries details
teramind_create_or_update_shared_list_entries details
teramind_delete_shared_list details
teramind_delete_shared_list details
teramind_delete_shared_list_entries details
teramind_delete_shared_list_entries details
teramind_get_shared_list details
teramind_get_shared_list details
teramind_get_shared_lists details
teramind_get_shared_lists details
Productivity profiles
teramind_add_productivity_profile_rule details
teramind_add_productivity_profile_rule details
[Teramind] Add a classification rule to a productivity profile. Not destructive: it adds a rule and removes none, but it does change how activity is scored for the people the profile covers. POST /tm-api/v1/productivity-profile//rule. Path parameters: profileId. Send the request body as JSON; Teramind documents these fields: profile_version, type, mode, value. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_create_productivity_profile details
teramind_create_productivity_profile details
[Teramind] Create a productivity profile. Not destructive: a new profile scores nobody until it is assigned. POST /tm-api/v1/productivity-profile. Send the request body as JSON; Teramind documents these fields: name, parent_id, retroactive, assignments, type, id, options. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_productivity_profile details
teramind_delete_productivity_profile details
[Teramind] DESTRUCTIVE: delete a productivity profile. Why this is destructive: the profile is removed permanently, and the people assigned to it lose the classification their productivity scoring was based on. DELETE /tm-api/v1/productivity-profile/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_productivity_profile_rule details
teramind_delete_productivity_profile_rule details
[Teramind] DESTRUCTIVE: delete a rule from a productivity profile. Why this is destructive: the rule is removed permanently, so the activity it classified is scored differently from now on. DELETE /tm-api/v1/productivity-profile//rule/. Path parameters: profileId, ruleId. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_assigned_productivity_profile details
teramind_get_assigned_productivity_profile details
[Teramind] Get the productivity profile that is assigned, for the scope the query names. GET /tm-api/v1/productivity-profile-assigned. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_productivity_profile details
teramind_get_productivity_profile details
[Teramind] Get one productivity profile by id, with its rules. GET /tm-api/v1/productivity-profile/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_import_productivity_profile_rules details
teramind_import_productivity_profile_rules details
[Teramind] DESTRUCTIVE: import productivity profile rules from a CSV file. Why this is destructive: the mode flag can replace the rules already in the profile, which re-scores every person the profile covers. POST /tm-api/v1/productivity-profile//import. Path parameters: profileId. Optional filters: ruleType, mode. Send the request body as JSON; Teramind documents these fields: id, ruleType, mode, convertToRegexp, file. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_productivity_profiles details
teramind_list_productivity_profiles details
[Teramind] List the productivity profiles. A profile decides which applications and sites count as productive. GET /tm-api/v1/productivity-profile. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_move_productivity_profile details
teramind_move_productivity_profile details
[Teramind] DESTRUCTIVE: move a productivity profile under another parent. Why this is destructive: a profile inherits from its parent, so moving it changes how the activity of the people assigned to it is classified and scored. PUT /tm-api/v1/productivity-profile/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_productivity_profile details
teramind_update_productivity_profile details
[Teramind] DESTRUCTIVE: update a productivity profile. Why this is destructive: the profile decides what counts as productive for the people assigned to it, and that scoring feeds the reports their managers act on. PUT /tm-api/v1/productivity-profile/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: id, name. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_productivity_profile_rule details
teramind_update_productivity_profile_rule details
[Teramind] DESTRUCTIVE: update a rule inside a productivity profile. Why this is destructive: the rule decides whether an application or a site counts as productive, so changing it re-scores every person the profile covers. PUT /tm-api/v1/productivity-profile//rule/. Path parameters: profileId, ruleId. Send the request body as JSON; Teramind documents these fields: profile_version, version, type, mode, value. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Schedules
teramind_assign_schedule_template details
teramind_assign_schedule_template details
[Teramind] DESTRUCTIVE: assign a schedule template or a shift to each named agent and position. Why this is destructive: this sets the hours real people are expected to work and are then measured against. POST /tm-api/schedule/data. Send the request body as JSON; Teramind documents these fields: agent_id, position_id, schedule_template_id, shift. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_create_schedule_modification details
teramind_create_schedule_modification details
[Teramind] Create a schedule modification, an override for a single day. Not destructive: it adds an override rather than editing the base schedule, but it does change what that day is measured against. POST /tm-api/schedule/modification. Send the request body as JSON; Teramind documents these fields: date optional, agent_id optional, time_start, duration, break, off optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_create_schedule_position details
teramind_create_schedule_position details
[Teramind] Create a schedule position. Not destructive: a new position covers nobody until agents are assigned to it. POST /tm-api/schedule/position. Send the request body as JSON; Teramind documents these fields: position_name, schedule_data. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_create_schedule_template details
teramind_create_schedule_template details
[Teramind] Create a schedule template. Not destructive: a template governs nobody until it is assigned to an agent or a position. POST /tm-api/schedule/template. Send the request body as JSON; Teramind documents these fields: name, schedule_data. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_schedule_modification details
teramind_delete_schedule_modification details
[Teramind] DESTRUCTIVE: delete a schedule modification. Why this is destructive: the override is removed permanently, so that day reverts to the base schedule and attendance for it is measured differently. DELETE /tm-api/schedule/modification/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_schedule_position details
teramind_delete_schedule_position details
[Teramind] DESTRUCTIVE: delete a schedule position. Why this is destructive: the position is removed permanently, along with the schedule the people in it were measured against. DELETE /tm-api/schedule/position/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_schedule_template details
teramind_delete_schedule_template details
[Teramind] DESTRUCTIVE: delete a schedule template. Why this is destructive: the template is removed permanently, and the agents assigned to it lose the hours they were measured against. DELETE /tm-api/schedule/template/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_schedule_modifications details
teramind_list_schedule_modifications details
[Teramind] List the schedule modifications that exist. A modification overrides a single day for one person. GET /tm-api/schedule/modification. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_schedule_positions details
teramind_list_schedule_positions details
[Teramind] List the schedule positions that exist. GET /tm-api/schedule/position. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_schedule_templates details
teramind_list_schedule_templates details
[Teramind] List the schedule templates that exist. GET /tm-api/schedule/template. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_schedules details
teramind_list_schedules details
[Teramind] List the schedules that exist. A schedule sets the hours a person is measured against. GET /tm-api/schedule/data. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_schedule_modification details
teramind_update_schedule_modification details
[Teramind] DESTRUCTIVE: update a schedule modification. Why this is destructive: a modification overrides a single day for one person, including start time, duration, break and time off, so it changes their attendance and payroll-bearing records. PUT /tm-api/schedule/modification/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: schedule_modification_id, date optional, agent_id optional, time_start, duration, break, off optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_schedule_position details
teramind_update_schedule_position details
[Teramind] DESTRUCTIVE: update a schedule position. Why this is destructive: the position carries the schedule that the people in it are measured against. PUT /tm-api/schedule/position/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: position_name, schedule_data. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_schedule_template details
teramind_update_schedule_template details
[Teramind] DESTRUCTIVE: update a schedule template. Why this is destructive: every agent assigned to the template picks up the new hours, so it changes what those people are expected to work. PUT /tm-api/schedule/template/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: name, schedule_data. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_upsert_schedule details
teramind_upsert_schedule details
[Teramind] DESTRUCTIVE: create a schedule, or update an existing one. Why this is destructive: a schedule sets the working hours a real person is measured against, and late, absent and overtime reporting follows from it. PUT /tm-api/schedule/data. Send the request body as JSON; Teramind documents these fields: schedule_data_id optional, schedule_template_id optional, agent_id optional, position_id optional, day, time_start, duration, break, off. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Tasks
teramind_create_task details
teramind_create_task details
[Teramind] Create a task. Not destructive: it adds a task and changes no existing time record. POST /tm-api/v1/tasks. Send the request body as JSON; Teramind documents these fields: parent_id, name, description optional, is_trackable, is_archived optional, assignment. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_active_tasks details
teramind_get_active_tasks details
[Teramind] List the tasks that are currently being worked on. GET /tm-api/v1/tasks/active. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_assigned_tasks details
teramind_get_assigned_tasks details
[Teramind] List the tasks that are assigned to agents. GET /tm-api/v1/tasks/assigned. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_task details
teramind_get_task details
[Teramind] Get one task by id. GET /tm-api/v1/tasks/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_tasks details
teramind_list_tasks details
[Teramind] List every task. GET /tm-api/v1/tasks. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_task details
teramind_update_task details
[Teramind] DESTRUCTIVE: update a task. Why this is destructive: the assignment and the trackable and archived flags decide whose time lands on this task, and time already recorded is reported against it. PUT /tm-api/v1/tasks/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: parent_id optional, name optional, description optional, is_trackable optional, is_archived optional, assignment optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Time tracker tasks
teramind_add_time_tracker_note details
teramind_add_time_tracker_note details
[Teramind] Add a note to the time-tracker history. Not destructive: it appends a note and edits no time record. POST /tm-api/v1/time-tracker/note. Send the request body as JSON; Teramind documents these fields: task_id, note, update. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_time_tracker_history details
teramind_get_time_tracker_history details
[Teramind] Get the time-tracker history: the clock-in, clock-out and note entries. GET /tm-api/v1/time-tracker/history. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_time_tracker_status details
teramind_get_time_tracker_status details
[Teramind] Get the current time-tracker status, including whether a clock is running. GET /tm-api/v1/time-tracker/status. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_time_tracker_start_clock details
teramind_time_tracker_start_clock details
[Teramind] Start the time-tracker clock on a task. Not destructive: it opens a new time record rather than editing one. POST /tm-api/v1/time-tracker/clock-in. Send the request body as JSON; Teramind documents these fields: task_id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_time_tracker_stop_clock details
teramind_time_tracker_stop_clock details
[Teramind] Stop the time-tracker clock. Not destructive: it closes the open time record rather than editing history. POST /tm-api/v1/time-tracker/clock-out. Send the request body as JSON; Teramind documents these fields: id optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Time tracking reports
teramind_add_time_record details
teramind_add_time_record details
[Teramind] DESTRUCTIVE: add or edit time records in batch. Why this is destructive: these are payroll-bearing records for real people, and one batch action can create or edit many of them at once. POST /tm-api/tt/batch-actions. Send the request body as JSON; Teramind documents these fields: actions, action, agent_id, task_id, start_time, end_time, notes. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_agent_cost_report details
teramind_agent_cost_report details
[Teramind] Agent cost report: the labor cost per agent over a period. This is a POST that only reads. POST /tm-api/tt/r/agent-cost/grid. Send the request body as JSON; Teramind documents these fields: agents optional, tasks optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_task_cost_report details
teramind_task_cost_report details
[Teramind] Task cost report: the labor cost per task over a period. This is a POST that only reads. POST /tm-api/tt/r/task-cost/grid. Send the request body as JSON; Teramind documents these fields: agents optional, tasks optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_time_card_report details
teramind_time_card_report details
[Teramind] Time card report: the per-agent time card for a period. This is a POST that only reads. POST /tm-api/tt/r/timecard. Send the request body as JSON; Teramind documents these fields: agents optional, departments optional, computers optional, tasks optional, filter optional, showEmpty optional, page optional, periodStart, periodEnd, customFilter optional, partial optional, mode optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_time_records_by_day details
teramind_time_records_by_day details
[Teramind] Time records grouped by day for a period. This is a POST that only reads. POST /tm-api/tt/r/time-records-by-day/grid. Send the request body as JSON; Teramind documents these fields: agents, departments, computers, task, filter, page, periodStart, periodEnd, customFilter, partial, splitByDay. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_time_records_report details
teramind_time_records_report details
[Teramind] Time records report: the individual time records for a period. This is a POST that only reads. POST /tm-api/tt/r/time-records/grid. Send the request body as JSON; Teramind documents these fields: agents optional, tasks optional, splitByDay optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Activities
teramind_get_aggregated_activities details
teramind_get_aggregated_activities details
[Teramind] Get aggregated activities. GET /tm-api/v1/activity/aggregated. Optional filters: from, to. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_email_activity_body details
teramind_get_email_activity_body details
[Teramind] Get content for email activity by id. GET /tm-api/activity/email//body. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_email_activity_body_html details
teramind_get_email_activity_body_html details
[Teramind] Get content for email activity by id (html document). GET /tm-api/activity/email//body-html-document. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_email_activity_info details
teramind_get_email_activity_info details
[Teramind] Get email activity info. GET /tm-api/activity/email//info. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Session player
teramind_get_player_settings details
teramind_get_player_settings details
[Teramind] Settings. GET /tm-api/player/settings. Optional filters: agent_id, computer_id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Session tags
teramind_create_player_tag details
teramind_create_player_tag details
[Teramind] Create new tag. POST /tm-api/player-tags. Send the request body as JSON; Teramind documents these fields: tag. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_create_player_timeline_tag details
teramind_create_player_timeline_tag details
[Teramind] Create new timeline tag. POST /tm-api/player-tags/timeline. Send the request body as JSON; Teramind documents these fields: computer_id, datetime, note optional, player_tag_id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_delete_player_timeline_tag details
teramind_delete_player_timeline_tag details
[Teramind] DESTRUCTIVE: delete player timeline tag. Why this is destructive: delete semantics. DELETE /tm-api/player-tags/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_player_tags details
teramind_list_player_tags details
[Teramind] List player tags. GET /tm-api/player-tags. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_player_timeline_tags details
teramind_list_player_timeline_tags details
[Teramind] List player timeline tags. GET /tm-api/player-tags/timeline. Optional filters: agent, computer, periodStart, periodEnd. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Video exports
teramind_get_video_export_status details
teramind_get_video_export_status details
[Teramind] Get export status. GET /tm-api/player/export-video/status/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_available_video_data details
teramind_list_available_video_data details
[Teramind] Available video data. GET /tm-api/player/available-video-data. Optional filters: computer, start, end. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_start_video_export details
teramind_start_video_export details
[Teramind] DESTRUCTIVE: export a video. Why this is destructive: dispatches a render job AND emails the result to a recipient. POST /tm-api/player/export-video. Send the request body as JSON; Teramind documents these fields: agents, computer, start, end, speed, recipient, soundDisabled, frameRate. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Access tokens
teramind_get_account_settings details
teramind_get_account_settings details
[Teramind] Get account settings. GET /tm-api/account. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_account_settings details
teramind_update_account_settings details
[Teramind] DESTRUCTIVE: update account. Why this is destructive: wholesale account-level settings write (timezone/currency/week start). PUT /tm-api/account/update. Send the request body as JSON, following Teramind's documented sample for this endpoint. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Data ingestion
teramind_ingest_voip_events details
teramind_ingest_voip_events details
[Teramind] Create voip events. POST /tm-api/voip-event. Send the request body as JSON; Teramind documents these fields: agent_id, computer_id, task_id, app, app_event_id, name, started_at, ended_at, is_internal, meeting_uid, participants. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Instance
teramind_get_bi_integration_status details
teramind_get_bi_integration_status details
[Teramind] Get BI integration status. GET /tm-api/instance/tma-state. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_list_activity_categories details
teramind_list_activity_categories details
[Teramind] Get all known categories. GET /tm-api/instance/tma-categories. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_reset_bi_data details
teramind_reset_bi_data details
[Teramind] DESTRUCTIVE: insert BI reset request. Why this is destructive: purges BI data (all=true resets everything; on-prem only per the vendor note). POST /tm-api/instance/tma-reset. Send the request body as JSON; Teramind documents these fields: months optional, all optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
LDAP directory
teramind_get_ldap_groups_content details
teramind_get_ldap_groups_content details
[Teramind] Get LDAP groups content. GET /tm-api/ldap/groups/content. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_ldap_settings details
teramind_get_ldap_settings details
[Teramind] Get LDAP settings. GET /tm-api/ldap. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_get_ldap_sync_status details
teramind_get_ldap_sync_status details
[Teramind] LDAP status. GET /tm-api/ldap-sync-status. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_set_ldap_settings details
teramind_set_ldap_settings details
[Teramind] DESTRUCTIVE: set LDAP settings. Why this is destructive: wholesale replace of directory-sync configuration. PUT /tm-api/ldap/. Path parameters: id. Send the request body as JSON; Teramind documents these fields: ldap_ip optional, ldap_port optional, ldap_encryption optional, domain_name optional, ldap_login optional, ldap_password optional, ldap_import_ous optional, ldap_import_groups optional, ldap_use_domain_remapping optional, ldap_limit_fetching optional, ldap_import_nested optional, ldap_sync_comp_state optional. Teramind documents 2 more fields; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_update_ldap_group_content details
teramind_update_ldap_group_content details
[Teramind] DESTRUCTIVE: update LDAP group content. Why this is destructive: KB-only (Release 672, 2024-04-29). Vendor: "A POST method can be used with the same command to change the group". Destructive: changes the AD-group mapping that decides which people are monitored, and the body shape is undocumented. Contract unverified. POST /tm-api/ldap/groups/content. An optional JSON request body is accepted; Teramind publishes no sample for this endpoint. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
Report settings
teramind_save_alerts_report_settings details
teramind_save_alerts_report_settings details
[Teramind] DESTRUCTIVE: alerts report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/alerts/settings. Send the request body as JSON; Teramind documents these fields: agents, departments, computers, tasks, filter, page, periodStart, periodEnd, customFilter, partial, aggregate, showIdleTime. Teramind documents 12 more fields; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_computers_report_settings details
teramind_save_computers_report_settings details
[Teramind] DESTRUCTIVE: computers report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/computers/settings. Send the request body as JSON; Teramind documents these fields: agents, departments, computers, tasks, filter, page, periodStart, periodEnd, customFilter, partial, aggregate, showIdleTime. Teramind documents 10 more fields; see its API docs. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_console_commands_report_settings details
teramind_save_console_commands_report_settings details
[Teramind] DESTRUCTIVE: console Commands report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/cli/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_emailing_report_settings details
teramind_save_emailing_report_settings details
[Teramind] DESTRUCTIVE: emailing report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/emails/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_employee_tasks_report_settings details
teramind_save_employee_tasks_report_settings details
[Teramind] DESTRUCTIVE: employee Tasks report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/tasks/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_employees_report_settings details
teramind_save_employees_report_settings details
[Teramind] DESTRUCTIVE: employees report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/employees/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_file_transfers_report_settings details
teramind_save_file_transfers_report_settings details
[Teramind] DESTRUCTIVE: file Transfers report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/file-transfers/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_keystrokes_report_settings details
teramind_save_keystrokes_report_settings details
[Teramind] DESTRUCTIVE: keystrokes report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/keystrokes/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_network_monitoring_report_settings details
teramind_save_network_monitoring_report_settings details
[Teramind] DESTRUCTIVE: network Monitoring report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/net-connections/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_printing_report_settings details
teramind_save_printing_report_settings details
[Teramind] DESTRUCTIVE: printing report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/printing/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_productivity_report_settings details
teramind_save_productivity_report_settings details
[Teramind] DESTRUCTIVE: productivity report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/productivity/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_searches_report_settings details
teramind_save_searches_report_settings details
[Teramind] DESTRUCTIVE: searches report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/searches/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_sessions_report_settings details
teramind_save_sessions_report_settings details
[Teramind] DESTRUCTIVE: sessions report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/sessions/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_social_media_report_settings details
teramind_save_social_media_report_settings details
[Teramind] DESTRUCTIVE: social Media report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/sm/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_storage_report_settings details
teramind_save_storage_report_settings details
[Teramind] DESTRUCTIVE: storage report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/storage/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_system_log_report_settings details
teramind_save_system_log_report_settings details
[Teramind] DESTRUCTIVE: system Log report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/audit/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_voip_report_settings details
teramind_save_voip_report_settings details
[Teramind] DESTRUCTIVE: voip report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. POST /tm-api/report/voip/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
teramind_save_web_and_applications_report_settings details
teramind_save_web_and_applications_report_settings details
[Teramind] DESTRUCTIVE: web & Applications report settings. Why this is destructive: wholesale replace of saved report settings, INCLUDING the autoExport recipient email list — schedules recurring mail to humans. BODY SHAPE: this collection entry has no sample body — take it from the two excluded duplicates Reports/"Autoexport pdf" and Reports/"Autoexport csv", which POST the same path with the complete settings + autoExport object. POST /tm-api/report/web-pages-applications/settings. Send the request body as JSON; Teramind documents these fields: autoExport, days, time, emails, period, format. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
SMTP
teramind_send_smtp_test_message details
teramind_send_smtp_test_message details
[Teramind] DESTRUCTIVE: send SMTP test message. Why this is destructive: sends real email. POST /tm-api/instance/send-test-email. Send the request body as JSON; Teramind documents these fields: to, settings, encryption, hostname, username, port, mail_from, password. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.
More in Tools Reference
Atera ToolsAuvik ToolsAvanan (Check Point Harmony Email) ToolsConnectWise Sell ToolsStill need help? Ask the team