GET
https://spideriq.di-atomic.com
/
api
/
v1
/
jobs
/
spiderMaps
/
campaigns
/
{campaign_id}
/
status
Get Campaign Status
curl --request GET \
  --url https://spideriq.di-atomic.com/api/v1/jobs/spiderMaps/campaigns/{campaign_id}/status \
  --header 'Authorization: Bearer <token>'
{
  "campaign_id": "<string>",
  "status": "<string>",
  "query": "<string>",
  "country_code": "<string>",
  "filter_config": {},
  "progress": {
    "total": 123,
    "pending": 123,
    "submitted": 123,
    "completed": 123,
    "failed": 123,
    "percentage": 123
  },
  "jobs": {
    "queued": 123,
    "processing": 123,
    "completed": 123,
    "failed": 123
  },
  "results_count": 123,
  "has_workflow": true,
  "workflow_config": {},
  "workflow_progress": {
    "businesses_total": 123,
    "sites_queued": 123,
    "sites_completed": 123,
    "sites_failed": 123,
    "verifies_queued": 123,
    "verifies_completed": 123,
    "verifies_failed": 123,
    "emails_found": 123,
    "emails_verified": 123
  },
  "created_at": "<string>",
  "updated_at": "<string>"
}

​
Overview

Retrieve comprehensive status information for a campaign, including progress statistics, job counts by status, and configuration details.
v2.15.0: For orchestrated campaigns, this endpoint includes workflow_progress showing SpiderSite and SpiderVerify job statistics.

​
Path Parameters

​
campaign_id
string
required
The campaign ID

​
Response

​
campaign_id
string
The campaign identifier
​
status
string
Campaign status: active, paused, completed, stopped
​
query
string
The search query used
​
country_code
string
The country code
​
filter_config
object
The filter configuration used to select locations
​
progress
object
Location progress statistics
​
jobs
object
Job status counts
​
results_count
integer
Total businesses found across all completed jobs
​
has_workflow
boolean
v2.15.0: Whether workflow orchestration is enabled
​
workflow_config
object
v2.15.0: Workflow configuration (only present if has_workflow is true)
​
workflow_progress
object
v2.15.0: Workflow chain progress statistics (only present if has_workflow is true)
​
created_at
string
Campaign creation timestamp
​
updated_at
string
Last update timestamp

​
Example

curl https://spideriq.di-atomic.com/api/v1/jobs/spiderMaps/campaigns/camp_lu_restaurants_abc123/status \
  -H "Authorization: Bearer <your_token>"
Response: 
{
  "campaign_id": "camp_lu_restaurants_abc123",
  "status": "active",
  "query": "restaurants",
  "country_code": "LU",
  "filter_config": {
    "mode": "all"
  },
  "progress": {
    "total": 12,
    "pending": 4,
    "submitted": 3,
    "completed": 5,
    "failed": 0,
    "percentage": 41.67
  },
  "jobs": {
    "queued": 2,
    "processing": 1,
    "completed": 5,
    "failed": 0
  },
  "results_count": 523,
  "created_at": "2025-12-22T17:13:02Z",
  "updated_at": "2025-12-22T17:25:18Z"
}

​
Orchestrated Campaign Response (v2.15.0)

For campaigns with workflow orchestration enabled: 
{
  "campaign_id": "camp_fr_restaurants_20251223_a1b2c3d4",
  "status": "active",
  "query": "restaurants",
  "country_code": "FR",
  "filter_config": {
    "mode": "population",
    "min_population": 100000
  },
  "progress": {
    "total": 42,
    "pending": 10,
    "submitted": 5,
    "completed": 27,
    "failed": 0,
    "percentage": 64.29
  },
  "jobs": {
    "queued": 3,
    "processing": 2,
    "completed": 27,
    "failed": 0
  },
  "results_count": 540,
  "has_workflow": true,
  "workflow_config": {
    "spidersite": {
      "enabled": true,
      "max_pages": 10
    },
    "spiderverify": {
      "enabled": true,
      "max_emails_per_business": 5
    }
  },
  "workflow_progress": {
    "businesses_total": 320,
    "sites_queued": 15,
    "sites_completed": 280,
    "sites_failed": 5,
    "verifies_queued": 20,
    "verifies_completed": 240,
    "verifies_failed": 2,
    "emails_found": 680,
    "emails_verified": 580
  },
  "created_at": "2025-12-23T10:30:00Z",
  "updated_at": "2025-12-23T12:15:00Z"
}
Use the /workflow-results endpoint to get aggregated data from all three services once the campaign is complete.

​
Status Values

StatusDescription
activeCampaign is running, /next will submit jobs
pausedTemporarily paused (use /continue to resume)
stoppedManually stopped (use /continue to resume)
completedAll locations processed

Stop Campaign

Pause a running campaign

Continue Campaign

Resume a stopped campaign

Workflow Results

Get aggregated workflow results

Orchestration Guide

Complete orchestration guide