---
updatedAt: 2026-07-13T13:58:38.000Z
agentTools:
  projectIndex: https://developer.livehealthily.com/llms.txt
---

# Push UI analytics data

Push UI analytics data Publishes analytics events of user interactions in the UI

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Healthily API documentation",
    "version": "1.0.0-RC1"
  },
  "servers": [
    {
      "url": "https://portal.your.md",
      "description": "Production server url"
    },
    {
      "url": "http://localhost:8080",
      "description": "Local testing url"
    }
  ],
  "tags": [
    {
      "name": "Analytics",
      "description": "The Analytics API"
    }
  ],
  "paths": {
    "/api/v1/analytics": {
      "post": {
        "tags": [
          "Analytics"
        ],
        "summary": "Push UI analytics data",
        "description": "Push UI analytics data Publishes analytics events of user interactions in the UI",
        "operationId": "submitAnalytics",
        "parameters": [
          {
            "name": "authorization",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "Bearer your-token"
          },
          {
            "name": "x-api-key",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            },
            "example": "your-api-key"
          }
        ],
        "requestBody": {
          "description": "(required)",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AnalyticsRequest"
              }
            }
          },
          "required": true
        },
        "responses": {
          "200": {
            "description": "Analytics data published successfully",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "400": {
            "description": "Wrong data input",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "BearerAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "AnalyticsRequest": {
        "required": [
          "event"
        ],
        "type": "object",
        "properties": {
          "event": {
            "type": "string",
            "description": "Type of event to publish",
            "example": "accordion_item_opened"
          },
          "value": {
            "type": "object"
          }
        },
        "description": "Analytics Data request DTO. Value can be any valid type: string, array, map"
      },
      "ErrorResponse": {
        "required": [
          "error",
          "message"
        ],
        "type": "object",
        "properties": {
          "error": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "description": "Basic error response"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  }
}
```