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

> ## Agent Instructions
> To search or read these docs, connect the Ringg docs MCP server at https://docs.ringg.ai/mcp (no key needed; tools search_ringg_ai and query_docs_filesystem_ringg_ai) instead of browsing pages one by one. Setup for each client: https://docs.ringg.ai/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants.md
> The dashboard labels agents "Assistants"; these docs say "agent". Both mean the same object, identified by agent_id.
> API base URL: https://prod-api.ringg.ai/ca/api/v0. Send the workspace API key in the X-API-KEY header, from server-side code only.
> Placing a call dials a real phone number and spends credits. Confirm the number with the user before calling.
> To act on a Ringg workspace (place calls, edit agents, read transcripts), use the separate Ringg workspace MCP server at https://mcp.ringg.ai/mcp: https://docs.ringg.ai/resources/mcp-server/workspace-mcp-server/overview.md

> List your ongoing and completed campaigns with their ID, name and agent, to use as the bulk_list_id filter on the other analytics endpoints.

# Get Active Campaigns

export const RelatedTopics = ({items}) => <div className="not-prose mt-12">
    <div className="text-sm font-medium text-gray-500 dark:text-zinc-400 mb-3">Related topics</div>
    <div className="flex flex-col gap-2.5">
      {items.map(([title, href]) => <a key={href} href={href} className="flex items-center gap-2.5 text-sm text-gray-700 hover:text-gray-950 dark:text-zinc-300 dark:hover:text-white">
          <Icon icon="file-text" size={16} color="currentColor" />
          {title}
        </a>)}
    </div>
  </div>;

Pass `agent_id` to list only that agent's campaigns. Use each `id` as `bulk_list_id` on the other analytics endpoints.

## Errors

* `401`: `X-API-KEY` is missing or invalid.

<RelatedTopics items={[["Analytics", "/documentation/monitor/analytics"], ["Manage a campaign", "/documentation/deploy/campaigns/manage-a-campaign"]]} />


## OpenAPI

````yaml get /analytics/v4/campaigns
openapi: 3.0.0
info:
  title: Ringg AI API Documentation
  description: >-
    The Ringg AI REST API. Base URL https://prod-api.ringg.ai/ca/api/v0; send
    your workspace API key in the X-API-KEY header from server-side code only.
    Requests and responses are JSON.
  version: 2.0.0
  contact:
    name: Ringg AI support
    email: admin@ringg.ai
    url: https://docs.ringg.ai
servers:
  - url: https://prod-api.ringg.ai/ca/api/v0
security:
  - ApiKeyAuth: []
tags:
  - name: workspace
    description: Endpoints for managing your workspace.
  - name: agent
    description: Endpoints for managing agents.
  - name: calling
    description: Endpoints for making and managing calls.
  - name: campaign
    description: Endpoints for managing campaigns.
  - name: analytics
    description: >-
      Analytics v4 endpoints for call, agent, cohort and chat performance
      metrics.
  - name: termination
    description: Endpoints for terminating active calls using different methods.
  - name: knowledgebase
    description: Endpoints for managing knowledge bases.
paths:
  /analytics/v4/campaigns:
    get:
      tags:
        - analytics
      summary: Get Active Campaigns
      description: >-
        Lists ongoing and completed campaigns, for use as `bulk_list_id` filter
        options.
      operationId: getActiveCampaigns
      parameters:
        - name: agent_id
          in: query
          description: Only return this agent's campaigns.
          required: false
          schema:
            type: string
            example: 00000000-0000-4000-8000-0000000000a1
      responses:
        '200':
          description: Campaigns retrieved successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  campaigns:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Campaign (bulk list) ID.
                        name:
                          type: string
                          description: Campaign name.
                        agent_id:
                          type: string
                          description: Agent running the campaign.
                          nullable: true
              example:
                campaigns:
                  - id: 00000000-0000-4000-8000-0000000000c1
                    name: EMI reminders - October
                    agent_id: 00000000-0000-4000-8000-0000000000a1
        '400':
          description: >-
            Bad Request - invalid filter value (for example an unknown `channel`
            or malformed ID).
          content:
            application/json:
              example:
                message: 'invalid channel(s): sms'
        '401':
          description: Unauthorized - Invalid or missing authentication.
        '500':
          description: Internal Server Error.
          content:
            application/json:
              example:
                message: Failed to fetch campaigns!
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-KEY

````

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