Skip to main content
GET
/
v1
/
campaigns
/
{id}
/
status
Get campaign status
curl --request GET \
  --url https://api.osvi.ai/v1/campaigns/{id}/status \
  --header 'API-Token: <api-key>'
{
  "success": true,
  "data": {
    "campaign": {
      "id": 7,
      "name": "June Renewals",
      "status": "active",
      "is_retry_enabled": true,
      "retry_threshold": 2,
      "retry_delay": 1800,
      "created_at": "2026-06-01T10:00:00+05:30"
    },
    "calls": {
      "total": 120,
      "by_status": {
        "picked": 88,
        "not_picked": 25,
        "failed": 7
      }
    },
    "uploads": [
      {
        "campaign_upload_id": 19,
        "file_name": "1718000000-api_contacts_ab12cd34ef567890.csv",
        "agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
        "created_at": "2026-06-02T11:00:00+05:30",
        "queues": [
          {
            "agent_uuid": "agent_IsZ3Q6Sf_60Eh26XQMGbz-R_og",
            "total_queued": 50,
            "completed": false
          }
        ]
      }
    ]
  }
}

Authorizations

API-Token
string
header
required

16-character API token associated with your OSVI account. Find it in your dashboard under Settings → API.

Path Parameters

id
integer
required

The campaign's numeric id.

Response

Campaign progress snapshot.

success
boolean
Example:

true

data
object