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

# List Inbox-Tracking Campaigns

> API to get inbox tracking details for Email API campaigns. Returns a paginated list of campaigns enriched with inbox / spam / missed placement percentages and a per-mailbox-provider breakdown. Supports filtering by campaign id, subject, sender and date range, plus sorting on key metrics.

**Sample Code**



## OpenAPI

````yaml /openapi-emailapi.json post /v2/email/inbox-tracking
openapi: 3.1.0
info:
  title: Mailercloud Email API
  version: 1.0.0
  description: Transactional and personalized email sending — the Mailercloud API Platform.
servers:
  - url: https://email-api.mailercloud.com
security:
  - apiKey: []
tags:
  - name: Email
paths:
  /v2/email/inbox-tracking:
    post:
      tags:
        - Email
      summary: List Inbox-Tracking Campaigns
      description: >-
        API to get inbox tracking details for Email API campaigns. Returns a
        paginated list of campaigns enriched with inbox / spam / missed
        placement percentages and a per-mailbox-provider breakdown. Supports
        filtering by campaign id, subject, sender and date range, plus sorting
        on key metrics.


        **Sample Code**
      operationId: list-email-api-inbox-tracking-campaigns
      parameters:
        - name: Content-Type
          in: header
          required: true
          description: Request body type
          schema:
            type: string
            default: application/json
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - page
                - limit
              properties:
                page:
                  type: integer
                  minimum: 1
                  description: 1-based page number.
                  examples:
                    - 1
                limit:
                  type: integer
                  enum:
                    - 10
                    - 20
                    - 50
                    - 100
                  description: Records per page. Must be one of 10, 20, 50, 100.
                  examples:
                    - 10
                campaign_id:
                  type: string
                  description: Filter by campaign id (partial match).
                  examples:
                    - '750373463838949401'
                subject:
                  type: string
                  description: Filter by subject (partial match).
                  examples:
                    - welcome
                sender:
                  type: string
                  description: Filter by sender email/name (partial match).
                  examples:
                    - noreply@yourdomain.com
                date_from:
                  type: string
                  format: date
                  pattern: ^\d{4}-\d{2}-\d{2}$
                  description: Inclusive lower bound (YYYY-MM-DD).
                  examples:
                    - '2026-04-01'
                date_to:
                  type: string
                  format: date
                  pattern: ^\d{4}-\d{2}-\d{2}$
                  description: Inclusive upper bound (YYYY-MM-DD).
                  examples:
                    - '2026-04-30'
                sort_field:
                  type: string
                  enum:
                    - inbox_percentage
                    - created_date
                    - campaign_id
                    - subject
                    - sent
                    - opens
                  description: Field to sort by.
                  examples:
                    - created_date
                sort_order:
                  type: string
                  enum:
                    - asc
                    - desc
                  description: Sort direction.
                  examples:
                    - desc
            examples:
              minimal-first-page:
                value:
                  page: 1
                  limit: 10
              sorted-by-inbox-placement:
                value:
                  page: 1
                  limit: 20
                  sort_field: inbox_percentage
                  sort_order: desc
              filter-subject-and-date-range:
                value:
                  page: 1
                  limit: 50
                  subject: welcome
                  sender: noreply@yourdomain.com
                  date_from: '2026-04-01'
                  date_to: '2026-04-30'
                  sort_field: created_date
                  sort_order: desc
              lookup-by-campaign-id:
                value:
                  page: 1
                  limit: 10
                  campaign_id: '750373463838949401'
      responses:
        '200':
          description: Campaign list retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    examples:
                      - true
                  message:
                    type: string
                    examples:
                      - requested campaign list
                  data:
                    type: array
                    description: List of campaigns matching the filter.
                    items:
                      type: object
                      properties:
                        campaign_id:
                          type: string
                          description: >-
                            MailerCloud campaign identifier (string-encoded big
                            integer).
                        subject:
                          type: string
                        sent:
                          type: string
                          description: Total sent count (string-encoded integer).
                        opens:
                          type: string
                          description: Total open count (string-encoded integer).
                        created_date:
                          type: string
                          description: >-
                            Creation timestamp in client's timezone (YYYY-MM-DD
                            HH:mm:ss).
                        inbox_percentage:
                          type: number
                          format: float
                          description: >-
                            Percentage of tracked seed deliveries that landed in
                            the inbox.
                          minimum: -3.402823669209385e+38
                          maximum: 3.402823669209385e+38
                        spam_percentage:
                          type: number
                          format: float
                          description: >-
                            Percentage of tracked seed deliveries that landed in
                            spam.
                          minimum: -3.402823669209385e+38
                          maximum: 3.402823669209385e+38
                        missed_percentage:
                          type: number
                          format: float
                          description: >-
                            Percentage of tracked seed deliveries that were
                            missed.
                          minimum: -3.402823669209385e+38
                          maximum: 3.402823669209385e+38
                        providers:
                          type: array
                          description: Per-mailbox-provider placement breakdown.
                          items:
                            type: object
                            properties:
                              provider:
                                type: string
                                description: >-
                                  Mailbox provider domain (e.g. gmail.com,
                                  yahoo.com).
                              inbox:
                                type: string
                                description: >-
                                  Inbox placement count (string-encoded
                                  integer).
                              spam:
                                type: string
                                description: Spam placement count (string-encoded integer).
                              missed:
                                type: string
                                description: >-
                                  Missed placement count (string-encoded
                                  integer).
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        examples:
                          - 1
                      per_page_count:
                        type: integer
                        examples:
                          - 10
                      total_count:
                        type: integer
                        examples:
                          - 137
              examples:
                sample-list:
                  value:
                    status: true
                    message: requested campaign list
                    data:
                      - campaign_id: '750373463838949401'
                        subject: Welcome to MailerCloud
                        sent: '10000'
                        opens: '4231'
                        created_date: '2026-04-15 09:30:00'
                        inbox_percentage: 92.5
                        spam_percentage: 5
                        missed_percentage: 2.5
                        providers:
                          - provider: gmail.com
                            inbox: '85'
                            spam: '10'
                            missed: '5'
                          - provider: yahoo.com
                            inbox: '95'
                            spam: '3'
                            missed: '2'
                          - provider: outlook.com
                            inbox: '90'
                            spam: '7'
                            missed: '3'
                    pagination:
                      current_page: 1
                      per_page_count: 10
                      total_count: 137
        '400':
          description: >-
            Validation Error (invalid field, bad date format, missing required
            fields)
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    examples:
                      - false
                  message:
                    type: string
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                        message:
                          type: string
              examples:
                invalid-date:
                  value:
                    status: false
                    message: requested campaign list
                    errors:
                      - field: date_from
                        message: Date must be in YYYY-MM-DD format
        '401':
          description: Authorization failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        field:
                          type: string
                        message:
                          type: string
              examples:
                auth-failed:
                  value:
                    errors:
                      - field: ''
                        message: Authorization failed
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    examples:
                      - false
                  message:
                    type: string
                  error:
                    type: string
                    description: Free-form error string.
      servers:
        - url: https://cloudapi.mailercloud.com
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Your Mailercloud API key (plain text, no Bearer prefix). Create keys in
        Settings → API.

````