• Release Notes
  • User
  • Admin
  • Developers
  • Integrations

›REST API Examples

General

  • Co-Browsing
  • Universal Embedded Co-Browsing
  • Chat
  • Videocalling with Queue
  • Generate API Token

External

  • Salesforce
  • Outlook
  • Freshdesk
  • Microsoft Teams
  • ZealiD
  • Individual Platform

Data

  • Audit Logs

Use Cases

  • CoBrowsing - Example
  • SessionRecording - Optin/Optout button
  • UserTagging & Login Example
  • UserTagging & Screensharing Example
  • Mobile user tagging & LiveView
  • WebChat API - Example
  • ActionRules Matched API - Example

REST API Examples

  • Agent Times
  • Rule matches
  • Appointments
  • Universal Co-Browsing

REST Example - Rule matches

This page gives an example to fetch match count of Action Rules, Routing Rules and SLA Rules.

Rule Types

ACTION_RULE_MATCH_COUNT ROUTING_RULE_MATCH_COUNT SLA_1_RULE_MATCH_COUNT SLA_2_RULE_MATCH_COUNT SLA_1_RULE_MISS_COUNT SLA_2_RULE_MISS_COUNT

Fetch

This API call returns a aggregated object of rule matches https://developers.chatvisor.com/#operation/getUsingPOST_5

Request
Request with Filter
Response
POST https://api.chatvisor.com/rest/v1/report/rule/?access_token=<TOKEN>

BODY:
{
"metrics": [
{
"metricName": "ACTION_RULE_MATCH_COUNT"
}
],
"dateFilter": {
"grouping": "TODAY"
}
}
POST https://api.chatvisor.com/rest/v1/report/rule/?access_token=<TOKEN>

BODY:
{
"metrics": [
{
"metricName": "ACTION_RULE_MATCH_COUNT",
"ruleIds": ["<ID>"]
}
],
"dateFilter": {
"grouping": "TODAY"
}
}
{
"results": {
"2020/11/02 15": {
"ACTION_RULE_MATCH_COUNT": "7"
},
"2020/11/02 16": {
"ACTION_RULE_MATCH_COUNT": "2"
},
"2020/11/02 17": {
"ACTION_RULE_MATCH_COUNT": "1"
}
}
}

The ID of a rule can be found in the backend of TeamViewer Engage within the details of the Action Rules/SLA rules... menu.

← Agent TimesAppointments →
  • Rule Types
  • Fetch
MANUALS
User Manual: Sales Suite
Admin Manual: Sales Suite
User Manual: Support Suite
Admin Manual: Support Suite
DEVELOPERS
Integrations
REST API
SDK API
LEGAL
Privacy Policy
Terms and Conditions
Imprint
Engage
Copyright © 2024 TeamViewer Austria GmbH