Get DB Stats Prometheus

GET {{URL}}/v1/stats/db?format=prometheus

Send a GET call to the /v1/stats/db endpoint with format = prometheus to retrieve database stats in Prometheus format.

Checking the database stats can take a long time and affect app performance if your database is large. It is recommended polling this information only when needed.

Returned Fields

Name	Description
`db_contacts` Type: Object	Current number of contacts in the database.
`db_message_receipts` Type: Object	Current number of message receipts in the database.
`db_messages` Type: Object	Current number of messages in the database.
`db_pending_callbacks` Type: Object	Current number of pending callbacks in the database.
`db_pending_messages` Type: Object	Current number of pending messages in the database.

Request Params

Key	Datatype	Required	Description
`format`	string

RESPONSES

status: OK

&quot;{\n    \&quot;stats\&quot;: {\n       \&quot;db\&quot;: {\n          \&quot;your-hostname1:your-container-id1\&quot;: {},\n          \&quot;your-primary-master:your-container-id2\&quot;: {\n             \&quot;db_contacts\&quot;: {\n               \&quot;data\&quot;: [ {\n                 \&quot;labels\&quot;: {\n                   \&quot;type\&quot;: \&quot;whatsapp_user\&quot;\n                 },\n                 \&quot;value\&quot;: 4\n               } ],\n               \&quot;help\&quot;: \&quot;Current number of contacts in DB\&quot;,\n               \&quot;type\&quot;: \&quot;gauge\&quot;\n             },\n\n             \&quot;db_message_receipts\&quot;: { ... },\n\n             \&quot;db_messages\&quot;: { ... },\n           \n             \&quot;db_pending_callbacks\&quot;: { ... },\n           \n             \&quot;db_pending_messages\&quot;: { ... }\n          },\n         \&quot;your-hostname3:your-container-id3\&quot;: {},\n         ...\n       }   \n    },\n    \&quot;meta\&quot;: {\n        \&quot;api_status\&quot;: \&quot;stable\&quot;,\n        \&quot;version\&quot;: \&quot;v2.45.1\&quot;\n    }\n}&quot;