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

# Provider-wise Report

> Get deliverability report by email provider (Gmail, Outlook, Yahoo)

<Note>
  **Smart Delivery API**: This is part of SmartLead's deliverability testing suite. Contact [support@smartlead.ai](mailto:support@smartlead.ai) for access and API details.
</Note>

## Query Parameters

<ParamField query="api_key" type="string" required>
  Your SmartLead API key
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST "https://smartdelivery.smartlead.ai/api/v1/spam-test/report/{spamTestId}/providerwise?api_key=YOUR_KEY" \
    -H "Content-Type: application/json" \
    -d '{}'
  ```

  ```python Python theme={null}
  import requests

  API_KEY = "YOUR_API_KEY"

  response = requests.post(
      "https://smartdelivery.smartlead.ai/api/v1/spam-test/report/{spamTestId}/providerwise",
      params={"api_key": API_KEY},
      json={}
  )

  result = response.json()
  print(result)
  ```

  ```javascript JavaScript theme={null}
  const API_KEY = 'YOUR_API_KEY';

  const response = await fetch(
    `https://smartdelivery.smartlead.ai/api/v1/spam-test/report/{spamTestId}/providerwise?api_key=${API_KEY}`,
    {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({})
    }
  );

  const result = await response.json();
  console.log(result);
  ```
</RequestExample>

## Response Codes

<ResponseField name="200" type="Success">
  Request successful
</ResponseField>

<ResponseField name="400" type="Bad Request">
  Invalid request parameters or malformed request body
</ResponseField>

<ResponseField name="401" type="Unauthorized">
  Invalid or missing API key. Check your authentication.
</ResponseField>

<ResponseField name="404" type="Not Found">
  The requested resource (campaign, lead, email account, etc.) does not exist or you don't have access to it
</ResponseField>

<ResponseField name="422" type="Validation Error">
  Request validation failed. Check parameter types, required fields, and value constraints.
</ResponseField>

<ResponseField name="429" type="Rate Limit Exceeded">
  Too many requests. Please slow down and retry after the rate limit resets.
</ResponseField>

<ResponseField name="500" type="Internal Server Error">
  Server error occurred. Please try again or contact support if the issue persists.
</ResponseField>

<ResponseField name="503" type="Service Unavailable">
  API is temporarily unavailable or under maintenance. Please try again later.
</ResponseField>

<ResponseExample>
  ```json 200 - Success theme={null}
  {
    "overallTotalCount": 900,
    "status": "completed",
    "result": [
      {
        "provider": "Gmail",
        "inbox_rate": 94.2,
        "spam_rate": 3.8,
        "bounce_rate": 2.0,
        "mailbox_count": 350,
        "avg_delivery_time_seconds": 45
      },
      {
        "provider": "Outlook",
        "inbox_rate": 88.5,
        "spam_rate": 8.2,
        "bounce_rate": 3.3,
        "mailbox_count": 310,
        "avg_delivery_time_seconds": 52
      },
      {
        "provider": "Yahoo",
        "inbox_rate": 89.1,
        "spam_rate": 7.5,
        "bounce_rate": 3.4,
        "mailbox_count": 240,
        "avg_delivery_time_seconds": 48
      }
    ]
  }
  ```

  ```json 401 - Unauthorized theme={null}
  {
    "message": "Invalid API Key"
  }
  ```

  ```json 404 - Not Found theme={null}
  {
    "error": "Resource not found"
  }
  ```

  ```json 422 - Validation Error theme={null}
  {
    "error": "Invalid parameters provided"
  }
  ```
</ResponseExample>
