> ## Documentation Index
> Fetch the complete documentation index at: https://docs.botdog.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Account analytics

> Account-level analytics across all campaigns for a period.



## OpenAPI

````yaml /openapi.json get /v1/analytics
openapi: 3.0.0
info:
  title: Botdog API
  description: |-
    API documentation for Botdog.

    **Authentication**: Pass your API key as the `x-api-key` header.
    Example: `x-api-key: bd_live_abc123`

    Do NOT use the `Authorization` header.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.botdog.co
    description: Production
security: []
tags:
  - name: campaigns
    description: >-
      Create, read, update, and control campaigns (pause/resume, pause
      activities, archive, delete).
  - name: leads
    description: >-
      List and filter leads, read full detail + event history, update metadata,
      add to a campaign, or stop a sequence.
  - name: lists
    description: Manage lead/audience lists and their members.
  - name: blacklist
    description: Manage suppression lists (excluded profiles).
  - name: snippets
    description: Manage message snippets / templates.
  - name: accounts
    description: >-
      Connected LinkedIn accounts (seats), their connection health, and daily
      sending limits.
  - name: webhooks
    description: Manage webhook subscriptions.
  - name: messaging
    description: >-
      Send messages and replies, schedule a future send, and mark conversations
      read/unread. Rate-limited per sending account.
  - name: analytics
    description: Team-level analytics totals, daily breakdowns, and per-user metrics.
  - name: users
    description: Read the users in your team.
  - name: teams
    description: Current team context.
  - name: health
    description: Service health checks (no authentication).
paths:
  /v1/analytics:
    get:
      tags:
        - analytics
      summary: Account analytics
      description: Account-level analytics across all campaigns for a period.
      operationId: AnalyticsController_getAccountAnalytics
      parameters:
        - name: period
          required: false
          in: query
          description: Time period for analytics
          schema:
            default: last-7-days
            type: string
            enum:
              - last-7-days
              - last-30-days
              - last-90-days
        - name: userId
          required: false
          in: query
          description: Filter to a specific user
          schema:
            type: string
            example: user_abc123
      responses:
        '200':
          description: Aggregated outreach metrics for the account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsResponseDto'
        '401':
          description: Unauthorized. API key is missing or invalid.
        '429':
          description: Rate limit exceeded. Retry after cooldown.
      security:
        - api-key: []
components:
  schemas:
    AnalyticsResponseDto:
      type: object
      properties:
        period:
          type: string
          example: last-7-days
        invitations:
          $ref: '#/components/schemas/InvitationsDto'
        messages:
          $ref: '#/components/schemas/MessagesDto'
        campaigns:
          $ref: '#/components/schemas/CampaignsSummaryDto'
      required:
        - period
        - invitations
        - messages
        - campaigns
    InvitationsDto:
      type: object
      properties:
        sent:
          type: number
          example: 677
        accepted:
          type: number
          example: 92
        rate:
          type: number
          description: Acceptance rate as percentage
          example: 13.6
      required:
        - sent
        - accepted
        - rate
    MessagesDto:
      type: object
      properties:
        sent:
          type: number
          example: 92
        replied:
          type: number
          example: 4
        rate:
          type: number
          description: Reply rate as percentage
          example: 4.3
      required:
        - sent
        - replied
        - rate
    CampaignsSummaryDto:
      type: object
      properties:
        active:
          type: number
          example: 6
        totalLeadsInProgress:
          type: number
          example: 1420
      required:
        - active
        - totalLeadsInProgress
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key
      x-default: bd_live_your_key_here

````