Dashboard Flows — SpiderIQ

GET/api/v1/dashboard/flows

List Flows

Parameters

Name	In	Type	Required	Description
`category`	query	any	false
`search`	query	any	false

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/dashboard/flows' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/dashboard/flows",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/dashboard/flows", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);

Go

package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/dashboard/flows", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

GET/api/v1/dashboard/flows/{slug}

Get Flow

Parameters

Name	In	Type	Required	Description
`slug`	path	string	true

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/dashboard/flows/{slug}' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/dashboard/flows/{slug}",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/dashboard/flows/{slug}", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);

Go

package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/dashboard/flows/{slug}", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

GET/api/v1/dashboard/flows/{slug}/analytics

Get Flow Analytics

Per-flow + per-client analytics: KPIs, time series, status breakdown, top scenarios, recent failures.

Two paths:

Single-service flows (siteScraper, mapsSearch, emailVerify, …) — aggregate from public.jobs filtered by type = flow.dispatch_type. One job row per run.

Pipeline flows (localSeo / leadSearch / companyIntel / linkedinExtract) — aggregate from public.scraping_campaigns. The campaign row is the unit of work; sub-jobs (one per location × stage) link back via campaign_locations. Pre-wave3-sweep campaigns lack the _flow_dispatch_type tag so a workflow_config heuristic backfills the membership (see _PIPELINE_LEGACY_HEURISTIC).

Cost (§C8) is not yet wired; kpis.total_cost_cents is always None today.

Parameters

Name	In	Type	Required	Description
`slug`	path	string	true
`range`	query	string	false

Try it

Examples

cURL

curl -X GET 'https://spideriq.ai/api/v1/dashboard/flows/{slug}/analytics' \
  -H 'Authorization: Bearer <token>'

Python

import httpx

resp = httpx.get(
    "https://spideriq.ai/api/v1/dashboard/flows/{slug}/analytics",
    headers={"Authorization": "Bearer <token>"},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/dashboard/flows/{slug}/analytics", {
  method: "GET",
  headers: { "Authorization": "Bearer <token>" }
});
const data = await resp.json();
console.log(data);

Go

package main

import (
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://spideriq.ai/api/v1/dashboard/flows/{slug}/analytics", nil)
	req.Header.Set("Authorization", "Bearer <token>")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`200`	Successful Response
`422`	Validation Error

POST/api/v1/dashboard/flows/{slug}/run

Run Flow

Dispatch a flow run from the dashboard. Same behavior as the public /api/v1/flows/{slug}/run endpoint — see api/v1/flows.py for the body contract and mode rules.

Parameters

Name	In	Type	Required	Description
`slug`	path	string	true

Try it

Examples

cURL

curl -X POST 'https://spideriq.ai/api/v1/dashboard/flows/{slug}/run' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "input": {},
  "inputs": [
    {}
  ],
  "scope": {},
  "priority": 0
}'

Python

import httpx

resp = httpx.post(
    "https://spideriq.ai/api/v1/dashboard/flows/{slug}/run",
    headers={"Authorization": "Bearer <token>", "Content-Type": "application/json"},
    json={"input": {}, "inputs": [{}], "scope": {}, "priority": 0},
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://spideriq.ai/api/v1/dashboard/flows/{slug}/run", {
  method: "POST",
  headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" },
  body: JSON.stringify({"input": {}, "inputs": [{}], "scope": {}, "priority": 0})
});
const data = await resp.json();
console.log(data);

Go

package main

import (
	"net/http"
	"strings"
)

func main() {
	body := strings.NewReader(`{"input": {}, "inputs": [{}], "scope": {}, "priority": 0}`)
	req, _ := http.NewRequest("POST", "https://spideriq.ai/api/v1/dashboard/flows/{slug}/run", body)
	req.Header.Set("Authorization", "Bearer <token>")
	req.Header.Set("Content-Type", "application/json")
	resp, _ := http.DefaultClient.Do(req)
	defer resp.Body.Close()
}

Responses

Status	Description
`201`	Successful Response
`422`	Validation Error