---
updatedAt: 2026-06-25T13:42:49.000Z
agentTools:
  projectIndex: https://marketing.developer.dotdigital.com/llms.txt
---

# Retrieves inbound SMS analytics

<span class="callRateUnlimited"></span>

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Analytics API",
    "description": "Provides methods for retrieving analytics data across the Dotdigital\nomnichannel platform. Covers conversation message analytics, chat analytics\n(including live), message metrics, session analytics, SMS tracking,\nverification, inbound/outbound SMS analytics, and WhatsApp conversation and\ndaily messaging usage reports. All endpoints accept date-range and\naggregation parameters and return time-series data suitable for reporting\ndashboards.",
    "version": "1.1.1"
  },
  "servers": [
    {
      "url": "https://{region}-api.dotdigital.com",
      "variables": {
        "region": {
          "description": "The Dotdigital region id your account belongs to",
          "enum": [
            "r1",
            "r2",
            "r3"
          ],
          "default": "r1"
        }
      }
    }
  ],
  "security": [
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/cpaas/analytics/sms/inbound": {
      "get": {
        "tags": [
          "SMS"
        ],
        "summary": "Retrieves inbound SMS analytics",
        "parameters": [
          {
            "name": "from",
            "in": "query",
            "description": "The date time to query from in ISO 8601 format UTC",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "to",
            "in": "query",
            "description": "The date time to query up to (but not including) in ISO 8601 format UTC",
            "required": true,
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "by",
            "in": "query",
            "description": "The time period to aggregate by",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "hour",
                "day",
                "month",
                "year"
              ]
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The count of received messages for a specific period",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/smsInboundAnalytics"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Validation errors were found"
          },
          "404": {
            "description": "The API Space was not"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "smsInboundAnalytics": {
        "type": "object",
        "properties": {
          "date": {
            "type": "string",
            "description": "The start date and time for the period"
          },
          "received": {
            "type": "integer",
            "description": "The number of messages received in the period",
            "format": "int64"
          }
        }
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "x-readme": {
    "samples-languages": [
      "curl",
      "csharp",
      "java",
      "node",
      "php",
      "python",
      "ruby"
    ],
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```

# Sibling pages

* [Retrieves url tracking analytics](https://marketing.developer.dotdigital.com/reference/get_cpaas-analytics-sms-tracking.md)
* [Retrieves sms verify analytics](https://marketing.developer.dotdigital.com/reference/get_cpaas-analytics-sms-verify.md)
* [Retrieves outbound SMS analytics](https://marketing.developer.dotdigital.com/reference/get_cpaas-analytics-sms-outbound.md)