Jump to

• Request
• Response

Get all task related KPI information

get

/api/1.0/collectordashboard/kpi/all

This endpoint is used to Get all task related KPI information.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• collectorUserId(required): string
  User Id of collector.
• pastDate(required): string
  Past Date.
• startDate(required): string
  Current Business or Override Date.

Header Parameters

• appId(required): string
  The application ID of host service.
• branchCode(required): string
  The branch code of requesting branch.
• contentType: string
  The content type of request or response body.
• userId(required): string
  The user ID of requesting user.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Returns all KPI values by collector user id and provided Date.

Body ()

Root Schema : KpiValuesWrapperDto

Type: object

Wrapper DTO for KPI values.

Show Source

• data: object KpiValuesDto

{
    "type":"object",
    "properties":{
        "data":{
            "$ref":"#/definitions/KpiValuesDto"
        }
    },
    "description":"Wrapper DTO for KPI values."
}

Nested Schema : KpiValuesDto

Type: object

Show Source

• noOfAccountsHandled: integer(int64)
  No of accounts handled.
• noOfContacts: integer(int64)
  No of Contacts.

{
    "type":"object",
    "properties":{
        "noOfContacts":{
            "description":"No of Contacts.",
            "type":"integer",
            "format":"int64"
        },
        "noOfAccountsHandled":{
            "description":"No of accounts handled.",
            "type":"integer",
            "format":"int64"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top