List Campaigns

GET/api/v1/jobs/spiderMaps/campaigns

Overview

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

Query Parameters

statusstring

Filter by campaign status: active, paused, completed, stopped

country_codestring

Filter by ISO 2-letter country code

pageintegerdefault: 1

Page number for pagination

page_sizeintegerdefault: 20

Items per page (1-100)

Response

campaignsarray

Array of campaign summaries

Campaign Properties

campaign_idstring

Campaign identifier

statusstring

Current status

querystring

Search query

country_codestring

Country code

total_locationsinteger

Total locations

completed_locationsinteger

Completed count

created_atstring

Creation timestamp

totalinteger

Total number of campaigns matching filters

pageinteger

Current page number

page_sizeinteger

Items per page

total_pagesinteger

Total number of pages

Examples

List All Campaigns

cURL

curl https://spideriq.ai/api/v1/jobs/spiderMaps/campaigns \
  -H "Authorization: Bearer <your_token>"

Python

import requests

response = requests.get(
    "https://spideriq.ai/api/v1/jobs/spiderMaps/campaigns",
    headers={"Authorization": "Bearer <your_token>"}
)
result = response.json()

print(f"Total campaigns: {result['total']}")
for camp in result['campaigns']:
    print(f"  {camp['campaign_id']}: {camp['status']} ({camp['completed_locations']}/{camp['total_locations']})")

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.ai/api/v1/jobs/spiderMaps/campaigns?status=active" \
  -H "Authorization: Bearer <your_token>"

Filter by Country

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