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

# Get Monitor Placement Summary

> The **monitor_get_summary** API returns the inbox and spam rate overall and per provider. **inbox_rate** counts Gmail tabs (Promotions, Updates, ...) as inbox, like the dashboard. Rates are null when there is no mail.
#### Header:
**X-CC-API-Key**: Your API Key
#### Parameters (all optional):
- **days**: 1 to 365, default 30 (older days come from daily totals).
- **domain_id**: Only this monitored domain.
#### Response:
- **overall** and each entry in **providers**: **total**, **inbox**, **tabs**, **spam**, **other**, **inbox_rate**, **spam_rate** (providers also have **provider** and **provider_key**).



## OpenAPI

````yaml GET /v1/monitor_get_summary
openapi: 3.0.0
info:
  title: API DOCUMENTATION
  description: >-


    [Campaign Cleaner](https://campaigncleaner.com) is the leader in ensuring
    that your campaigns don't affect your IP and Domain reputation, it's the
    most advanced toolset you'll find that gives you all the tools you need to
    keep your campaigns within acceptable ratios of many email and spam
    filtering software and automatically fixes your HTML by sanitizing all
    non-email friendly attributes and inlines all your CSS to be compatible with
    every email client.


    We offer a robust collection of API's to allow you to integrate its
    functionality into your email marketing software and tools.


    The **{{api_key}}** is located in your account on [Campaign
    Cleaner](https://campaigncleaner.com) under **API Management API Keys.**


    The **Inbox Placement Monitor** endpoints (monitor_*) let you get the seed
    addresses, manage the domains you send from, read where every copy of your
    real campaigns landed, and manage placement alerts. They are included with
    The Works and the Inbox Placement Tester plan and don't use API credits.


    Use the navigation on the left to access the different API Endpoints.
  version: 1.0.0
servers:
  - url: https://api.campaigncleaner.com
security: []
tags:
  - name: Campaign Cleaner
    description: Campaign analysis, cleaning, credits and inbox placement tests.
  - name: Inbox Placement Monitor
    description: >-
      Track where your real campaigns land. Add the seed addresses to your
      normal sends, verify the domains you send from, then read placement per
      message or per provider and manage alerts. No API credits are used.
      Limits: 60 calls a minute per account and 120 a minute per client IP.
paths:
  /v1/monitor_get_summary:
    get:
      tags:
        - Inbox Placement Monitor
      summary: Get Monitor Placement Summary
      description: >-
        The **monitor_get_summary** API returns the inbox and spam rate overall
        and per provider. **inbox_rate** counts Gmail tabs (Promotions, Updates,
        ...) as inbox, like the dashboard. Rates are null when there is no mail.

        #### Header:

        **X-CC-API-Key**: Your API Key

        #### Parameters (all optional):

        - **days**: 1 to 365, default 30 (older days come from daily totals).

        - **domain_id**: Only this monitored domain.

        #### Response:

        - **overall** and each entry in **providers**: **total**, **inbox**,
        **tabs**, **spam**, **other**, **inbox_rate**, **spam_rate** (providers
        also have **provider** and **provider_key**).
      parameters:
        - name: X-CC-API-Key
          in: header
          schema:
            type: string
          example: '{{api_key}}'
        - name: days
          in: query
          schema:
            type: integer
          example: 30
        - name: domain_id
          in: query
          schema:
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                days: 30
                domain_id: null
                overall:
                  total: 21
                  inbox: 12
                  tabs: 0
                  spam: 9
                  other: 0
                  inbox_rate: 57.1
                  spam_rate: 42.9
                providers:
                  - provider: Outlook.com / Hotmail
                    provider_key: outlook.com
                    total: 12
                    inbox: 7
                    tabs: 0
                    spam: 5
                    other: 0
                    inbox_rate: 58.3
                    spam_rate: 41.7
                note: >-
                  inbox_rate counts Gmail tabs (Promotions, Updates ...) as
                  inbox, like the dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.