Update REST API documentation Thu Mar 19 16:56:38 UTC 2026

Author: github-actions

restapi.json

@@ -3105,6 +3105,109 @@
                 }
             }
         },
+        "/api/v2/analytics/dashboard": {
+            "get": {
+                "tags": [
+                    "analytics"
+                ],
+                "summary": "Gets dashboard analytics statistics.",
+                "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns dashboard cards with aggregate analytics metrics.",
+                "operationId": "9d12b324dd31b9672eb96506e88a4147",
+                "parameters": [
+                    {
+                        "name": "php-auth-pw",
+                        "in": "header",
+                        "description": "Session key obtained from login",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "Success",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "properties": {
+                                        "total_subscribers": {
+                                            "properties": {
+                                                "value": {
+                                                    "type": "integer",
+                                                    "example": 48294
+                                                },
+                                                "change_vs_last_month": {
+                                                    "type": "number",
+                                                    "format": "float",
+                                                    "example": 12.5
+                                                }
+                                            },
+                                            "type": "object"
+                                        },
+                                        "active_campaigns": {
+                                            "properties": {
+                                                "value": {
+                                                    "type": "integer",
+                                                    "example": 12
+                                                },
+                                                "change_vs_last_month": {
+                                                    "type": "number",
+                                                    "format": "float",
+                                                    "example": 0
+                                                }
+                                            },
+                                            "type": "object"
+                                        },
+                                        "open_rate": {
+                                            "properties": {
+                                                "value": {
+                                                    "type": "number",
+                                                    "format": "float",
+                                                    "example": 12
+                                                },
+                                                "change_vs_last_month": {
+                                                    "type": "number",
+                                                    "format": "float",
+                                                    "example": 0
+                                                }
+                                            },
+                                            "type": "object"
+                                        },
+                                        "bounce_rate": {
+                                            "properties": {
+                                                "value": {
+                                                    "type": "number",
+                                                    "format": "float",
+                                                    "example": 12
+                                                },
+                                                "change_vs_last_month": {
+                                                    "type": "number",
+                                                    "format": "float",
+                                                    "example": 0
+                                                }
+                                            },
+                                            "type": "object"
+                                        }
+                                    },
+                                    "type": "object"
+                                }
+                            }
+                        }
+                    },
+                    "403": {
+                        "description": "Unauthorized",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/UnauthorizedResponse"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/api/v2/t/open.gif": {
             "get": {
                 "tags": [