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

# Get apiv2organizations messages analyticsoverview



## OpenAPI

````yaml https://api.osiro.com/doc get /api/v2/organizations/{orgId}/messages/{messageId}/analytics/overview
openapi: 3.0.0
info:
  title: osiro API
  version: 2.0.0
servers: []
security: []
tags:
  - name: Funnel
    description: Public funnel rendering, submission, MFA, and analytics.
  - name: Booking
    description: A lead's cancel and reschedule of their booking, via the manage link.
  - name: Training
    description: Org-scoped sales-training catalogs, sessions, and call records.
  - name: Attribution
    description: Cross-domain PostHog identity handoff for the marketing site.
  - name: Billing
    description: Org-scoped checkouts, plans, trials and the Stripe billing portal.
  - name: Leads
    description: Org-scoped lead reads and actions.
  - name: Ad copy
    description: Org-scoped ad guidelines and Meta ad copy generation.
paths:
  /api/v2/organizations/{orgId}/messages/{messageId}/analytics/overview:
    get:
      tags:
        - Message analytics
      parameters:
        - schema:
            type: string
            format: uuid
          required: true
          name: orgId
          in: path
        - schema:
            type: string
            format: uuid
          required: true
          name: messageId
          in: path
        - schema:
            type: string
            enum:
              - today
              - yesterday
              - 7d
              - 30d
              - 90d
              - all
              - custom
            default: 30d
          required: false
          name: range
          in: query
        - schema:
            type: string
            format: date
          required: false
          name: from
          in: query
        - schema:
            type: string
            format: date
          required: false
          name: to
          in: query
      responses:
        '200':
          description: >-
            Deliveries sent in the window and how many of them were delivered,
            opened, clicked, bounced and unsubscribed, with rates and secondary
            counts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageAnalyticsOverview'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    MessageAnalyticsOverview:
      type: object
      properties:
        current:
          type: object
          properties:
            sent:
              type: number
            delivered:
              type: object
              properties:
                count:
                  type: number
                rate:
                  type: number
                  nullable: true
              required:
                - count
                - rate
            opened:
              type: object
              properties:
                count:
                  type: number
                rate:
                  type: number
                  nullable: true
              required:
                - count
                - rate
            clicked:
              type: object
              properties:
                count:
                  type: number
                rate:
                  type: number
                  nullable: true
              required:
                - count
                - rate
            bounced:
              type: object
              properties:
                count:
                  type: number
                rate:
                  type: number
                  nullable: true
              required:
                - count
                - rate
            unsubscribed:
              type: object
              properties:
                count:
                  type: number
                rate:
                  type: number
                  nullable: true
              required:
                - count
                - rate
          required:
            - sent
            - delivered
            - opened
            - clicked
            - bounced
            - unsubscribed
        secondary:
          type: object
          properties:
            failed:
              type: number
            machineOpened:
              type: number
            clickToOpen:
              type: object
              properties:
                count:
                  type: number
                rate:
                  type: number
                  nullable: true
              required:
                - count
                - rate
            bounceSplit:
              type: object
              properties:
                hard:
                  type: number
                soft:
                  type: number
                dropped:
                  type: number
              required:
                - hard
                - soft
                - dropped
            spamReported:
              type: number
          required:
            - failed
            - machineOpened
            - clickToOpen
            - bounceSplit
            - spamReported
      required:
        - current
        - secondary
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - error

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.