Skip to content
UltimateTeam.ai Docs

Get Campaign Progress

GET
/api/v1/gtm/campaigns/{campaign_id}/progress
curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/gtm/campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/progress \
  --header 'X-API-Key: <X-API-Key>'

Separate preparation, provider acceptance, delivery and commercial outcomes.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
campaign_id
required
Campaign Id
string format: uuid

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
CampaignProgress
object
awaiting_approval
required
Awaiting Approval
integer
blocked_contacts
required
Blocked Contacts
integer
campaign_id
required
Campaign Id
string format: uuid
delivered
required
Delivered
integer
errors
Errors
Array<string>
failed_tasks
required
Failed Tasks
integer
invites_redeemed
required
Invites Redeemed
integer
opted_out_contacts
required
Opted Out Contacts
integer
pending_tasks
required
Pending Tasks
integer
prospects_found
required
Prospects Found
integer
provider_accepted
required
Provider Accepted
integer
replied_contacts
required
Replied Contacts
integer
status
required
Status
string
Examplegenerated
{
  "awaiting_approval": 1,
  "blocked_contacts": 1,
  "campaign_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "delivered": 1,
  "errors": [
    "example"
  ],
  "failed_tasks": 1,
  "invites_redeemed": 1,
  "opted_out_contacts": 1,
  "pending_tasks": 1,
  "prospects_found": 1,
  "provider_accepted": 1,
  "replied_contacts": 1,
  "status": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}