Get Extractor Campaign Status

curl -X GET "https://api.sendpilot.ai/v1/lead-extractor/campaigns/camp_abc123xyz/status" \
  -H "X-API-Key: your-api-key"

{
  "id": "camp_abc123xyz",
  "name": "Tech Startup Founders",
  "status": "RUNNING",
  "progress": {
    "extracted": 75,
    "enriched": 70,
    "requested": 100,
    "percent_complete": 75
  },
  "created_at": "2024-02-24T10:30:00.000Z"
}

GET

lead-extractor

campaigns

{id}

status

curl -X GET "https://api.sendpilot.ai/v1/lead-extractor/campaigns/camp_abc123xyz/status" \
  -H "X-API-Key: your-api-key"

{
  "id": "camp_abc123xyz",
  "name": "Tech Startup Founders",
  "status": "RUNNING",
  "progress": {
    "extracted": 75,
    "enriched": 70,
    "requested": 100,
    "percent_complete": 75
  },
  "created_at": "2024-02-24T10:30:00.000Z"
}

Returns the current status and progress of a lead extraction campaign.

Request

string

required

Your API key

Path Parameters

string

required

The campaign ID returned from the create campaign endpoint

Response

string

Unique identifier for the campaign

string

Name of the campaign

string

Current status: PENDING, RUNNING, FINISHED, FAILED

object

Show properties

number

Number of leads extracted so far

number

Number of leads enriched (if enrichment enabled)

number

Number of leads requested (your limit)

number

Percentage complete (0-100)

string

ISO 8601 timestamp when the campaign was created

curl -X GET "https://api.sendpilot.ai/v1/lead-extractor/campaigns/camp_abc123xyz/status" \
  -H "X-API-Key: your-api-key"

{
  "id": "camp_abc123xyz",
  "name": "Tech Startup Founders",
  "status": "RUNNING",
  "progress": {
    "extracted": 75,
    "enriched": 70,
    "requested": 100,
    "percent_complete": 75
  },
  "created_at": "2024-02-24T10:30:00.000Z"
}

Authorizations

X-API-Key

string

header

required

API key for authentication

Path Parameters

string

required

The campaign ID returned from the create campaign endpoint

Response

Campaign status and progress

string

required

status

enum<string>

required

Available options:

PENDING,

RUNNING,

FINISHED,

FAILED

name

string

progress

object

Show child attributes

created_at

string<date-time>

Getting Started

Credits

Campaigns

Leads

Inbox

Lead Database

Lead Extractor

Webhooks

Webhook Events

Use Cases

Get Extractor Campaign Status

Request

Path Parameters

Response

Authorizations

Path Parameters

Response

​Request

​Path Parameters

​Response

Authorizations

Path Parameters

Response

Request

Path Parameters

Response