GET
https://spideriq.di-atomic.com
/
api
/
v1
/
jobs
/
spiderMaps
/
campaigns
List Campaigns
curl --request GET \
  --url https://spideriq.di-atomic.com/api/v1/jobs/spiderMaps/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "campaigns": [
    {
      "campaign_id": "<string>",
      "status": "<string>",
      "query": "<string>",
      "country_code": "<string>",
      "total_locations": 123,
      "completed_locations": 123,
      "created_at": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

​
Overview

Retrieve a list of all campaigns created by the authenticated client, with optional filtering by status or country.

​
Query Parameters

​
status
string
Filter by campaign status: active, paused, completed, stopped
​
country_code
string
Filter by ISO 2-letter country code
​
page
integer
default:"1"
Page number for pagination
​
page_size
integer
default:"20"
Items per page (1-100)

​
Response

​
campaigns
array
Array of campaign summaries
​
total
integer
Total number of campaigns matching filters
​
page
integer
Current page number
​
page_size
integer
Items per page
​
total_pages
integer
Total number of pages

​
Examples

​
List All Campaigns

curl https://spideriq.di-atomic.com/api/v1/jobs/spiderMaps/campaigns \
  -H "Authorization: Bearer <your_token>"
Response: 
{
  "campaigns": [
    {
      "campaign_id": "camp_lu_restaurants_abc123",
      "status": "completed",
      "query": "restaurants",
      "country_code": "LU",
      "total_locations": 12,
      "completed_locations": 12,
      "created_at": "2025-12-22T17:13:02Z"
    },
    {
      "campaign_id": "camp_de_hotels_def456",
      "status": "active",
      "query": "hotels",
      "country_code": "DE",
      "total_locations": 14,
      "completed_locations": 5,
      "created_at": "2025-12-22T17:15:18Z"
    }
  ],
  "total": 2,
  "page": 1,
  "page_size": 20,
  "total_pages": 1
}

​
Filter by Status

curl "https://spideriq.di-atomic.com/api/v1/jobs/spiderMaps/campaigns?status=active" \
  -H "Authorization: Bearer <your_token>"

​
Filter by Country

curl "https://spideriq.di-atomic.com/api/v1/jobs/spiderMaps/campaigns?country_code=FR" \
  -H "Authorization: Bearer <your_token>"