guide to using API Stats in the latest v5 version

[tomandjerry27]

guide to using API Stats in the latest v5 version

my v2ray version:5.28.0

1. modify the config.json file on your server

{
    "log": {
        "access": "/var/log/v2ray/access.log",
        "error": "/var/log/v2ray/error.log",
        "loglevel": "warning"
    },
    "api": {
        "services": [
            "StatsService"
        ],
        "tag": "api"
    },
    "stats": {},
    "policy": {
        "levels": {
            "1": {
                "statsUserUplink": true,
                "statsUserDownlink": true
            }
        },
        "system": {
            "statsInboundUplink": true,
            "statsInboundDownlink": true,
            "statsOutboundUplink": true,
            "statsOutboundDownlink": true
        }
    },
    "inbounds": [
        {
            "port": 48965,
            "listen": "127.0.0.1",
            "protocol": "dokodemo-door",
            "settings": {
                "address": "127.0.0.1"
            },
            "tag": "api"
        },
        {
            "port": 48964,
            "protocol": "vmess",
            "settings": {
                "clients": [
                    {
                        "id": "user2 ipv4 hidden info",
                        "level": 1,
                        "alterId": 0,
                        "email": "[email protected]"
                    },
                    {
                        "id": "user1 ipv6 hidden info",
                        "level": 1,
                        "alterId": 0,
                        "email": "[email protected]"
                    }
                ]
            },
            "streamSettings": {
                "security": "tls",
                "tlsSettings": {
                    "serverName": "domain",
                    "certificates": [
                        {
                            "certificateFile": "/etc/v2ray/ssl/v2ray.crt",
                            "keyFile": "/etc/v2ray/ssl/v2ray.key"
                        }
                    ]
                }
            }
        }
    ],
    "outbounds": [
        {
            "protocol": "freedom",
            "settings": {},
            "tag": "freedom"
        }
    ],
    "routing": {
        "strategy": "rules",
        "settings": {
            "rules": [
                {
                    "type": "field",
                    "inboundTag": ["api"],
                    "outboundTag": "api"
                }
            ]
        }
    }
}
	

add

	"api": {...},

	"stats": {},

	"policy": {
        "levels": {
            "1": {
                "statsUserUplink": true,
                "statsUserDownlink": true
            }
        },
        "system": {
            "statsInboundUplink": true,
            "statsInboundDownlink": true,
            "statsOutboundUplink": true,
            "statsOutboundDownlink": true
        }
    },

"1" in "levels" should be same to "level" in "clients"

add "email" inside "clients" if you want to track stats by users

add a dokodemo-door inside "inbounds"

		{
            "port": 48965,
            "listen": "127.0.0.1",
            "protocol": "dokodemo-door",
            "settings": {
                "address": "127.0.0.1"
            },
            "tag": "api"
        },

add one "rules" inside "routing-->settings"

                {
                    "type": "field",
                    "inboundTag": ["api"],
                    "outboundTag": "api"
                }

check out your blocked rule

	"outbounds": [
        {
            "protocol": "blackhole",
            "settings": {},
            "tag": "blocked"
        }
    ],
    "routing": {
        "strategy": "rules",
        "settings": {
            "rules": [
                {
                    "type": "field",
                    "ip": [
                        "0.0.0.0/8",
                        "10.0.0.0/8",
                        "100.64.0.0/10",
                        "127.0.0.0/8",
                        "169.254.0.0/16",
                        "172.16.0.0/12",
                        "192.0.0.0/24",
                        "192.0.2.0/24",
                        "192.168.0.0/16",
                        "198.18.0.0/15",
                        "198.51.100.0/24",
                        "203.0.113.0/24",
                        "::1/128",
                        "fc00::/7",
                        "fe80::/10"
                    ],
                    "outboundTag": "blocked"
                }
            ]
        }
    }

your api query may be blocked according to "127.0.0.0/8"
you can find blocked records in access.log like 127.0.0.1:58166 accepted tcp:127.0.0.1:0 [blocked]
had better delete such blocked rule

2. restart your v2ray server

[root@vps ~]# systemctl restart v2ray

confirm it's working

[root@vps ~]# systemctl status v2ray
...

3. run api stats query

list all stats that have been active since v2ray last started

[root@vps ~]# /bin/v2ray/v2ray api stats --server=127.0.0.1:48965
    Value       Name
1   24.00B      inbound>>>api>>>traffic>>>downlink
2   174.00B     inbound>>>api>>>traffic>>>uplink
3   810.66KB    outbound>>>freedom>>>traffic>>>downlink
4   233.78KB    outbound>>>freedom>>>traffic>>>uplink
5   810.66KB    user>>>[email protected]>>>traffic>>>downlink
6   233.81KB    user>>>[email protected]>>>traffic>>>uplink

Total: 2.04MB

there were no traffic through user '[email protected]' since v2ray last ran,so it isn't displayed

you can also choose one name to query

[root@vps ~]# /bin/v2ray/v2ray api stats --server=127.0.0.1:48965 'user>>>[email protected]>>>traffic>>>downlink'
    Value       Name
1   820.80KB    user>>>[email protected]>>>traffic>>>downlink

Total: 820.80KB

4. tips

it's better to check out access.log file more often when debugging

[root@vps ~]# tail -n 8 /var/log/v2ray/access.log
2025/03/19 15:45:38 127.0.0.1:59120 accepted tcp:127.0.0.1:0 [api]
2025/03/19 15:45:41 [ip***************]:25831 accepted tcp:alive.github.com:443 [freedom] email: [email protected]
2025/03/19 15:45:45 [ip***************]:25833 accepted tcp:alive.github.com:443 [freedom] email: [email protected]
2025/03/19 15:45:50 [ip***************]:25835 accepted tcp:github.com:443 [freedom] email: [email protected]
2025/03/19 15:45:59 [ip***************]:25837 accepted tcp:alive.github.com:443 [freedom] email: [email protected]
2025/03/19 15:46:21 [ip***************]:25847 accepted tcp:api.github.com:443 [freedom] email: [email protected]
2025/03/19 15:46:49 [ip***************]:25851 accepted tcp:mtalk.google.com:5228 [freedom] email: [email protected]
2025/03/19 15:51:56 [ip***************]:25872 accepted tcp:accounts.youtube.com:443 [freedom] email: [email protected]

it displays the api query records
you can also find email here to make sure that user stats is working

check out listening port

[root@vps ~]# netstat -nlp
...

finally,don't forget to send a reply if this guide is helpful.this will help more people see it.