Paubox

Paubox Analytics API

Campaign analytics and reporting operations

Documentation GitHub OpenAPI

Business capability

Operations 5

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /analytics/campaign_mailing_send_totals Get send totals for marketing campaigns · Fetch campaign analytics #

Ask an LLM

“What are the overall delivery and engagement totals across the campaigns I've sent?”

“Can I get the stats totals for just one campaign send instead of all of them?”

Tell an agent

Show me the aggregate stats for every campaign I've sent.

Total up the results for campaign send {campaign_mailing_send_id}.

GET /analytics/campaign_mailing_sends_table List sent campaigns as an analytics table · Fetch campaign table #

Ask an LLM

“Where can I see a row-by-row table of every campaign I've sent?”

“Can I search the sent-campaigns table by a field and value pair?”

Tell an agent

Pull the sent campaigns table sorted by {order_by}.

Search the sent campaigns table for {search}.

GET /analytics/tracking_links_by_unique_link Get link interaction stats grouped by unique link · Fetch tracking links by unique link #

Ask an LLM

“Which links in a campaign got clicked, grouped per unique link?”

“How many interactions did each distinct link in my sent campaign receive?”

Tell an agent

Break down the link interactions for campaign send {campaign_mailing_send_id} by unique link.

Show unique-link click analytics for send {campaign_mailing_send_id}, ordered {order}.

GET /analytics/subscribers_by_tracking_link List subscribers who interacted with a tracking link · Fetch subscribers by tracking link #

Ask an LLM

“Who exactly clicked a particular link in my campaign email?”

“Can I see the list of subscribers tied to one tracking link in a campaign send?”

Tell an agent

List the subscribers who clicked link {html_id} in campaign send {campaign_mailing_send_id}.

Find which contacts engaged with tracking link {html_id} from send {campaign_mailing_send_id}.

GET /analytics/campaign_mailing_deliveries_table List per-recipient deliveries for a campaign · Fetch campaign deliveries table #

Ask an LLM

“How do I see the individual deliveries that went out for a campaign?”

“Can I look up deliveries by the marketing email itself rather than by a specific send?”

Tell an agent

Show the deliveries table for campaign send {campaign_mailing_send_id}.

List every delivery made for marketing email {campaign_mailing_id}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/paubox:paubox-analytics-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Paubox Marketing Analytics API
  description: 'Public documentation Paubox Marketing API.


    All Paubox Marketing customers have access to the Paubox Marketing API to automate various tasks.


    ## Authentication

    Use the authorization header in requests with the format: `authorization: Token token=`


    Replace `` with your API key. Find your API key in the address bar from the email builder (note: each API Key is displayed only once upon creation).


    ## Base URL

    `https://api.paubox.com/v1/marketing`'
  contact:
    name: Paubox Support
    url: https://www.paubox.com
  version: 1.0.0
servers:
- url: https://api.paubox.com/v1/marketing
  description: Production server
security:
- TokenAuth: []
tags:
- name: Analytics
  description: Campaign analytics and reporting operations
paths:
  /analytics/campaign_mailing_send_totals:
    get:
      tags:
      - Analytics
      summary: Fetch campaign analytics
      description: Return json data statistics about campaigns sent
      operationId: getCampaignAnalytics
      parameters:
      - name: campaign_mailing_send_id
        in: query
        description: Id of a specific campaign to total
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Campaign analytics data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignAnalyticsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /analytics/campaign_mailing_sends_table:
    get:
      tags:
      - Analytics
      summary: Fetch campaign table
      description: Return json data information about campaigns sent
      operationId: getCampaignTable
      parameters:
      - name: search
        in: query
        description: Field:Value pair to search on. Defaults to all records
        required: false
        schema:
          type: string
        example: '{ "field": "value" }'
      - name: order_by
        in: query
        description: Order by attributes. Defaults to created_at
        required: false
        schema:
          type: string
          default: created_at
      - name: order
        in: query
        description: Order direction
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
      responses:
        '200':
          description: Campaign table data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignTableResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /analytics/tracking_links_by_unique_link:
    get:
      tags:
      - Analytics
      summary: Fetch tracking links by unique link
      description: Returns json data about interactions with tracking links
      operationId: getTrackingLinksByUniqueLink
      parameters:
      - name: campaign_mailing_send_id
        in: query
        description: Campaign id to search on
        required: true
        schema:
          type: string
      - name: order_by
        in: query
        description: Order by attributes. Defaults to created_at
        required: false
        schema:
          type: string
          default: created_at
      - name: order
        in: query
        description: Order direction
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
      responses:
        '200':
          description: Tracking links data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrackingLinksResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /analytics/subscribers_by_tracking_link:
    get:
      tags:
      - Analytics
      summary: Fetch subscribers by tracking link
      description: Returns json data about subscribers for a specific tracking link
      operationId: getSubscribersByTrackingLink
      parameters:
      - name: campaign_mailing_send_id
        in: query
        description: Campaign id to search on
        required: true
        schema:
          type: string
      - name: html_id
        in: query
        description: html_id of the associated tracking link
        required: true
        schema:
          type: integer
      - name: order_by
        in: query
        description: Order by non-id attributes. Defaults to created_at
        required: false
        schema:
          type: string
          default: created_at
      - name: order
        in: query
        description: Order direction
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
      responses:
        '200':
          description: Subscribers by tracking link data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscribersByTrackingLinkResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
  /analytics/campaign_mailing_deliveries_table:
    get:
      tags:
      - Analytics
      summary: Fetch campaign deliveries table
      description: Returns json data about campaign deliveries sent
      operationId: getCampaignDeliveriesTable
      parameters:
      - name: campaign_mailing_send_id
        in: query
        description: Campaign id to search on (one of campaign_mailing_send_id or campaign_mailing_id is required)
        required: false
        schema:
          type: string
      - name: campaign_mailing_id
        in: query
        description: Paubox Marketing Campaign Email id to search on (one of campaign_mailing_send_id or campaign_mailing_id is required)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Campaign deliveries table data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignDeliveriesTableResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  responses:
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    SubscribersByTrackingLinkResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubscribersByTrackingLinkResponse_data'
    CampaignAnalyticsResponse:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/CampaignAnalyticsResponse_data'
    CampaignDeliveriesTableResponse_data:
      type: object
      properties:
        recipient:
          type: string
          description: Email recipient
        created_at:
          type: string
          description: Creation timestamp
          format: date-time
        delivered:
          type: boolean
          description: Whether email was delivered
        viewed:
          type: boolean
          description: Whether email was viewed
        clicked:
          type: boolean
          description: Whether email was clicked
        bounced:
          type: boolean
          description: Whether email bounced
        unsubscribed:
          type: boolean
          description: Whether recipient unsubscribed
        tracking_links:
          type: object
          additionalProperties:
            type: string
          description: Tracking link information (dynamic property names based on actual URLs)
    SubscribersByTrackingLinkResponse_attributes:
      type: object
      properties:
        email:
          type: string
          description: Subscriber's email address
          format: email
        first_name:
          type: string
          description: Subscriber's first name
        last_name:
          type: string
          description: Subscriber's last name
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/SubscribersByTrackingLinkResponse_attributes_custom_fields'
    CampaignTableResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CampaignTableResponse_data'
    TrackingLinksResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TrackingLinksResponse_data'
    TrackingLinksResponse_data:
      type: object
      properties:
        html_id:
          type: integer
          description: HTML ID of the tracking link
        target_url:
          type: string
          description: Target URL of the tracking link
        clicked:
          type: integer
          description: Number of clicks on this link
    CampaignDeliveriesTableResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CampaignDeliveriesTableResponse_data'
    CampaignTableResponse_data:
      type: object
      properties:
        id:
          type: string
          description: Campaign table entry ID
        marketing_email_id:
          type: string
          description: Marketing email ID
        campaign_mailing_id:
          type: string
          description: Campaign mailing ID
        campaign_mailing_created_at:
          type: string
          description: Campaign mailing creation timestamp
          format: date-time
        sent_at:
          type: string
          description: Campaign sent timestamp
          format: date-time
        subscription_list_name:
          type: string
          description: Name of the subscription list
    CampaignAnalyticsResponse_data:
      type: object
      properties:
        delivered:
          type: integer
          description: Number of delivered emails
        viewed:
          type: integer
          description: Number of viewed emails
        clicked:
          type: integer
          description: Number of clicked emails
        bounced:
          type: integer
          description: Number of bounced emails
        soft_bounced:
          type: integer
          description: Number of soft bounced emails
        hard_bounced:
          type: integer
          description: Number of hard bounced emails
        unsubscribed:
          type: integer
          description: Number of unsubscribed emails
        global_unsubscribed:
          type: integer
          description: Number of global unsubscribed emails
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        code:
          type: string
          description: Error code
        details:
          type: object
          description: Additional error details
    SubscribersByTrackingLinkResponse_data:
      type: object
      properties:
        id:
          type: string
          description: Subscriber ID
        type:
          type: string
          description: Resource type
        attributes:
          $ref: '#/components/schemas/SubscribersByTrackingLinkResponse_attributes'
    SubscribersByTrackingLinkResponse_attributes_custom_fields:
      type: object
      properties:
        subscriber_custom_field_type_id:
          type: string
          description: Custom field type ID
        value:
          type: string
          description: Custom field value
  securitySchemes:
    TokenAuth:
      type: apiKey
      description: 'Token-based authentication. Use format: "Token token=<API_KEY>" where <API_KEY> is your API key'
      name: authorization
      in: header

Paubox Analytics API

Operations 5

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification