National Dashboard Ingestion Specification

Swagger Documentation:

Following is the GitHub link of the swagger API documentation for National Dashboards data ingestion:

Master Data:

Property Tax

Attribute	Allowed Values

Attribute	Allowed Values
Payment Mode	Cash
	Online
	Cheque
	DD
	Offline NEFT
	Offline RTGS
	Card
Usage Type	Residential
	Commercial
	Mixed
	Industrial
	Non-Residential
	Institutional
	Other Non-Residential

Trade License:

Attribute	Allowed Values

Attribute	Allowed Values
Trade Type	List of allowed trade types can be found in the following link: Trade Type Master Data
Status	Initiated
	Approved
	Pending Payment
	Cancelled
	Citizen Action Required
	Field Inspection
	Pending Approval
	Rejected

Public Grievance Redressal:

Attribute	Allowed Values

Attribute	Allowed Values
Source	IVR
	Web
	WhatsApp
	MobileApp
Status	Open
	Reopened
	Resolved
	Assigned
	Rejected
	Reassign Requested
	Reassigned Complaints
	Closed
Department	Streetlights
	Property Tax Branch
	Operation & Maintenance
	Horticulture
	Health & Sanitation
	Building & Roads
	Building Branch
	Complaint Cell
Complaint Type	No Streetlight
	Streetlight Not Working
	Installation of New Streetlight
	Receipt Not Generated
	Wrong Calculation PT
	How to pay PT
	Others
	Broken Water Pipe Or Leakage
	Overflowing Or Blocked Drain
	Illegal Discharge Of Sewage
	Cleaning Of Drains
	Sewage Main Hole Cover Missing Or Broken
	Shortage Of Water
	Water Entered House Rainy Season
	Water Pressure is Very Less
	No Water Supply
	Dirty Water Supply
	Illegal Cutting of Trees
	Cutting or Trimming of Tree Required
	Park Requires Maintenance
	Burning of Garbage
	Stray Animals
	Damaged Garbage Bin
	Dirty or Smelly Public Toilets
	No Water or Electricity in Public Toilets
	Garbage Needs to be Cleared
	Grass Cutting
	Request Spraying or Fogging Operation
	Non Sweeping of Road
	Dead Animals
	Water Logged Road
	Damaged or Blocked Footpath
	Road Jaali Broken
	Damaged Road
	Manhole Cover Missing or Damaged
	Illegal Rehries on Road
	Construction Material Lying on the Road
	Illegal Shops on Footpath
	Illegal Constructions
	Illegal Parking
	Others

Water & Sewerage:

Attribute	Allowed Values

Attribute	Allowed Values
Usage Type	Domestic
	Commercial
	Institutional
	Domestic SLC
	Domestic Exempted
	Commercial Motor
Payment Channel	System
	Paytm
	Field
	Razorpay
	PayU
	BBPS
	POS
	Sewakendra
	Freecharge
Water Connection Usage Category	Domestic
	Commercial
	Domestic Exempted
Sewerage Connection Usage Category	Domestic
	Commercial
	Residential
	Institutional
	Domestic Exempted
Connection Channel	Counter
	Online
	System
	CSC

OBPS:

Attribute	Allowed Values

Attribute	Allowed Values
Collection by Payment Mode	Cash
Collection by Payment Mode	Online
Permits Issued by Risk Type	Low
	Medium
	High
Permits Issued by Occupancy Type	Residential
	Commercial
	Institutional
	Industrial
	Mixed

mCollect:

Attribute	Allowed Values

Attribute	Allowed Values
Receipts Payment Mode	Cash
	Cheque
	Credit/Debit Card
	Online
Collection Payment Mode	Cash
	Cheque
	Credit/Debit Card
	Online
Challan Status	Paid
	Cancelled
	Active
Receipts Status	New
	Deposited
	Dishonoured
Collection Status	New
	Deposited
	Dishonoured
Collection Category	Hoarding
	Road Show
	Unipolls
	Auction Fee
	User Fees

FireNOC:

Attribute	Allowed Values

Attribute	Allowed Values
Payment Mode	Cash
Payment Mode	Online
NOC Type	Provisional
NOC Type	Actual

Metric Definitions:

Following are module wise tables containing the metric name and its definition. The breakup column contains the attributes by which the distribution of metrics has to be provided.

Property Tax:

Metric	Definition	Breakup

Metric	Definition	Breakup
ward	ward name	Nil
ulb	ULB name	Nil
region	The district or region for which the data is ingested	Nil
state	The State for which data belongs	Nil
transactions	Transactions done on the given date	Nil
todaysPropertiesRegistered	Properties registered on the given date	Breakup by financial year has to be provided
todaysApplications	Applications created on the given date	Nil
assessedProperties	Properties assessed on the given date	Nil
todaysCollection	Amount collected on given date	Breakup by usage category has to be provided
propertyTax	Base Property Tax collected on given date	Breakup by usage category has to be provided
cess	Cess collected on the given date	Breakup by usage category has to be provided
rebate	Rebate given on the given date	Breakup by usage category has to be provided
penalty	Penalty coolected on the given date	Breakup by usage category has to be provided
interest	Interest collected on the given date	Breakup by usage category has to be provided

Trade Licenses :

Metric	Definition	Breakup

Metric	Definition	Breakup
ward	Ward Name	Nil
ulb	ULB Name	Nil
region	The district or region for which the data is ingested	Nil
state	The State for which data belongs	Nil
transactions	Transactions done on the given date	Nil
todaysApplications	Applications created on the given date	Nil
todaysLicenseIssued	Number of licenses issued on given date	Nil
tlTax	Base TL tax collected on the given date	Nil
adhocPenalty	AdhochPenalty collected on the given date	Nil
adhocRebate	AdhochRebate given on the given date	Nil
todaysCollection	Total amount collected on the given date	Breakup by trade category has to be provided
applicationsMovedToday	Number of applications whose status has changed	Breakup by statuses
todaysTradeLicenses	trade licenses issued today	Breakup by statuses

Public Grievance Redressal :

Metric	Definition	Breakup

Metric	Definition	Breakup
ward	The ward for which the data is ingested	Nil
ulb	The ULB name for which the data is ingested	Nil
region	The district or region for which the data is ingested	Nil
state	The State for which data belongs	Nil
closedComplaints	Complaints closed on given date	Nil
slaAchievement	Percentage of complaints that are resolved with SLA till the given date	Nil
uniqueCitizens	Number of unique citizens added on given date	Nil
resolvedComplaints	Number of Complaints resolved on the given date	Nil
todaysComplaints	sum of unique complaints submitted in selected time range	Breakup by status, channel, department, category
todaysOpenComplaints	Number of complaints that moved to open status on the given date	Breakup by department
todaysReopenedComplaints	Number of complaints that moved to reopened status on the given date	Breakup by department
todaysAssignedComplaints	Number of complaints that moved to assigned status on the given date	Breakup by department
todaysReassignedComplaints	Number of complaints that moved to reassigned status on the given date	Breakup by department
todaysRejectedComplaints	Number of complaints that moved to rejected status on the given date	Breakup by department

Water & Sewerage:

Metric	Definition	Breakup

Metric	Definition	Breakup
ulb	ULB Name	Nil
state	State Name	Nil
ward	Ward Name	Nil
region	Region or District	Nil
transactions	Number of transactions related to WS/SW module on a given date	Nil
connectionsCreated	Number of connections related to WS/SW module on a given date	Breakup by channel type and connection type has to be provided
todaysCollection	Total collection related to WS/SW module on a given date	Breakup by usage type, channel type and tax head has to be provided
waterConnections	new connections created on the given date	Breakup by meter type,usage and channel
sewerageConnections	new sewreage connections created on the given date	Breakup by usage and channel
pendingConnections	pending connections on the given date	Breakup by duration

mCollect:

Metric	Definition	Breakup

Metric	Definition	Breakup
ward	The ward for which the data is ingested	Nil
ulb	The ULB name for which the data is ingested	Nil
region	The district or region for which the data is ingested	Nil
state	The State for which data belongs	Nil
numberOfCategories	The number of different categories against which collections were made	Nil
citizenAverageRating	Cititzen average Rating till the given date	Nil
todaysCollection	Total amount collected on given date	Breakup by Payment Mode, Status and Category
numberOfReceipts	Total number of receipts generated on the given date	Breakup by Payment Mode and Status
numberOfChallans	Total number of challans generated on the given date	Breakup by status

Online Building Permission System:

Metric	Definition	Breakup

Metric	Definition	Breakup
ward	The ward for which the data is ingested	Nil
ulb	The ULB name for which the data is ingested	Nil
region	The district or region for which the data is ingested	Nil
state	The State for which data belongs	Nil
ocPlansScrutinized	Total number of OC plans scrutinized on the given date	Nil
plansScrutinized	Total number of plans scrutinized on the given date	Nil
ocSubmitted	Total number of OC submitted on the given date	Nil
applicationsSubmitted	Total number of applications submitted on the given date	Nil
ocIssued	Total number of OC issued on the given date	Nil
landAreaAppliedInSystemForBPA	Total land area applied in system for BPA on the given date	Nil
averageDaysToIssuePermit	Average days to issue permit till date	Nil
averageDaysToIssueOC	Average days to issue OC till date	Nil
collection	Total collection related to OBPS module on a given date	Breakup by Payment Mode
permitsIssued	Total permits issued on a given date	Breakup by Risk Type, Occupancy Type and Sub Occupancy Type

FireNOC:

Metric	Definition	Breakup

Metric	Definition	Breakup
ward	the ward for which data is ingested	Nil
ulb	the ULB name for which data is ingested	Nil
region	the district or region for which data is ingested	Nil
state	the state for which the data belongs	Nil
todaysCollection	Sum of revenue collected from issuance of a Fire NOC Application fee + NOC Issuance fee + renewal fee	breakup by payment mode and by department.
todaysApplications	total number of applications received	breakup by application type and by department
nocIssuedToday	number of NOCs issued today by the concerned authority	breakup by type (actual or provisional)
applicationsSubmitted	Total number of applications submitted for a new and renewal of a Provisional NOC	breakup by department
provisionalNOCIssued	The Provisional NOC is to be obtained to ensure that the proposed constructions meet the fire safety compliant norms	breakup by department
actualNOCIssued	Total number of Fire NOCs issued by concerned authority	breakup by department
avgDaysToIssueProvisionalNOC	number of days taken to issue a Provisional NOC / Provisional NOCs issued	breakup by department
slaComplianceActual	number of Actual NOCs issued within SLA / Total applications	breakup by department
slaComplianceProvisional	number of Provisional NOCs issued within SLA / Total applications	breakup by department
avgDaysToIssueActualNOC	Total number of days taken to issue an actual NOC / Actual NOCs issued	breakup by department
actualNOCIssuedByDept	Total number of actual Fire NOCs issued by concerned authority	breakup by department

COMMON:

Metric	Definition	Breakup

Metric	Definition	Breakup
onboardedUlbsCount	Total number of ulbs onboarded till date	Nil
liveUlbsCount	Total number of live ulbs till date	Breakup by module
activeUlbsCount	Total number of active ulbs tiill date	Breakup by module
totalCitizensCount	Total number of citizens till date	Nil
SlaAchievement	Overall SLA Achievement across all modules	Nil

Sample Metrics:

Following are sample module wise payloads that has to be sent in the metric field in the /national-dashboard/metric/_ingest API.

Property Tax:

{
  "tenantId": "pb.amritsar",
  "state": "Punjab",
  "ward": "Ajit Nagar",
  "region": "Amritsar",
  "transactions": 2345,
  "totalApplications": 2100,
  "assessedProperties": 1400,
  "propertiesRegistered": [
    {
      "groupBy": "FinancialYear",
      "buckets": [
        {
          "name": "2019-20",
          "value": 300
        },
        {
          "name": "2020-21",
          "value": 1100
        },
        {
          "name": "2021-22",
          "value": 100
        }
      ]
    }
  ],
  "todaysCollection": [
    {
      "groupBy": "UsageCategory",
      "buckets": [
        {
          "name": "RESIDENTIAL",
          "value": 8000
        },
        {
          "name": "COMMERCIAL",
          "value": 7500
        },
        {
          "name": "INDUSTRIAL",
          "value": 8500
        }
      ]
    }
  ],
  "propertyTax": [
    {
      "groupBy": "UsageCategory",
      "buckets": [
        {
          "name": "RESIDENTIAL",
          "value": 8000
        },
        {
          "name": "COMMERCIAL",
          "value": 1000
        },
        {
          "name": "INDUSTRIAL",
          "value": 2000
        }
      ]
    }
  ],
  "cess": [
    {
      "groupBy": "UsageCategory",
      "buckets": [
        {
          "name": "RESIDENTIAL",
          "value": 1500
        },
        {
          "name": "COMMERCIAL",
          "value": 700
        },
        {
          "name": "INDUSTRIAL",
          "value": 800
        }
      ]
    }
  ],
  "rebate": [
    {
      "groupBy": "UsageCategory",
      "buckets": [
        {
          "name": "RESIDENTIAL",
          "value": 1000
        },
        {
          "name": "COMMERCIAL",
          "value": 0
        },
        {
          "name": "INDUSTRIAL",
          "value": 0
        }
      ]
    }
  ],
  "penalty": [
    {
      "groupBy": "UsageCategory",
      "buckets": [
        {
          "name": "RESIDENTIAL",
          "value": 3000
        },
        {
          "name": "COMMERCIAL",
          "value": 1000
        },
        {
          "name": "INDUSTRIAL",
          "value": 2000
        }
      ]
    }
  ],
  "interest": [
    {
      "groupBy": "UsageCategory",
      "buckets": [
        {
          "name": "RESIDENTIAL",
          "value": 1800
        },
        {
          "name": "COMMERCIAL",
          "value": 1000
        },
        {
          "name": "INDUSTRIAL",
          "value": 1200
        }
      ]
    }
  ]
}

Trade Licence:

{
  "ulb": "pb.amritsar",
  "state": "Punjab",
  "ward": "Ajit Nagar",
  "region": "Amritsar",
  "transactions": 600,
  "todaysApplications": 800,
  "todaysLicenseIssued": 120,
  "tlTax": 6000,
  "adhocPenalty": 3000,
  "adhocRebate": 1000,
  "todaysCollection": [
    {
      "groupBy": "tradeType",
      "buckets": [
        {
          "name": "BRICKFIELD",
          "value": 1000
        },
        {
          "name": "GROCERYSTORES",
          "value": 4000
        },
        {
          "name": "CHARCOAL_KLIN",
          "value": 3000
        }
      ]
    }
  ],
  "todaysTradeLicenses": [
    {
      "groupBy": "status",
      "buckets": [
        {
          "name": "PENDINGPAYMENT",
          "value": 1000
        },
        {
          "name": "APPROVED",
          "value": 4000
        },
        {
          "name": "APPLIED",
          "value": 3000
        }
      ]
    }
  ],
  "applicationsMovedToday": [
    {
      "groupBy": "status",
      "buckets": [
        {
          "name": "PENDINGPAYMENT",
          "value": 10
        },
        {
          "name": "APPROVED",
          "value": 40
        },
        {
          "name": "APPLIED",
          "value": 30
        }
      ]
    }
  ]
}

Public Grievance Redressal:

{
  "ulb": "pb.amritsar",
  "ward": "Ajit Nagar",
  "state": "Punjab",
  "region": "Amritsar",
  "closedComplaints": 2500,
  "slaAchievement": 50,
  "completionRate": 25,
  "uniqueCitizens": 1200,
  "resolvedComplaints": 1700,
  "todaysComplaints": [
    {
      "groupBy": "Status",
      "buckets": [
        {
          "name": "reopened",
          "value": 1500
        },
        {
          "name": "open",
          "value": 2000
        },
        {
          "name": "assigned",
          "value": 1600
        },
        {
          "name": "rejected",
          "value": 1400
        },
        {
          "name": "reassign",
          "value": 1000
        }
      ]
    },
    {
      "groupBy": "Channel",
      "buckets": [
        {
          "name": "MOBILE",
          "value": 1000
        },
        {
          "name": "WEB",
          "value": 9000
        }
      ]
    },
    {
      "groupBy": "Department",
      "buckets": [
        {
          "name": "DEPT1",
          "value": 2000
        },
        {
          "name": "DEPT2",
          "value": 5000
        },
        {
          "name": "DEP3",
          "value": 3000
        }
      ]
    },
    {
      "groupBy": "Category",
      "buckets": [
        {
          "name": "Street Lights",
          "value": 2000
        },
        {
          "name": "Road Repair",
          "value": 6000
        },
        {
          "name": "Garbage Cleaning",
          "value": 1000
        },
        {
          "name": "Drainage Issue",
          "value": 1000
        }
      ]
    }
  ],
  "todaysReopenedComplaints": [
    {
      "groupBy": "Department",
      "buckets": [
        {
          "name": "DEPT1",
          "value": 20
        },
        {
          "name": "DEPT2",
          "value": 5
        },
        {
          "name": "DEP3",
          "value": 3
        }
      ]
    }
  ],
  "todaysOpenComplaints": [
    {
      "groupBy": "Department",
      "buckets": [
        {
          "name": "DEPT1",
          "value": 2
        },
        {
          "name": "DEPT2",
          "value": 7
        },
        {
          "name": "DEPT3",
          "value": 11
        }
      ]
    }
  ],
  "todaysAssignedComplaints": [
    {
      "groupBy": "Department",
      "buckets": [
        {
          "name": "DEPT1",
          "value": 1
        },
        {
          "name": "DEPT2",
          "value": 0
        },
        {
          "name": "DEPT3",
          "value": 2
        }
      ]
    }
  ],
  "todaysRejectedComplaints": [
    {
      "groupBy": "Department",
      "buckets": [
        {
          "name": "DEPT1",
          "value": 2
        },
        {
          "name": "DEPT2",
          "value": 0
        },
        {
          "name": "DEPT3",
          "value": 0
        }
      ]
    }
  ],
  "todaysReassignedComplaints": [
    {
      "groupBy": "Department",
      "buckets": [
        {
          "name": "DEPT1",
          "value": 1
        },
        {
          "name": "DEPT2",
          "value": 3
        },
        {
          "name": "DEPT3",
          "value": 1
        }
      ]
    }
  ]
}

Water and Sewerage:

mCollect:

Online Building Permission System:

Fire NOC:

COMMON:

Frequency of ingesting data:

The recommended frequency for ingesting data for national dashboard is daily at midnight. For example, an employee who wants to ingest data for the date 1st January can do so on the end of the same day at midnight.