> ## 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 clicks (timeseries or breakdown)



## OpenAPI

````yaml /api-reference/openapi.json get /v1/analytics/clicks
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/clicks:
    get:
      tags:
        - Analytics
      summary: Signature clicks (timeseries or breakdown)
      parameters:
        - name: granularity
          in: query
          required: false
          schema:
            type: string
            enum:
              - hour
              - day
              - week
              - month
      responses:
        '200':
          description: Timeseries (clicks projected)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_timeseries_response'
      security:
        - ApiKey: []
components:
  schemas:
    analytics_timeseries_response:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              period:
                type: string
                format: date-time
                description: Bucket start as an ISO-8601 UTC instant.
              count:
                type: integer
            required:
              - period
              - count
            additionalProperties: false
        totals:
          type: object
          properties:
            count:
              type: integer
          required:
            - count
          additionalProperties: false
        granularity:
          type: string
          enum:
            - hour
            - day
            - week
            - month
        time_zone:
          type: string
      required:
        - data
        - totals
        - granularity
        - time_zone
      additionalProperties: false
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer

````