Skip to content

Activity

Returns compact recent account activity across saved tests and infrastructure runs.

The Activity endpoint is for operational timelines: what ran, where it came from, what status it reached, and where to read details. It is not a full analysis result endpoint.

GET /v1/activity
HeaderRequiredValue
AuthorizationYesBearer sw_api_live_...

Required scope:

runs:read
ParameterTypeRequiredDescription
limitintegerNoNumber of activity items. Clamped between 1 and 100. Defaults to 20.
kindstringNoOne of all, saved_test_run, visibility_run, or content_run. Defaults to all.
Terminal window
curl -s "https://api.sleepwalker.ai/v1/activity?limit=10&kind=all" \
-H "Authorization: Bearer sw_api_live_..."

The same request in Python and JavaScript:

Python
import requests
resp = requests.get(
"https://api.sleepwalker.ai/v1/activity",
headers={"Authorization": "Bearer sw_api_live_..."},
params={"limit": 10, "kind": "all"},
)
resp.raise_for_status()
print(resp.json())
JavaScript
const resp = await fetch("https://api.sleepwalker.ai/v1/activity?limit=10&kind=all", {
headers: { Authorization: "Bearer sw_api_live_..." },
});
const data = await resp.json();
console.log(data);
{
"items": [
{
"activity_id": "visibility_run:6a75b22b-...",
"kind": "visibility_run",
"run_id": "6a75b22b-...",
"status": "completed",
"source": "api",
"created_at": "2026-06-10T12:30:00Z",
"completed_at": "2026-06-10T12:31:10Z",
"url": "https://www.sleepwalker.ai",
"test_id": null,
"test_name": null,
"test_type": "ai_citations",
"test_type_label": "AI Visibility",
"brand_name": "Sleepwalker",
"summary": {
"requested_probe_count": 4,
"succeeded_probe_count": 4,
"settled_credits": "4.00"
},
"detail_endpoint": "/v1/visibility/runs/6a75b22b-...",
"result_endpoint": "/v1/visibility/runs/6a75b22b-...?include_results=true"
}
],
"limit": 10,
"kind": "all",
"available_kinds": [
"all",
"saved_test_run",
"visibility_run",
"content_run"
]
}
KindMeaning
saved_test_runA run attached to an existing Console test.
visibility_runA direct AI Visibility infrastructure run.
content_runA direct Content Intelligence infrastructure run.
  • Use detail_endpoint to poll status or read run metadata.
  • Use result_endpoint when you need the compact result payload.
  • The Activity endpoint is intentionally limited to recent operational rows. Use Console result pages for full human-facing analysis views.
StatusMeaning
400Unsupported kind.
401Missing or invalid API key.
403API key is missing runs:read.