---
title: "Analytics summary"
method: GET
path: "/analytics"
---

# Analytics summary

`GET /analytics`

## Request

- Base URL: `https://app.voteship.app/api/v1`
- URL: `https://app.voteship.app/api/v1/analytics`
- Auth: HTTP bearer

Get aggregated analytics for a time period including stats, top posts, and trending tags.

## Query parameters

- `period` 'week' | 'month' | 'quarter'

## Response `200`

Analytics data

- object
  - `data` object
    - `period` string
    - `stats` object
      - `new_posts` integer
      - `total_votes` integer
      - `new_comments` integer
      - `page_views` integer
    - `top_posts` Post[]
      - `id` string
      - `projectId` string
      - `title` string
      - `description` string, nullable
      - `status` 'PENDING' | 'APPROVED' | 'IN_PROGRESS' | 'COMPLETE' | 'CLOSED' | 'ARCHIVED'
      - `voteCount` integer
      - `metadata` object, nullable: Private context. Replaces the object; null clears it. Omitted from public responses; available to secret-key APIs and trusted admin webhooks.
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
    - `trending_tags` object[]
      - `label` string
      - `post_count` integer

---

[API](https://skmtc.dev/voteship/apis/voteship-api.md) · [All operations](https://skmtc.dev/voteship/apis/voteship-api/llms.txt) · [OpenAPI document](https://skmtc.dev/voteship/apis/voteship-api/revisions/51ab9e650f82?raw)