Tags

View your team’s tagging frequency and your most popular tags.

Conversations Tagged

GET https://{{account_id}}.acquire.io/api/v1/analytics/chat/conversations-tagged

Retrieve the number of conversations your team tagged vs. total number of conversations.

Query Parameters

Name	Type	Description
start_date	string	Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00)
end_date	string	Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59)
offset	string	This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00
output	string	json or csv

Headers

Name	Type	Description
Authorization	string	Bearer ***YOUR_API_KEY***

200

{
  "data": {
    "conversationsTagged": {
      "data": {
        "graphRow": {
          "labels": [
            "05 AM",
            "06 AM",
            "07 AM",
            "08 AM",
            "09 AM",
            "10 AM",
            "11 AM",
            "12 PM",
            "01 PM",
            "02 PM",
            "03 PM",
            "04 PM",
            "05 PM",
            "06 PM",
            "07 PM",
            "08 PM",
            "09 PM",
            "10 PM",
            "11 PM",
            "12 AM",
            "01 AM",
            "02 AM",
            "03 AM",
            "04 AM"
          ],
          "totalConversations": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ],
          "taggedConversations": [
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0,
            0
          ]
        }
      },
      "success": true,
      "output": "json"
    }
  }
}

Tag Reporting

GET https://{{account_id}}.acquire.io/api/v1/analytics/chat/tag-reporting

Retrieve a list of the most frequently used tags.

Query Parameters

Name	Type	Description
start_date	string	Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00)
end_date	string	Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59)
offset	string	This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00
output	string	json or csv

Headers

Name	Type	Description
Authorization	string	Bearer ***YOUR_API_KEY***

200

{
  "data": {
    "tagReporting": {
      "data": {
        "graphRow": {
          "data": [
            {
              "title": "email-test",
              "chats": 3,
              "percentage": "30.00",
              "color": null
            },
            {
              "title": "email-test2",
              "chats": 3,
              "percentage": "30.00",
              "color": null
            },
            {
              "title": "anaytics",
              "chats": 2,
              "percentage": "20.00",
              "color": "#fd983f"
            },
            {
              "title": "first-department",
              "chats": 2,
              "percentage": "20.00",
              "color": "#3F95FD"
            }
          ]
        }
      },
      "success": true,
      "output": "json"
    }
  }
}

Most Common Tags

GET https://{{account_id}}.acquire.io/api/v1/analytics/chat/most-common-tags

Retrieve a list of the most common tags.

Query Parameters

Name	Type	Description
start_date	string	Date From (Date format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 00:00:00)
end_date	string	Date End (Date Format = YYYY-MM-DD hh:mm:ss, e.g 2021-01-01 23:59:59)
offset	string	This parameter is used for the timezone value and the default timezone will be "GMT". e.g. +05:30 for particular timezone. Default is +00:00
output	string	json or csv

Headers

Name	Type	Description
Authorization	string	Bearer ***YOUR_API_KEY***

200

{
  "data": {
    "mostCommonTags": {
      "data": {
        "graphRow": {
          "labels": [
            "email-test",
            "email-test2",
            "anaytics",
            "first-department",
            "n/a",
            "n/a",
            "n/a",
            "n/a",
            "n/a",
            "n/a"
          ],
          "chats": [
            3,
            3,
            2,
            2,
            0,
            0,
            0,
            0,
            0,
            0
          ]
        }
      },
      "success": true,
      "output": "json"
    }
  }
}