{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter DashboardMetrics API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "DashboardMetrics",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get on hold tickets count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/dashboards/onholdTickets",
            "params": [
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Predefined time range from which the stats must be fetched"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the agent(s) whose stats must be fetched"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the department(s) from which the stats must be fetched"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the team(s) from which the stats must be fetched"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "Channel through which the tickets were received"
              },
              {
                "name": "groupBy",
                "value": "",
                "type": "query",
                "description": "To get customer happiness count via particular group.This value can be @date@ @channel@ @agent@ | @hour@"
              }
            ]
          },
          "docs": "This API fetches the number of tickets that are in the on hold status."
        },
        {
          "info": {
            "name": "Get closed tickets count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/dashboards/solvedTickets",
            "params": [
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Predefined time range from which the stats must be fetched"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the agent(s) whose stats must be fetched"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the department(s) from which the stats must be fetched"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the team(s) from which the stats must be fetched"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "Channel through which the tickets were received"
              },
              {
                "name": "groupBy",
                "value": "",
                "type": "query",
                "description": "To get customer happiness count via particular group.This value can be @date@ @channel@ @agent@ | @hour@"
              }
            ]
          },
          "docs": "This API fetches the number of tickets that are resolved."
        },
        {
          "info": {
            "name": "Get unresolved tickets count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/dashboards/backlogTickets",
            "params": [
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Predefined time range from which the stats must be fetched"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the agent(s) whose stats must be fetched"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the department(s) from which the stats must be fetched"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "Channel through which the tickets were received"
              },
              {
                "name": "groupBy",
                "value": "",
                "type": "query",
                "description": "Key that groups the ticket count according to a particular attribute.This value can be @date@ @channel@ @agent@"
              }
            ]
          },
          "docs": "This API fetches the number of tickets that have remained unresolved over a particular period."
        },
        {
          "info": {
            "name": "Get reopened tickets count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/dashboards/reopenedTickets",
            "params": [
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Predefined time range from which the stats must be fetched"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the agent(s) whose stats must be fetched"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the department(s) from which the stats must be fetched"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the team(s) from which the stats must be fetched"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "Channel through which the tickets were received"
              },
              {
                "name": "groupBy",
                "value": "",
                "type": "query",
                "description": "To get customer happiness count via particular group.This value can be @date@ @channel@ @agent@ | @hour@"
              }
            ]
          },
          "docs": "This API fetches the number of tickets that were reopened in your help desk portal."
        },
        {
          "info": {
            "name": "List resolution times",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/dashboards/ticketsResolutionTime",
            "params": [
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Predefined time range from which the stats must be fetched"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the agent(s) whose stats must be fetched"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the department(s) from which the stats must be fetched"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the team(s) from which the stats must be fetched"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "Channel through which the tickets were received"
              },
              {
                "name": "groupBy",
                "value": "",
                "type": "query",
                "description": "To get customer happiness count via particular group.This value can be @date@ @channel@ @agent@ | @hour@"
              }
            ]
          },
          "docs": "This API lists the durations taken to resolve tickets."
        },
        {
          "info": {
            "name": "Get created tickets count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/dashboards/createdTickets",
            "params": [
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Predefined time range from which the stats must be fetched"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the agent(s) whose stats must be fetched"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the department(s) from which the stats must be fetched"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the team(s) from which the stats must be fetched"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "Channel through which the tickets were received"
              },
              {
                "name": "groupBy",
                "value": "",
                "type": "query",
                "description": "To get customer happiness count via particular group.This value can be @date@ @channel@ @agent@ | @hour@"
              }
            ]
          },
          "docs": "This API fetches the number of tickets created in a particular duration."
        },
        {
          "info": {
            "name": "Get total response count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/dashboards/responseCount",
            "params": [
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Predefined time range from which the stats must be fetched"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the agent(s) whose stats must be fetched"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the department(s) from which the stats must be fetched"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the team(s) from which the stats must be fetched"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "Channel through which the tickets were received"
              },
              {
                "name": "groupBy",
                "value": "",
                "type": "query",
                "description": "To get customer happiness count via particular group.This value can be @date@ @channel@ @agent@ | @hour@"
              }
            ]
          },
          "docs": "This API fetches the total number of responses sent/made by your agents."
        },
        {
          "info": {
            "name": "List response times",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/v1/dashboards/responseTime",
            "params": [
              {
                "name": "duration",
                "value": "",
                "type": "query",
                "description": "Predefined time range from which the stats must be fetched"
              },
              {
                "name": "agentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the agent(s) whose stats must be fetched"
              },
              {
                "name": "departmentId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the department(s) from which the stats must be fetched"
              },
              {
                "name": "teamId",
                "value": "",
                "type": "query",
                "description": "ID(s) of the team(s) from which the stats must be fetched"
              },
              {
                "name": "channel",
                "value": "",
                "type": "query",
                "description": "Channel through which the tickets were received"
              },
              {
                "name": "groupBy",
                "value": "",
                "type": "query",
                "description": "To get customer happiness count via particular group.This value can be @date@ @channel@ @agent@ | @hour@"
              },
              {
                "name": "isFirstResponse",
                "value": "",
                "type": "query",
                "description": "Key that specifies if the response is the first response to the customer question"
              }
            ]
          },
          "docs": "This API lists the durations taken to respond to tickets."
        }
      ]
    }
  ],
  "bundled": true
}