Skip to main content
Tools Reference

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

ToolPlanAccessSummary
teramind_get_agent_download_linksFreeRead-onlyGet agent download links.

Computers

ToolPlanAccessSummary
teramind_create_computer_notificationProDestructiveDESTRUCTIVE: add notification.
teramind_delete_computerProDestructiveDESTRUCTIVE: computer - Delete computer.
teramind_delete_computer_notificationProDestructiveDESTRUCTIVE: delete notification.
teramind_disable_computer_monitoringProDestructiveDESTRUCTIVE: disable computer monitoring.
teramind_enable_computer_monitoringProDestructiveDESTRUCTIVE: enable computer monitoring.
teramind_get_computerFreeRead-onlyGet computer.
teramind_list_computer_notificationsFreeRead-onlyGet computer notifications.
teramind_list_computersFreeRead-onlyGet computers.
teramind_restore_computerProWriteRestore computer.
teramind_update_computerProDestructiveDESTRUCTIVE: update computer.
teramind_update_computer_notificationProDestructiveDESTRUCTIVE: update notification.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: computer_id, mailto.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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] 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. 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: computer_notification_rule_id, computer_id, mailto.
idintegeryesRequired. The id this call targets.

Departments

ToolPlanAccessSummary
teramind_create_departmentProWriteCreate department.
teramind_delete_departmentProDestructiveDESTRUCTIVE: delete department.
teramind_get_departmentFreeRead-onlySingle depatment.
teramind_list_departmentsFreeRead-onlyList departments.
teramind_update_departmentProDestructiveDESTRUCTIVE: update department.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: name, description, managers, agent_id, permission_mask, agents, preserve_agents.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: name, description, managers, agents, preserve_agents.
idintegeryesRequired. The id this call targets.

Employees

ToolPlanAccessSummary
teramind_create_agentProDestructiveDESTRUCTIVE: create Agent.
teramind_delete_agentProDestructiveDESTRUCTIVE: delete agent.
teramind_get_agentFreeRead-onlyGet agent data.
teramind_list_agentsFreeRead-onlyList agents.
teramind_list_agents_detailedFreeRead-onlyGet agents' data.
teramind_update_agentProDestructiveDESTRUCTIVE: update agent.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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, default_wage, yearly_wage, default_task_id, send_email, password.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. Agent ID.
tempHashstringnonullOptional. Short-lived temporary token, requested from /tm-api/agent/get-confirmation-token.

[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.

ParamTypeRequiredDefaultDescription
fieldsstringnonullOptional. string Array of requested fields (comma separated string) Allowed values: salary_type , default_wage , department_id , role , flags , deleted , status , last_web_login , position , position_id , ldap_attrs.
idintegeryesRequired. Agent ID.

[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.

ParamTypeRequiredDefaultDescription
showDeletedbooleannonullOptional. boolean Include deleted agents Default value: false.

[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.

ParamTypeRequiredDefaultDescription
fieldsstringnonullOptional. string Array of requested fields (comma separated string) Allowed values: salary_type , default_wage , department_id , role , flags , deleted , status , last_web_login , position , position_id , ldap_attrs , online.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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, name, newPassword, passwordConfirm, passwordConfirmation, position, rate, role, salary_type, schedule_template_id, telephone, tfa_enabled, time_created, tracking profile_id, yearly_wage.
idintegeryesRequired. Agent ID.

Licensing

ToolPlanAccessSummary
teramind_get_license_usageFreeRead-onlyGet license usage information.

[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

ToolPlanAccessSummary
teramind_get_server_timeFreeRead-onlyShow server time.

[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

ToolPlanAccessSummary
teramind_classify_activitiesProDestructiveDESTRUCTIVE: classify activities.
teramind_deploy_batch_actionProDestructiveDESTRUCTIVE: run Deploy Status Report batch actions.
teramind_employees_batch_actionProDestructiveDESTRUCTIVE: run Employees report batch actions.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: ids, action, aggregate.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: action.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: action.

Reports

ToolPlanAccessSummary
teramind_computers_reportFreeRead-onlyComputers report.
teramind_console_commands_reportFreeRead-onlyConsole Commands report.
teramind_deploy_status_reportFreeRead-onlyDeploy status report.
teramind_disappeared_reportFreeRead-onlyDisappeared Employees/Computers report.
teramind_emailing_reportFreeRead-onlyEmailing report.
teramind_employees_reportFreeRead-onlyEmployees report.
teramind_file_transfers_reportFreeRead-onlyFile Transfers report.
teramind_get_report_export_statusFreeRead-onlyReport export status.
teramind_im_conversation_reportFreeRead-onlyConversation report.
teramind_instant_messaging_reportFreeRead-onlyInstant Messaging report.
teramind_keystrokes_reportFreeRead-onlyKeystrokes report.
teramind_list_report_exportsFreeRead-onlyList report export tasks.
teramind_network_monitoring_reportFreeRead-onlyNetwork Monitoring report.
teramind_notifications_reportFreeRead-onlyNotificatons report.
teramind_printing_reportFreeRead-onlyPrinting report.
teramind_searches_reportFreeRead-onlySearches report.
teramind_sessions_reportFreeRead-onlySessions report.
teramind_social_media_reportFreeRead-onlySocial Media report.
teramind_storage_reportFreeRead-onlyStorage report.
teramind_system_log_audit_reportFreeRead-onlySystem Log (Audit) report.
teramind_video_export_reportFreeRead-onlyVideo Export report.
teramind_voip_monitoring_reportFreeRead-onlyVoip monitoring report.
teramind_web_and_applications_reportFreeRead-onlyWeb & Applications report.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: computers, sortCol, sortDir, filter, viewMode.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: agents, computers, departments, filter, page, periodStart, periodEnd, sortCol, sortDir.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.

[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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: conversation, sourceType, periodStart, periodEnd, offset optional.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: agents optional, computers optional, departments optional, periodStart, periodEnd, sortCol optional, sortDir optional.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: agents optional, computers optional, departments optional, filter optional, page optional, periodStart, periodEnd, sortCol, sortDir.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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, action optional, accessToken optional, showUrls optional.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: agents optional, computers optional, periodStart, periodEnd, filter optional, sortCol optional, sortDir optional.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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, showIdleTime optional.

Business intelligence

ToolPlanAccessSummary
teramind_bi_add_new_widgetProWriteAdd new widget.
teramind_bi_autoexportProDestructiveDESTRUCTIVE: autoexport.
teramind_bi_chart_application_and_webpagesFreeRead-onlyChart - Application & Webpages.
teramind_bi_chart_behavior_alertFreeRead-onlyChart - Behavior alert.
teramind_bi_chart_console_commandsFreeRead-onlyChart - Console commands.
teramind_bi_chart_emailsFreeRead-onlyChart - Emails.
teramind_bi_chart_input_rateFreeRead-onlyChart - Input rate.
teramind_bi_chart_keystrokesFreeRead-onlyChart - Keystrokes.
teramind_bi_chart_login_sessionFreeRead-onlyChart - Login session.
teramind_bi_chart_printed_documentFreeRead-onlyChart - Printed document.
teramind_bi_chart_social_mediaFreeRead-onlyChart - Social media.
teramind_bi_chart_web_searchFreeRead-onlyChart - Web search.
teramind_bi_chart_work_timeFreeRead-onlyChart - Work time.
teramind_bi_clone_reportProWriteClone Report.
teramind_bi_grid_activityFreeRead-onlyGrid - Activity.
teramind_bi_grid_behavior_alertFreeRead-onlyGrid - Behavior alert.
teramind_bi_grid_console_cmdFreeRead-onlyGrid - Console cmd.
teramind_bi_grid_input_rateFreeRead-onlyGrid - Input rate.
teramind_bi_grid_keystrokesFreeRead-onlyGrid - Keystrokes.
teramind_bi_grid_login_sessionFreeRead-onlyGrid - Login session.
teramind_bi_grid_printed_docFreeRead-onlyGrid - Printed doc.
teramind_bi_grid_social_mediaFreeRead-onlyGrid - Social media.
teramind_bi_grid_web_searchFreeRead-onlyGrid - Web search.
teramind_bi_grid_work_timeFreeRead-onlyGrid - Work time.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: widgets, name, type, chart, query, order, dims, measures, cube, w, h, y, x.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: exports, settings, sameLayout, autoExport, enabled, period, emails, time, days, monthDay.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: name, widgets, tabs, filters, h, w, x, y, cube, type, chart, query, dims, limit, order, measures, minimap, version, atypeSelected, ldapFilters, dimFilters, date, range, datafilters, searchData.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

Business intelligence filters

ToolPlanAccessSummary
teramind_bi_filter_applications_and_webpagesFreeRead-onlyApplications & webpages filter.
teramind_bi_filter_behavior_alertsFreeRead-onlyBehavior alerts - filter.
teramind_bi_filter_console_commandsFreeRead-onlyConsole commands - filter.
teramind_bi_filter_emailsFreeRead-onlyEmails - filter.
teramind_bi_filter_file_eventsFreeRead-onlyFile events - filter.
teramind_bi_filter_keystrokesFreeRead-onlyKeystrokes - filter.
teramind_bi_filter_login_sessionsFreeRead-onlyLogin sessions - filter.
teramind_bi_filter_printingFreeRead-onlyPrinting - filter.
teramind_bi_filter_productivityFreeRead-onlyProductivity - filter.
teramind_bi_filter_searchesFreeRead-onlySearches - filter.
teramind_bi_filter_social_mediaFreeRead-onlySocial media - filter.
teramind_bi_filter_web_file_eventsFreeRead-onlyWeb file events - filter.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonOverridestringnonullOptional. A COMPLETE replacement request body as JSON. Supply this only to change the cube, dimensions, measures or non-date filters; it replaces the built-in template outright and the other parameters are then ignored.
endDatestringyesRequired. Inclusive end of the window as YYYY-MM-DD.
limitintegernonullOptional. Rows to return. Capped at 200 by StackJack; Teramind documents no maximum. Ignored by chart queries.
offsetintegernonullOptional. Row offset for paging. Ignored by chart queries.
startDatestringyesRequired. Inclusive start of the window as YYYY-MM-DD. BI cubes filter on plain dates, not the Unix seconds the rest of the Teramind API uses.
timezonestringnonullOptional. IANA timezone the cube aggregates in, e.g. America/New_York. Defaults to UTC.

Alerts

ToolPlanAccessSummary
teramind_list_alertsFreeRead-onlyList the behavior alerts raised against monitored users.
teramind_list_alerts_descriptionsFreeRead-onlyLook up the descriptions behind behavior alerts.

[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.

ParamTypeRequiredDefaultDescription
periodEndstringnonullOptional. The periodEnd filter.
periodStartstringnonullOptional. The periodStart filter.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON, per Teramind's documented sample for this endpoint.

Anomaly rules

ToolPlanAccessSummary
teramind_create_anomaly_ruleProDestructiveDESTRUCTIVE: create anomaly rule.
teramind_create_anomaly_rule_templateProWriteCreate an anomaly rule template.
teramind_delete_anomaly_ruleProDestructiveDESTRUCTIVE: delete an anomaly rule.
teramind_get_anomaly_ruleFreeRead-onlyGet one anomaly rule by id, with its triggers and its actions.
teramind_get_anomaly_rule_listFreeRead-onlyList the anomaly rules.
teramind_get_anomaly_rule_tagsFreeRead-onlyList the tags used on anomaly rules.
teramind_get_anomaly_rule_templateFreeRead-onlyGet one anomaly rule template by id.
teramind_get_anomaly_rule_templates_treeFreeRead-onlyGet the anomaly rule templates as the dashboard tree.
teramind_update_anomaly_ruleProDestructiveDESTRUCTIVE: update anomaly rule.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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, trigger_type, trigger_op, trigger_value, assignments optional, assignment_type, assignment_id, exclude optional, exclude_type, exclude_id, tags optional, time_periods optional, start.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: name, data.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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] 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 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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
idintegeryesRequired. The id this call targets.

Behavior policies

ToolPlanAccessSummary
teramind_clone_behavior_policyProDestructiveDESTRUCTIVE: clone or move a behavior policy.
teramind_create_behavior_groupProWriteCreate a behavior policy group.
teramind_create_policyProDestructiveDESTRUCTIVE: create policy.
teramind_delete_behavior_groupProDestructiveDESTRUCTIVE: delete a behavior policy group.
teramind_delete_policyProDestructiveDESTRUCTIVE: delete a behavior policy.
teramind_get_behavior_groupFreeRead-onlyGet one behavior policy group by id, with the policies and the assignments it carries.
teramind_get_behavior_policy_miscFreeRead-onlyGet the rule tags and the rule templates available to behavior policies, in one call.
teramind_get_behavior_policy_rule_tagsFreeRead-onlyList the rule tags available to behavior policies.
teramind_get_behavior_policy_rule_templatesFreeRead-onlyList the rule templates available to behavior policies.
teramind_get_demo_policyFreeRead-onlyGet the vendor demo policy for a policy type.
teramind_get_policyFreeRead-onlyGet one behavior policy by id, with its actions and its assignments.
teramind_import_behavior_policy_groupProDestructiveDESTRUCTIVE: import a behavior policy group from a file.
teramind_import_behavior_policy_into_groupProDestructiveDESTRUCTIVE: import a behavior policy into an existing group.
teramind_list_behavior_groupsFreeRead-onlyList the behavior policy groups.
teramind_list_policiesFreeRead-onlyList the behavior policies, flat.
teramind_list_policies_tree_viewFreeRead-onlyList the behavior policies as the dashboard tree: groups with their policies, in evaluation order.
teramind_reorder_behavior_groupsProDestructiveDESTRUCTIVE: reorder groups.
teramind_update_behavior_groupProDestructiveDESTRUCTIVE: update a behavior policy group.
teramind_update_policyProDestructiveDESTRUCTIVE: update a behavior policy.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: mode, group, withAssignments optional.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: name, assignments, assignment_type, assignment_id, exclude.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: behavior_group_id, active, draft, type, params, name, assignments, assignment_type, assignment_id, exclude, tags.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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] 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] 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 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.

ParamTypeRequiredDefaultDescription
typestringyesRequired. The type this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
idintegeryesRequired. The id this call targets.

[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 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 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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: groups.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: name, active, assignments, assignment_type, assignment_id, exclude.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
idintegeryesRequired. The id this call targets.

Monitoring policies

ToolPlanAccessSummary
teramind_create_monitoring_policyProDestructiveDESTRUCTIVE: add new policy.
teramind_delete_monitoring_policyProDestructiveDESTRUCTIVE: delete a monitoring policy.
teramind_rename_monitoring_policyProWriteRename a monitoring policy.
teramind_set_monitoring_policy_subjectsProDestructiveDESTRUCTIVE: change policy subjects.
teramind_update_monitoring_policyProDestructiveDESTRUCTIVE: update a monitoring policy, wholesale.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: name, subjects, rules, id, features, feature, ac_rule, objects, ext_id.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: id, name.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: id, users.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: id, policy, name, subjects, ext_type, ext_id, rules, objects, index, features, feature, access.
idintegeryesRequired. The id this call targets.

Monitoring profiles

ToolPlanAccessSummary
teramind_create_monitoring_profileProWriteCreate a monitoring profile.
teramind_delete_monitoring_profileProDestructiveDESTRUCTIVE: delete a monitoring profile.
teramind_list_monitoring_profilesFreeRead-onlyList the monitoring profiles.
teramind_update_monitoring_profileProDestructiveDESTRUCTIVE: update monitoring profile.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON, per Teramind's documented sample for this endpoint.
fieldsstringnonullOptional. The fields filter.
namestringnonullOptional. The name filter.

[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.

ParamTypeRequiredDefaultDescription
fieldsstringnonullOptional. The fields filter.
idintegeryesRequired. Tracking profile id.
namestringnonullOptional. The name filter.

[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.

ParamTypeRequiredDefaultDescription
fieldsstringnonullOptional. The fields filter.
namestringnonullOptional. The name filter.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.
fieldsstringnonullOptional. The fields filter.
namestringnonullOptional. The name filter.

Monitoring rules

ToolPlanAccessSummary
teramind_create_monitoring_ruleProDestructiveDESTRUCTIVE: add new rule.
teramind_delete_monitoring_ruleProDestructiveDESTRUCTIVE: delete a monitoring rule.
teramind_update_monitoring_rule_featuresProDestructiveDESTRUCTIVE: update the features of a monitoring rule.
teramind_update_monitoring_rule_subjectsProDestructiveDESTRUCTIVE: update the subjects of a monitoring rule.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: policyId, users, features.

[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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: id, features.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

Shared lists

ToolPlanAccessSummary
teramind_create_or_update_shared_listProWriteCreate a shared list, or update its name and type.
teramind_create_or_update_shared_list_entriesProDestructiveDESTRUCTIVE: create or update shared list entries.
teramind_delete_shared_listProDestructiveDESTRUCTIVE: delete a shared list.
teramind_delete_shared_list_entriesProDestructiveDESTRUCTIVE: delete entries from a shared list.
teramind_get_shared_listFreeRead-onlyGet one shared list by id, with its entries.
teramind_get_shared_listsFreeRead-onlyList the shared lists.

[Teramind] Create a shared list, or update its name and type. A list holds reusable values that behavior and monitoring rules reference. POST /tm-api/shared-lists/list. Send the request body as JSON; Teramind documents these fields: name, type optional, shared_list_id optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: name, type optional, shared_list_id optional.

[Teramind] DESTRUCTIVE: create or update shared list entries. Why this is destructive: the replace flag in the body replaces the list's entries outright, and behavior rules match against shared lists, so this can stop a block from firing. POST /tm-api/shared-lists/items. Send the request body as JSON; Teramind documents these fields: replace optional, shared_list_id optional, file optional, items optional, value optional, shared_list_item_id optional. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: replace optional, shared_list_id optional, file optional, items optional, value optional, shared_list_item_id optional.

[Teramind] DESTRUCTIVE: delete a shared list. Why this is destructive: every rule that references the list loses its values, so what those rules match changes. DELETE /tm-api/shared-lists/list. Send the request body as JSON; Teramind documents these fields: shared_list_id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: shared_list_id.

[Teramind] DESTRUCTIVE: delete entries from a shared list. Why this is destructive: rules reference shared lists, so removing entries changes what those rules match and can stop a block from firing. DELETE /tm-api/shared-lists/items. Send the request body as JSON; Teramind documents these fields: items. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: items.

[Teramind] Get one shared list by id, with its entries. GET /tm-api/shared-lists/one/. Path parameters: id. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[Teramind] List the shared lists. A shared list is a reusable set of values that behavior and monitoring rules reference. GET /tm-api/shared-lists/all. Time filters are Unix seconds and page numbers are 0-based unless a parameter says otherwise. Returns raw Teramind JSON.

Productivity profiles

ToolPlanAccessSummary
teramind_add_productivity_profile_ruleProWriteAdd a classification rule to a productivity profile.
teramind_create_productivity_profileProWriteCreate a productivity profile.
teramind_delete_productivity_profileProDestructiveDESTRUCTIVE: delete a productivity profile.
teramind_delete_productivity_profile_ruleProDestructiveDESTRUCTIVE: delete a rule from a productivity profile.
teramind_get_assigned_productivity_profileFreeRead-onlyGet the productivity profile that is assigned, for the scope the query names.
teramind_get_productivity_profileFreeRead-onlyGet one productivity profile by id, with its rules.
teramind_import_productivity_profile_rulesProDestructiveDESTRUCTIVE: import productivity profile rules from a CSV file.
teramind_list_productivity_profilesFreeRead-onlyList the productivity profiles.
teramind_move_productivity_profileProDestructiveDESTRUCTIVE: move a productivity profile under another parent.
teramind_update_productivity_profileProDestructiveDESTRUCTIVE: update a productivity profile.
teramind_update_productivity_profile_ruleProDestructiveDESTRUCTIVE: update a rule inside a productivity profile.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: profile_version, type, mode, value.
profileIdintegeryesRequired. The profileId this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: name, parent_id, retroactive, assignments, type, id, options.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
profileIdintegeryesRequired. The profileId this call targets.
ruleIdintegeryesRequired. The ruleId this call targets.

[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 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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
modestringnonullOptional. The mode filter.
profileIdintegeryesRequired. The profileId this call targets.
ruleTypestringnonullOptional. The ruleType filter.

[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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: id.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: id, name.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: profile_version, version, type, mode, value.
profileIdintegeryesRequired. The profileId this call targets.
ruleIdintegeryesRequired. The ruleId this call targets.

Schedules

ToolPlanAccessSummary
teramind_assign_schedule_templateProDestructiveDESTRUCTIVE: assign a schedule template or a shift to each named agent and position.
teramind_create_schedule_modificationProWriteCreate a schedule modification, an override for a single day.
teramind_create_schedule_positionProWriteCreate a schedule position.
teramind_create_schedule_templateProWriteCreate a schedule template.
teramind_delete_schedule_modificationProDestructiveDESTRUCTIVE: delete a schedule modification.
teramind_delete_schedule_positionProDestructiveDESTRUCTIVE: delete a schedule position.
teramind_delete_schedule_templateProDestructiveDESTRUCTIVE: delete a schedule template.
teramind_list_schedule_modificationsFreeRead-onlyList the schedule modifications that exist.
teramind_list_schedule_positionsFreeRead-onlyList the schedule positions that exist.
teramind_list_schedule_templatesFreeRead-onlyList the schedule templates that exist.
teramind_list_schedulesFreeRead-onlyList the schedules that exist.
teramind_update_schedule_modificationProDestructiveDESTRUCTIVE: update a schedule modification.
teramind_update_schedule_positionProDestructiveDESTRUCTIVE: update a schedule position.
teramind_update_schedule_templateProDestructiveDESTRUCTIVE: update a schedule template.
teramind_upsert_scheduleProDestructiveDESTRUCTIVE: create a schedule, or update an existing one.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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 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 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 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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

Tasks

ToolPlanAccessSummary
teramind_create_taskProWriteCreate a task.
teramind_get_active_tasksFreeRead-onlyList the tasks that are currently being worked on.
teramind_get_assigned_tasksFreeRead-onlyList the tasks that are assigned to agents.
teramind_get_taskFreeRead-onlyGet one task by id.
teramind_list_tasksFreeRead-onlyList every task.
teramind_update_taskProDestructiveDESTRUCTIVE: update a task.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: parent_id, name, description optional, is_trackable, is_archived optional, assignment.

[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] 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 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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: parent_id optional, name optional, description optional, is_trackable optional, is_archived optional, assignment optional.
idintegeryesRequired. The id this call targets.

Time tracker tasks

ToolPlanAccessSummary
teramind_add_time_tracker_noteProWriteAdd a note to the time-tracker history.
teramind_get_time_tracker_historyFreeRead-onlyGet the time-tracker history: the clock-in, clock-out and note entries.
teramind_get_time_tracker_statusFreeRead-onlyGet the current time-tracker status, including whether a clock is running.
teramind_time_tracker_start_clockProWriteStart the time-tracker clock on a task.
teramind_time_tracker_stop_clockProWriteStop the time-tracker clock.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: task_id, note, update.

[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 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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: task_id.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: id optional.

Time tracking reports

ToolPlanAccessSummary
teramind_add_time_recordProDestructiveDESTRUCTIVE: add or edit time records in batch.
teramind_agent_cost_reportFreeRead-onlyAgent cost report: the labor cost per agent over a period.
teramind_task_cost_reportFreeRead-onlyTask cost report: the labor cost per task over a period.
teramind_time_card_reportFreeRead-onlyTime card report: the per-agent time card for a period.
teramind_time_records_by_dayFreeRead-onlyTime records grouped by day for a period.
teramind_time_records_reportFreeRead-onlyTime records report: the individual time records for a period.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: actions, action, agent_id, task_id, start_time, end_time, notes.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: agents optional, tasks optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: agents optional, tasks optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: agents, departments, computers, task, filter, page, periodStart, periodEnd, customFilter, partial, splitByDay.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: agents optional, tasks optional, splitByDay optional, page optional, periodStart, periodEnd, sortCol optional, sortDir optional.

Activities

ToolPlanAccessSummary
teramind_get_aggregated_activitiesFreeRead-onlyGet aggregated activities.
teramind_get_email_activity_bodyFreeRead-onlyGet content for email activity by id.
teramind_get_email_activity_body_htmlFreeRead-onlyGet content for email activity by id (html document).
teramind_get_email_activity_infoFreeRead-onlyGet email activity info.

[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.

ParamTypeRequiredDefaultDescription
fromstringnonullOptional. The from filter.
tostringnonullOptional. The to filter.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

Session player

ToolPlanAccessSummary
teramind_get_player_settingsFreeRead-onlySettings.

[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.

ParamTypeRequiredDefaultDescription
agentIdintegernonullOptional. number.
computerIdintegernonullOptional. number.

Session tags

ToolPlanAccessSummary
teramind_create_player_tagProWriteCreate new tag.
teramind_create_player_timeline_tagProWriteCreate new timeline tag.
teramind_delete_player_timeline_tagProDestructiveDESTRUCTIVE: delete player timeline tag.
teramind_list_player_tagsFreeRead-onlyList player tags.
teramind_list_player_timeline_tagsFreeRead-onlyList player timeline tags.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: tag.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: computer_id, datetime, note optional, player_tag_id.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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. 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.

ParamTypeRequiredDefaultDescription
agentstringnonullOptional. The agent filter.
computerstringnonullOptional. The computer filter.
periodEndstringnonullOptional. The periodEnd filter.
periodStartstringnonullOptional. The periodStart filter.

Video exports

ToolPlanAccessSummary
teramind_get_video_export_statusFreeRead-onlyGet export status.
teramind_list_available_video_dataFreeRead-onlyAvailable video data.
teramind_start_video_exportProDestructiveDESTRUCTIVE: export a video.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
computerstringnonullOptional. ID of computer.
endstringnonullOptional. Upper bound timestamp of period.
startstringnonullOptional. Lower bound timestamp of period.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: agents, computer, start, end, speed, recipient, soundDisabled, frameRate.

Access tokens

ToolPlanAccessSummary
teramind_get_account_settingsFreeRead-onlyGet account settings.
teramind_update_account_settingsProDestructiveDESTRUCTIVE: update account.

[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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON, per Teramind's documented sample for this endpoint.

Data ingestion

ToolPlanAccessSummary
teramind_ingest_voip_eventsProWriteCreate voip events.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

Instance

ToolPlanAccessSummary
teramind_get_bi_integration_statusFreeRead-onlyGet BI integration status.
teramind_list_activity_categoriesFreeRead-onlyGet all known categories.
teramind_reset_bi_dataProDestructiveDESTRUCTIVE: insert BI reset request.

[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] 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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: months optional, all optional.

LDAP directory

ToolPlanAccessSummary
teramind_get_ldap_groups_contentFreeRead-onlyGet LDAP groups content.
teramind_get_ldap_settingsFreeRead-onlyGet LDAP settings.
teramind_get_ldap_sync_statusFreeRead-onlyLDAP status.
teramind_set_ldap_settingsProDestructiveDESTRUCTIVE: set LDAP settings.
teramind_update_ldap_group_contentProDestructiveDESTRUCTIVE: update LDAP group content.

[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. 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] 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] 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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. 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, ldap_dont_monitor_non_existing_ad_users optional, ldap_ou_from_group_attribute_name optional.
idintegeryesRequired. The id this call targets.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

Report settings

ToolPlanAccessSummary
teramind_save_alerts_report_settingsProDestructiveDESTRUCTIVE: alerts report settings.
teramind_save_computers_report_settingsProDestructiveDESTRUCTIVE: computers report settings.
teramind_save_console_commands_report_settingsProDestructiveDESTRUCTIVE: console Commands report settings.
teramind_save_emailing_report_settingsProDestructiveDESTRUCTIVE: emailing report settings.
teramind_save_employee_tasks_report_settingsProDestructiveDESTRUCTIVE: employee Tasks report settings.
teramind_save_employees_report_settingsProDestructiveDESTRUCTIVE: employees report settings.
teramind_save_file_transfers_report_settingsProDestructiveDESTRUCTIVE: file Transfers report settings.
teramind_save_keystrokes_report_settingsProDestructiveDESTRUCTIVE: keystrokes report settings.
teramind_save_network_monitoring_report_settingsProDestructiveDESTRUCTIVE: network Monitoring report settings.
teramind_save_printing_report_settingsProDestructiveDESTRUCTIVE: printing report settings.
teramind_save_productivity_report_settingsProDestructiveDESTRUCTIVE: productivity report settings.
teramind_save_searches_report_settingsProDestructiveDESTRUCTIVE: searches report settings.
teramind_save_sessions_report_settingsProDestructiveDESTRUCTIVE: sessions report settings.
teramind_save_social_media_report_settingsProDestructiveDESTRUCTIVE: social Media report settings.
teramind_save_storage_report_settingsProDestructiveDESTRUCTIVE: storage report settings.
teramind_save_system_log_report_settingsProDestructiveDESTRUCTIVE: system Log report settings.
teramind_save_voip_report_settingsProDestructiveDESTRUCTIVE: voip report settings.
teramind_save_web_and_applications_report_settingsProDestructiveDESTRUCTIVE: web & Applications report settings.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: agents, departments, computers, tasks, filter, page, periodStart, periodEnd, customFilter, partial, aggregate, showIdleTime, gridColumns, gridAttrs, exportColumns, exportAttrs, autoExport, enabled, period, monthDay, days, emails, time, format.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringnonullOptional. A JSON request body. Teramind publishes no sample for this endpoint; omit it unless you know the shape.

SMTP

ToolPlanAccessSummary
teramind_send_smtp_test_messageProDestructiveDESTRUCTIVE: send SMTP test message.

[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.

ParamTypeRequiredDefaultDescription
bodyJsonstringyesRequired. The request body as JSON. Teramind documents these fields: to, settings, encryption, hostname, username, port, mail_from, password.