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

# Get campaign CTR metrics

> **Get click-through-rate (CTR) metrics for a campaign**

Returns CTR metrics including verified and raw click counts, unique clicking
leads, and a per sequence-step breakdown.

Click tracking must be enabled on the campaign for meaningful data.

## Example

```python
import requests

response = requests.get(
    "https://api.coldsend.io/api/public/v1/analytics/campaigns/550e8400-e29b-41d4-a716-446655440000/ctr",
    headers={"X-API-Key": "your-api-key"},
    params={"verified": True}
)
print(response.json())
```



## OpenAPI

````yaml /public_openapi.json get /api/public/v1/analytics/campaigns/{campaign_id}/ctr
openapi: 3.0.3
info:
  title: ColdSend Public API
  description: >-
    Programmatic access to ColdSend for managing cold email campaigns and sender
    accounts.
  version: 1.0.0
  contact:
    name: ColdSend Support
    email: support@coldsend.pro
    url: https://coldsend.pro
servers:
  - url: https://api.coldsend.pro
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/public/v1/analytics/campaigns/{campaign_id}/ctr:
    get:
      tags:
        - Analytics
      summary: Get campaign CTR metrics
      description: >-
        **Get click-through-rate (CTR) metrics for a campaign**


        Returns CTR metrics including verified and raw click counts, unique
        clicking

        leads, and a per sequence-step breakdown.


        Click tracking must be enabled on the campaign for meaningful data.


        ## Example


        ```python

        import requests


        response = requests.get(
            "https://api.coldsend.io/api/public/v1/analytics/campaigns/550e8400-e29b-41d4-a716-446655440000/ctr",
            headers={"X-API-Key": "your-api-key"},
            params={"verified": True}
        )

        print(response.json())

        ```
      operationId: get_campaign_ctr_api_public_v1_analytics_campaigns__campaign_id__ctr_get
      parameters:
        - name: campaign_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Campaign Id
        - name: verified
          in: query
          required: false
          schema:
            type: boolean
            description: >-
              If true, use verified (non-bot) click counts; otherwise include
              raw clicks.
            default: true
            title: Verified
          description: >-
            If true, use verified (non-bot) click counts; otherwise include raw
            clicks.
      responses:
        '200':
          description: CTR metrics retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CTRResponse'
        '401':
          description: Missing or invalid API key
        '403':
          description: Insufficient permissions - requires 'campaigns:read' scope
        '404':
          description: Campaign not found
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CTRResponse:
      properties:
        campaign_id:
          type: string
          title: Campaign Id
          description: Campaign ID
        sent_count:
          type: integer
          title: Sent Count
          description: Total emails sent (denominator)
        unique_verified_clicking_leads:
          type: integer
          title: Unique Verified Clicking Leads
          description: Distinct leads with verified clicks
        unique_raw_clicking_leads:
          type: integer
          title: Unique Raw Clicking Leads
          description: Distinct leads with any clicks
        total_verified_clicks:
          type: integer
          title: Total Verified Clicks
          description: Total verified (non-bot) clicks
        total_raw_clicks:
          type: integer
          title: Total Raw Clicks
          description: Total raw clicks including bot traffic
        verified_ctr:
          type: number
          title: Verified Ctr
          description: Verified CTR percentage
        raw_ctr:
          type: number
          title: Raw Ctr
          description: Raw CTR percentage
        by_step:
          items:
            additionalProperties: true
            type: object
          type: array
          title: By Step
          description: Per sequence-step breakdown
      type: object
      required:
        - campaign_id
        - sent_count
        - unique_verified_clicking_leads
        - unique_raw_clicking_leads
        - total_verified_clicks
        - total_raw_clicks
        - verified_ctr
        - raw_ctr
      title: CTRResponse
      description: CTR metrics for a campaign.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key with format cs_live_xxx

````