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

# List campaign trackers

> List superadmin campaign tracker snapshots with portal-compatible sorting and pagination.



## OpenAPI

````yaml /api/superadmin.openapi.yaml get /communications/campaign-trackers
openapi: 3.1.0
info:
  title: YouNegotiate Superadmin API
  version: '2.0'
  description: Stateless API endpoints for the Superadmin portal.
servers:
  - url: https://api.hub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public superadmin domain system and health endpoints.
  - name: Authentication
    description: Superadmin login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated superadmin profile endpoints.
  - name: Admin Configuration
    description: Platform configuration values and feature flag controls.
  - name: MailHub Users
    description: Superadmin management for EcoMail Hub / EcoPortal users.
  - name: Super Admin Users
    description: Superadmin management for platform operations users.
  - name: Consumers
    description: Superadmin consumer account list, detail, filter, and export endpoints.
  - name: Creditors
    description: Superadmin creditor account list and account access endpoints.
  - name: Sub Accounts
    description: Superadmin sub account list and export endpoints.
  - name: Reseller Partners
    description: Superadmin reseller partner list and report-history endpoints.
  - name: Special Plan Inquiries
    description: >-
      Superadmin special membership inquiry list, detail, resolve, and close
      endpoints.
  - name: Plans
    description: >-
      Superadmin membership plan list, create, update, reorder, visibility, and
      delete endpoints.
  - name: Failed - Canceled
    description: Superadmin failed or cancelled membership list and custom email endpoints.
  - name: Merchant Requests
    description: >-
      Superadmin merchant API request list, export, email, forwarding, progress,
      and approval endpoints.
  - name: Bill Pay Donations
    description: Superadmin Bill Pay gift donation list, export, and receipt endpoints.
  - name: Export & Reporting
    description: Superadmin generated report options and CSV download endpoints.
  - name: Communications / Templates
    description: >-
      Superadmin email and SMS template management for manual communications and
      campaigns.
  - name: Communications / Groups
    description: >-
      Superadmin communication group management for dynamic consumer targeting
      and campaign selection.
  - name: Communications / Schedule Campaign
    description: >-
      Superadmin email and SMS campaign scheduling, immediate send, and delivery
      queue endpoints.
  - name: Communications / Campaign Tracker
    description: >-
      Superadmin campaign tracker snapshots, refresh actions, and consumer
      exports.
  - name: Automated Communications
    description: >-
      Superadmin automated email/SMS templates, trigger configuration, and
      delivery history endpoints.
paths:
  /communications/campaign-trackers:
    get:
      tags:
        - Communications / Campaign Tracker
      summary: List campaign trackers
      description: >-
        List superadmin campaign tracker snapshots with portal-compatible
        sorting and pagination.
      operationId: superadminListCampaignTrackers
      parameters:
        - name: sort
          in: query
          required: false
          description: >-
            Sort field. Kebab-case values match the portal table; snake-case
            aliases are accepted where available.
          schema:
            type: string
            default: sent-on
            enum:
              - sent-on
              - created_at
              - template-name
              - template_name
              - template-type
              - template_type
              - group-name
              - group_name
              - total-balance
              - total_balance_of_consumers
              - consumer-count
              - consumer_count
              - sent
              - delivered
              - viewed
              - accepted-settlement-offer
              - pif_offer_count
              - accepted-plan-offer
              - ppl_offer_count
              - sent-offer
              - custom_offer_count
              - disputed-no-pay
              - dispute_no_pay_count
        - $ref: '#/components/parameters/SortDirection'
        - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          description: Campaign trackers returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperAdminCampaignTrackerListResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  parameters:
    SortDirection:
      name: direction
      in: query
      required: false
      description: Sort direction.
      schema:
        type: string
        enum:
          - asc
          - desc
    PerPage:
      name: per_page
      in: query
      required: false
      description: Number of records per page.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 25
  schemas:
    SuperAdminCampaignTrackerListResponse:
      type: object
      required:
        - data
        - pagination
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SuperAdminCampaignTracker'
        pagination:
          $ref: '#/components/schemas/Pagination'
    SuperAdminCampaignTracker:
      type: object
      required:
        - id
        - date_sent
        - template
        - group
        - total_balance
        - total_balance_label
        - consumer_count
        - sent_count
        - delivered_count
        - viewed_count
        - accepted_settlement_offer_count
        - accepted_plan_offer_count
        - sent_offer_count
        - disputed_no_pay_count
      properties:
        id:
          type: integer
          example: 501
        date_sent:
          type: string
          format: date-time
          nullable: true
          example: '2026-06-14T10:30:00.000000Z'
        template:
          oneOf:
            - $ref: '#/components/schemas/SuperAdminCampaignTemplateSummary'
            - type: 'null'
        group:
          oneOf:
            - $ref: '#/components/schemas/SuperAdminCampaignGroupSummary'
            - type: 'null'
        total_balance:
          oneOf:
            - type: string
            - type: number
          example: '1250.75'
        total_balance_label:
          type: string
          example: $1,250.75
        consumer_count:
          type: integer
          example: 25
        sent_count:
          type: integer
          description: Number of campaign recipients sent.
          example: 22
        delivered_count:
          type: integer
          description: Number of campaign recipients delivered.
          example: 20
        viewed_count:
          type: integer
          description: Number of campaign recipients viewed.
          example: 10
        accepted_settlement_offer_count:
          type: integer
          example: 3
        accepted_plan_offer_count:
          type: integer
          example: 2
        sent_offer_count:
          type: integer
          example: 5
        disputed_no_pay_count:
          type: integer
          example: 1
        created_at:
          type: string
          format: date-time
          nullable: true
        updated_at:
          type: string
          format: date-time
          nullable: true
    Pagination:
      type: object
      required:
        - current_page
        - from
        - last_page
        - per_page
        - to
        - total
      properties:
        current_page:
          type: integer
          example: 1
        from:
          type: integer
          nullable: true
          example: 1
        last_page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 25
        to:
          type: integer
          nullable: true
          example: 10
        total:
          type: integer
          example: 10
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    SuperAdminCampaignTemplateSummary:
      type: object
      required:
        - id
        - name
        - type
      properties:
        id:
          type: integer
          example: 10
        name:
          type: string
          example: Settlement Email
        type:
          $ref: '#/components/schemas/SuperAdminCampaignTemplateTypeSelection'
    SuperAdminCampaignGroupSummary:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: integer
          example: 25
        name:
          type: string
          example: Delivered January Group
    SuperAdminCampaignTemplateTypeSelection:
      type: object
      required:
        - value
        - label
      properties:
        value:
          $ref: '#/components/schemas/SuperAdminCampaignTemplateType'
        label:
          type: string
          example: Email
    SuperAdminCampaignTemplateType:
      type: string
      enum:
        - email
        - sms
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````