> ## Documentation Index
> Fetch the complete documentation index at: https://help.scribe-mail.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Signature views (timeseries or breakdown)



## OpenAPI

````yaml /api-reference/openapi.json get /v1/analytics/views
openapi: 3.0.1
info:
  title: Scribe Public API
  version: v1
  description: >-
    REST API to manage email signatures, teammates, smart fields, and marketing
    campaigns in your Scribe workspace. Every request uses JSON and is
    authenticated with a workspace API key. Endpoints are versioned under `/v1`,
    for example `https://api.scribe-mail.com/v1/signatures`.
  contact:
    name: Scribe Support
    url: https://help.scribe-mail.com/en
servers:
  - url: https://api.scribe-mail.com
    description: Production
security: []
tags:
  - name: Signatures
    description: >-
      Create, update, publish, and install email signature templates, and
      control which teammates each signature is assigned to.
  - name: Teammates
    description: >-
      Manage the people whose signatures Scribe deploys, and set their smart
      field values.
  - name: Emails
    description: >-
      Manage teammate email addresses, including the aliases that receive a
      signature.
  - name: Smart fields
    description: >-
      Define the dynamic fields, such as job title, phone number, or calendar
      link, that populate signatures.
  - name: Folders
    description: Organize signature templates into folders.
  - name: Assets
    description: >-
      Upload and manage the images and files used across signatures and
      campaigns.
  - name: Marketing campaigns
    description: >-
      Schedule, pause, and resume the promotional banners shown in your team's
      signatures.
  - name: Integrations
    description: >-
      List the directory, HRIS, and email integrations connected to your
      workspace.
  - name: Integration entities
    description: >-
      List the org units and groups from your connected integrations, used to
      target signatures.
  - name: Financial documents
    description: List the invoices and financial documents for your workspace.
paths:
  /v1/analytics/views:
    get:
      tags:
        - Analytics
      summary: Signature views (timeseries or breakdown)
      parameters:
        - name: granularity
          in: query
          required: false
          schema:
            type: string
            enum:
              - hour
              - day
              - week
              - month
        - name: group_by
          in: query
          required: false
          schema:
            type: string
            enum:
              - signature_template
              - marketing_campaign
              - teammate
              - anchor
              - country
        - name: start_date
          in: query
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          schema:
            type: string
        - name: signature_template_id
          in: query
          required: false
          schema:
            type: string
        - name: marketing_campaign_id
          in: query
          required: false
          schema:
            type: string
        - name: teammate_id
          in: query
          required: false
          schema:
            type: string
        - name: order
          in: query
          required: false
          schema:
            type: string
            enum:
              - asc
              - desc
        - name: limit
          in: query
          required: false
          schema:
            type: integer
        - name: page
          in: query
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: Breakdown by group_by
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_breakdown_response'
        '401':
          description: Missing/invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '403':
          description: Insufficient scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
        '404':
          description: Unknown filter UUID
        '422':
          description: Invalid group_by
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
      security:
        - ApiKey: []
components:
  schemas:
    analytics_breakdown_response:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/analytics_breakdown_row'
        pagination:
          $ref: '#/components/schemas/offset_pagination'
      required:
        - data
        - pagination
      additionalProperties: false
    error_response:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
          required:
            - type
            - code
            - message
          additionalProperties: false
        remediation:
          type: object
          description: >-
            Optional dashboard hand-off: where to send the user to unblock the
            request (e.g. connect an integration). Present on some 403/409
            responses.
          properties:
            action:
              type: string
              enum:
                - connect_integration
                - manage_in_dashboard
                - upgrade_plan
            dashboard_url:
              type: string
              format: uri
            message:
              type: string
          required:
            - action
            - dashboard_url
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    analytics_breakdown_row:
      type: object
      properties:
        id:
          type: string
          description: >-
            Subject UUID; for the `country` group_by, the ISO 3166-1 alpha-2
            code.
        label:
          type: string
          nullable: true
          description: >-
            Human label: signature/campaign name, country name, link content, or
            teammate primary email. Null when none is available.
        view_count:
          type: integer
        click_count:
          type: integer
        clickthrough_rate:
          type: number
          description: click_count / view_count as a percentage, rounded to 2 decimals.
      required:
        - id
        - label
        - view_count
        - click_count
        - clickthrough_rate
      additionalProperties: false
    offset_pagination:
      type: object
      description: >-
        Offset (page/limit) pagination. The single pagination shape returned by
        every paginated list endpoint in the public API.
      properties:
        page:
          type: integer
        limit:
          type: integer
        total_count:
          type: integer
        total_pages:
          type: integer
        has_more:
          type: boolean
      required:
        - page
        - limit
        - total_count
        - total_pages
        - has_more
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer

````