WAFGOPreparing your page
Setup guide

API documentation

DEVELOPER RESOURCES · API REFERENCE

Explore WAFGO API services, request paths and message definitions. Browse by permission role to find the parameters and response structures for your integration.

Download JSON documentation
151 services1063 interfaces
Administrator service19 matching interfaces

Get administrator dashboard data

composeAdminDashboard

POST/AdminService/composeAdminDashboard
Original definition
rpc composeAdminDashboard (ComposeAdminDashboardRequest) returns (ComposeAdminDashboardResponse);

Request message

ComposeAdminDashboardRequest

Get administrator dashboard data

Request message · Field definitions
message ComposeAdminDashboardRequest {
	string apiVersion = 1; // Current API version
}

Response message

ComposeAdminDashboardResponse
Response message · Field definitions
message ComposeAdminDashboardResponse {
	int64 countNodeClusters = 1;
	int64 countNodes = 2;
	int64 countOfflineNodes = 9;
	int64 countServers = 3;
	int64 countAuditingServers = 13;
	int64 countUsers = 4;
	int64 countAPINodes = 5;
	int64 countOfflineAPINodes = 10;
	int64 countDBNodes = 6;
	int64 countOfflineDBNodes = 11;
	int64 countUserNodes = 7;
	int64 countOfflineUserNodes = 12;
	int64 defaultNodeClusterId = 8;

	repeated DailyTrafficStat dailyTrafficStats = 30;
	repeated HourlyTrafficStat hourlyTrafficStats = 31;

	UpgradeInfo nodeUpgradeInfo = 32;
	UpgradeInfo apiNodeUpgradeInfo = 33;
	UpgradeInfo userNodeUpgradeInfo = 35;
	UpgradeInfo authorityNodeUpgradeInfo = 36;
	UpgradeInfo nsNodeUpgradeInfo = 37;
	UpgradeInfo reportNodeUpgradeInfo = 41;

	repeated NodeStat topNodeStats = 38;
	repeated DomainStat topDomainStats = 39;
	repeated CountryStat topCountryStats = 42;

	repeated MetricDataChart metricDataCharts = 40;


	message DailyTrafficStat {
		string day = 1; // Date in YYYYMMDD format
		int64 bytes = 2;
		int64 cachedBytes = 3;
		int64 countRequests = 4;
		int64 countCachedRequests = 5;
		int64 countAttackRequests = 6;
		int64 attackBytes = 7; // Attack traffic in bytes
		int64 countIPs = 8; // Number of unique IP addresses
	}


	message HourlyTrafficStat {
		string hour = 1;
		int64 bytes = 2;
		int64 cachedBytes = 3;
		int64 countRequests = 4;
		int64 countCachedRequests = 5;
		int64 countAttackRequests = 6;
		int64 attackBytes = 7;
	}


	message NodeStat {
		int64 nodeId = 1;
		string nodeName = 2;
		int64 countRequests = 3;
		int64 bytes = 4;
	}


	message DomainStat {
		int64 serverId = 1;
		string domain = 2;
		int64 countRequests = 3;
		int64 bytes = 4;
	}


	message CountryStat {
		string countryName = 1;
		int64 bytes = 2;
		int64 countRequests = 3;
		float percent = 4; // Traffic share
		int64 countAttackRequests = 6;
		int64 attackBytes = 7;
	}

	// Node upgrade information

	message UpgradeInfo {
		int64 countNodes = 1; // Number of nodes
		string newVersion = 2; // New version
	}
}

Descriptions and comments follow your language. Request paths, method names, field names and types match the original API definitions.

Setup guide