Get Campaign Progress
Get the current progress of a campaign
Get the current progress of a campaign
Returns a real-time snapshot of how many contacts have been processed.
| Field | Description |
|---|---|
total | Total number of contacts in the campaign |
processed | Contacts that have been attempted at least once |
completed | Contacts with a successful call outcome |
failed | Contacts that exhausted all retry attempts without success |
pending | Contacts not yet attempted |
completion_percentage | processed / total × 100 |
Quick reference#
Get the current progress of a campaign. Send the request to GET /api/v1/campaign/{campaignid}/progress on the Paladin API base URL.
| Method | GET |
|---|---|
| Path | /api/v1/campaign/{campaignid}/progress |
| Path parameters | campaignid |
| Authentication | Use the authentication method shown in the OpenAPI block and the Authentication docs. Keep API keys server-side. |
Before you call#
- Confirm you are using the production base URL shown in the API reference.
- Make sure any path IDs belong to the same Paladin organization as the credential you are using.
- Validate request bodies and required fields before sending production traffic.
Common error checks#
- Use 401 or 403 responses to check credentials, organization scope, and permissions.
- Use 404 responses to check whether the referenced resource exists in the current organization.
- Use 422 responses to inspect missing or invalid request fields.
OpenAPI#
GET /api/v1/campaign/{campaignid}/progress
openapi: 3.1.0
info:
title: Paladin API
description: API for the Paladin app
version: 1.0.0
servers:
- url: https://app.paladin.northmanngrp.com
description: Production
security: []
paths:
/api/v1/campaign/{campaign_id}/progress:
get:
tags:
- main
summary: Get Campaign Progress
description: Get current campaign progress and statistics
operationId: get_campaign_progress_api_v1_campaign__campaign_id__progress_get
parameters:
- name: campaign_id
in: path
required: true
schema:
type: integer
title: Campaign Id
- name: authorization
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Authorization
- name: X-API-Key
in: header
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: X-Api-Key
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignProgressResponse'
'404':
description: Not found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
CampaignProgressResponse:
properties:
campaign_id:
type: integer
title: Campaign Id
state:
type: string
title: State
total_rows:
type: integer
title: Total Rows
processed_rows:
type: integer
title: Processed Rows
failed_calls:
type: integer
title: Failed Calls
progress_percentage:
type: number
title: Progress Percentage
source_sync:
additionalProperties: true
type: object
title: Source Sync
rate_limit:
type: integer
title: Rate Limit
started_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Started At
completed_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Completed At
type: object
required:
- campaign_id
- state
- total_rows
- processed_rows
- failed_calls
- progress_percentage
- source_sync
- rate_limit
- started_at
- completed_at
title: CampaignProgressResponse
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
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError