politicalcomms-com Analytics API

openapi: 3.2.0
info:
  title: Political Comms Analytics API
  summary: Direct-to-carrier political texting API for campaigns, PACs, advocacy organizations, fundraisers, and elected officials.
  description: 'Public REST API for the Political Comms platform. Surfaces include Projects (compose, test, schedule, send), Conversations (read inbound threads and reply inside them), Contact Lists (S3 import and analysis), Media Files, Organizations and hierarchy, Brands, Campaigns, Tracking Domains, Phone Numbers, Analytics, and Billing.


    Authentication is an API key passed in the `X-API-Key` header. Keys are generated from the dashboard at Admin → API and are prefixed `pc_live_`. All POST and PATCH endpoints that mutate state are designed to be safe to retry, with optional `Idempotency-Key` headers for stronger guarantees. Rate limit is 600 requests per minute per key (bursts up to 600, refilling at 10 per second, the same for every scope; the `X-RateLimit-Limit` header reports your key''s exact limit, and `Retry-After` on a 429 is the seconds until your next request is allowed).


    Webhooks emit `message.sent`, `message.delivered`, `message.failed`, `message.replied`, and `link.clicked` events. Payloads are HMAC-signed; validate the signature before trusting any payload.


    A Model Context Protocol (MCP) server is available at https://docs.politicalcomms.com/mcp for AI agents that need to search the documentation programmatically. The developer hub at https://politicalcomms.com/developers/ has quickstart examples in cURL, raw HTTP, and Python.'
  version: 1.4.1
  termsOfService: https://politicalcomms.com/terms/
  contact:
    name: Political Comms Support
    email: support@politicalcomms.com
    url: https://docs.politicalcomms.com
  license:
    name: Proprietary
    url: https://politicalcomms.com/terms/
  x-logo:
    url: https://politicalcomms.com/images/brand/pcomms-logo-left-of-text.png
    altText: Political Comms
    backgroundColor: '#ffffff'
    href: https://politicalcomms.com/
  x-mcp:
    url: https://docs.politicalcomms.com/mcp
    discovery_url: https://docs.politicalcomms.com/.well-known/mcp
    transport: http
    auth: none
    tools:
    - search_political_comms
    - query_docs_filesystem_political_comms
    - submit_feedback
servers:
- url: https://api.politicalcomms.com/v1
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Analytics
  description: Message statistics and delivery performance.
paths:
  /messages/stats:
    get:
      tags:
      - Analytics
      summary: Get Message Stats
      description: Message delivery statistics for a date range. The range must be 31 days or less and may not start more than 180 days in the past or end in the future.
      operationId: getMessageStats
      parameters:
      - $ref: '#/components/parameters/StartDate'
      - $ref: '#/components/parameters/EndDate'
      - $ref: '#/components/parameters/OrganizationIdCamel'
      - $ref: '#/components/parameters/BrandIdCamel'
      - $ref: '#/components/parameters/CampaignIdCamel'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      totals:
                        type: object
                        description: Message counts and cost keyed by delivery status (unsent, queued, sending, sent, delivered, failed, received, on_hold). Only statuses present in the range appear.
                        additionalProperties:
                          type: object
                          properties:
                            count:
                              type: integer
                            totalCost:
                              type: number
                          additionalProperties: true
                      summary:
                        type: object
                        properties:
                          totalMessages:
                            type: integer
                          statusBreakdown:
                            type: object
                            properties:
                              unsent:
                                type: integer
                              queued:
                                type: integer
                              sending:
                                type: integer
                              sent:
                                type: integer
                              delivered:
                                type: integer
                              failed:
                                type: integer
                              received:
                                type: integer
                              onHold:
                                type: integer
                            additionalProperties: true
                          totalCost:
                            type: number
                          projectCount:
                            type: integer
                          organizationCount:
                            type: integer
                        additionalProperties: true
                      deliveryRates:
                        type: object
                        properties:
                          totalMessages:
                            type: integer
                          deliveredCount:
                            type: integer
                          failedCount:
                            type: integer
                          successfulCount:
                            type: integer
                          deliveryRate:
                            type: number
                            description: Percentage 0-100.
                          failureRate:
                            type: number
                            description: Percentage 0-100.
                          successRate:
                            type: number
                            description: Percentage 0-100.
                        additionalProperties: true
                      byDay:
                        type: array
                        items:
                          type: object
                          properties:
                            date:
                              type: string
                            status:
                              type: string
                            count:
                              type: integer
                            totalCost:
                              type: number
                          additionalProperties: true
                        description: One row per date + status combination, newest date first.
                      dateRange:
                        type: object
                        properties:
                          startDate:
                            type: string
                          endDate:
                            type: string
                        additionalProperties: true
                    additionalProperties: true
                required:
                - success
                - data
                additionalProperties: true
              example:
                success: true
                data:
                  totals:
                    delivered:
                      count: 11342
                      totalCost: 340.26
                    failed:
                      count: 458
                      totalCost: 13.74
                    received:
                      count: 312
                      totalCost: 0
                  summary:
                    totalMessages: 12112
                    statusBreakdown:
                      unsent: 0
                      queued: 0
                      sending: 0
                      sent: 0
                      delivered: 11342
                      failed: 458
                      received: 312
                      onHold: 0
                    totalCost: 354.0
                    projectCount: 1
                    organizationCount: 1
                  deliveryRates:
                    totalMessages: 12112
                    deliveredCount: 11342
                    failedCount: 458
                    successfulCount: 11800
                    deliveryRate: 93.64
                    failureRate: 3.78
                    successRate: 97.42
                  byDay:
                  - date: '2025-07-02T00:00:00.000Z'
                    status: delivered
                    count: 11342
                    totalCost: 340.26
                  - date: '2025-07-02T00:00:00.000Z'
                    status: failed
                    count: 458
                    totalCost: 13.74
                  dateRange:
                    startDate: '2025-07-01'
                    endDate: '2025-07-31'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    Forbidden:
      description: The API key lacks the required permission scope, or the requested resource belongs to an organization outside the key's hierarchy.
      content:
        application/json:
          schema:
            oneOf:
            - $ref: '#/components/schemas/AuthErrorResponse'
            - $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingScope:
              summary: Key lacks the required permission scope
              value:
                error: Insufficient permissions
                message: 'This API key does not have the required permissions: public:read'
            orgAccessDenied:
              summary: Resource outside the key's organization hierarchy
              value:
                error: 'Access denied: You do not have permission to access this organization''s data'
                code: ORG_ACCESS_DENIED
                correlationId: de038205-7c9c-4d4a-99bc-d7275a52f07e
    BadRequest:
      description: Invalid request (validation failure, malformed parameters, or a request the resource state does not allow).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Validation failed
            code: VALIDATION_ERROR
            correlationId: 030bf857-922f-4b82-8fca-c5b0769c1590
            details:
            - field: organization_id
              message: Invalid UUID
              code: invalid_format
    Unauthorized:
      description: Missing, malformed, revoked, or expired API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthErrorResponse'
          example:
            error: API key required
            message: Please provide an API key in the X-API-Key header
    RateLimited:
      description: Rate limit exceeded. Check the Retry-After header.
      headers:
        Retry-After:
          description: Seconds until the window resets.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
          example:
            success: false
            error: Rate limit exceeded
            message: Maximum 600 requests per 60 seconds
            code: RATE_LIMIT_EXCEEDED
            statusCode: 429
            retryAfter: 3
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: An unexpected error occurred. Please try again later.
            code: INTERNAL_ERROR
            correlationId: de038205-7c9c-4d4a-99bc-d7275a52f07e
  parameters:
    StartDate:
      name: startDate
      in: query
      required: true
      description: Start date in YYYY-MM-DD format
      schema:
        type: string
        format: date
        example: '2026-01-01'
    CampaignIdCamel:
      name: campaignId
      in: query
      required: false
      description: Filter to a specific campaign
      schema:
        type: string
    OrganizationIdCamel:
      name: organizationId
      in: query
      required: false
      description: Filter to a specific descendant organization
      schema:
        type: string
    EndDate:
      name: endDate
      in: query
      required: true
      description: End date in YYYY-MM-DD format
      schema:
        type: string
        format: date
        example: '2026-01-31'
    BrandIdCamel:
      name: brandId
      in: query
      required: false
      description: Filter to a specific brand
      schema:
        type: string
  schemas:
    RateLimitErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
          - false
        error:
          type: string
        message:
          type: string
        code:
          type: string
          enum:
          - RATE_LIMIT_EXCEEDED
        statusCode:
          type: integer
          enum:
          - 429
        retryAfter:
          type: integer
          description: Seconds until the rate-limit window resets. Also sent as the Retry-After header.
      required:
      - success
      - error
      - code
      - statusCode
      - retryAfter
      additionalProperties: true
    AuthErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Short error summary.
        message:
          type: string
          description: Human-readable detail.
      required:
      - error
      - message
      additionalProperties: true
      description: Error body returned by the API-key authentication layer (401 and permission 403s).
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Human-readable error message.
        code:
          type: string
          description: Machine-readable error code, e.g. VALIDATION_ERROR, ORG_ACCESS_DENIED, PROJECT_NOT_FOUND.
        correlationId:
          type: string
          description: Request correlation ID; include it in support requests.
        details:
          type:
          - array
          - object
          description: Present on some errors. For VALIDATION_ERROR, an array of { field, message, code } with one entry per rejected field (field is the dotted path); an object for other codes (e.g. insufficient-balance shortfall).
      required:
      - error
      - code
      additionalProperties: true
      description: Standard error body produced by the API error handler for 4xx/5xx responses.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Authenticate every request by passing your API key in the X-API-Key header. Keys are scoped to your organization hierarchy.