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

# Batch Track Notification Analytics

> Records multiple notification delivery, open, or click events.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/notification-analytics/batch-track
openapi: 3.1.0
info:
  title: TheFaithApp Partner API
  version: 1.0.0
  description: >-
    The v1 API for third-party apps that sign in TheFaithApp members and access
    church-scoped content and workflows.
  contact:
    name: TheFaithApp Support
    email: support@thefaithapp.com
servers:
  - url: https://api.thefaithapp.com
    description: Production
security:
  - apiKeyAuth: []
    bearerAuth: []
tags:
  - name: Hosted Auth
    description: Sign members in through the hosted TheFaithApp authentication flow.
  - name: Core Experience
    description: Load member context and the personalized home experience.
  - name: Content
    description: >-
      Read sermons, media, YouTube videos, devotionals, and streaming
      configuration.
  - name: Engagement
    description: Manage member favorites and devotional bookmarks.
  - name: Churches
    description: Read church profiles, public directory records, and branch information.
  - name: Events & Volunteers
    description: >-
      Browse events and volunteer opportunities, then manage registrations and
      commitments.
  - name: Notifications & Bulletins
    description: Read church and member notifications and published bulletins.
  - name: Prayer
    description: Submit a prayer request for the authenticated member.
  - name: Member Connections
    description: Manage the member’s campus and ministry connections.
  - name: Community Groups
    description: >-
      Discover groups and manage membership, feeds, attendance, study guides,
      and leader notes.
  - name: Community Preferences & Research
    description: >-
      Manage community preferences, summaries, and consent-based research
      participation.
  - name: Resource Sharing
    description: Offer shared resources and manage member loan requests and transitions.
  - name: Mutual Aid
    description: >-
      Manage needs and offers, private responses, safety reports, and member
      activity.
  - name: Analytics
    description: Record product analytics events and retrieve aggregate metrics.
  - name: Notification Analytics
    description: Record and summarize notification delivery, open, and click events.
paths:
  /v1/notification-analytics/batch-track:
    post:
      tags:
        - Notification Analytics
      summary: Batch Track Notification Analytics
      description: Records multiple notification delivery, open, or click events.
      operationId: postNotificationAnalyticsBatchTrack
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                events:
                  type: array
                  items:
                    type: object
                    properties:
                      event_type:
                        type: string
                        enum:
                          - delivery
                          - open
                          - click
                      notification_id:
                        type: string
                        description: Notification analytics identifier.
                      member_id:
                        type: integer
                        description: Optional member identifier.
                      platform:
                        type: string
                        description: Mobile platform.
                        enum:
                          - ios
                          - android
                      app_version:
                        type: string
                        description: App version.
                      action_type:
                        type: string
                        description: Optional click action type.
                      action_data:
                        type: object
                        description: Optional click action metadata.
                        additionalProperties: true
                    required:
                      - event_type
                      - notification_id
                  description: Notification events.
              required:
                - events
            example:
              events:
                - event_type: delivery
                  notification_id: notification-123
                  platform: ios
      responses:
        '200':
          description: Batch processed.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
              example:
                results:
                  - notification_id: notification-123
                    event_type: delivery
                    success: true
        '401':
          $ref: '#/components/responses/Unauthorized'
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  responses:
    Unauthorized:
      description: >-
        The API key or member bearer token is missing, invalid, expired, or
        belongs to another church.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ValidationError:
      description: One or more request fields failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      description: >-
        Error response. Validation failures also include an `errors` object
        keyed by field name.
      properties:
        status:
          type: string
          example: Error
        message:
          type: string
          example: The request could not be completed.
        error:
          type:
            - string
            - 'null'
          example: null
        error_message:
          type:
            - string
            - 'null'
          example: null
        errors:
          type: object
          additionalProperties: true
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Client API key copied from Developer Access in the TheFaithApp
        dashboard.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum
      description: Member access token returned by `POST /v1/auth/token`.

````