Get scan status

Status of one channel of a scan started by Start a social scan, by one of the job_ids it returned. A scan covering Reddit and LinkedIn has one job per channel; once a job completes it reports the whole scan’s split too. Poll until status is completed, failed, or cancelled, then read the results from List social discussions.


GET /brands/{brand_id}/social/scans/{scan_id}

Authorization

Header	Type	Required
`Authorization`	`Bearer asky_sk_…`	required

Path parameters

Parameter	Type	Required	Description
`brand_id`	`uuid`	required	From List brands
`scan_id`	`uuid`	required	From Start a social scan

Request

cURL


curl --request GET \
  --url 'https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/social/scans/7c9e1f3a-4b2d-4e6f-8a1c-9d3e5b7f2a10' \
  --header 'Authorization: Bearer <api-key>'

Python


import requests
 
url = "https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/social/scans/7c9e1f3a-4b2d-4e6f-8a1c-9d3e5b7f2a10"
 
headers = {"Authorization": "Bearer <api-key>"}
 
response = requests.get(url, headers=headers)
 
print(response.text)

JavaScript


const options = {method: 'GET', headers: {Authorization: 'Bearer <api-key>'}};
 
fetch('https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/social/scans/7c9e1f3a-4b2d-4e6f-8a1c-9d3e5b7f2a10', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP


<?php
 
$curl = curl_init();
 
curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/social/scans/7c9e1f3a-4b2d-4e6f-8a1c-9d3e5b7f2a10",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <api-key>"
  ],
]);
 
$response = curl_exec($curl);
$err = curl_error($curl);
 
curl_close($curl);
 
if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go


package main
 
import (
    "fmt"
    "net/http"
    "io"
)
 
func main() {
 
    url := "https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/social/scans/7c9e1f3a-4b2d-4e6f-8a1c-9d3e5b7f2a10"
 
    req, _ := http.NewRequest("GET", url, nil)
 
    req.Header.Add("Authorization", "Bearer <api-key>")
 
    res, _ := http.DefaultClient.Do(req)
 
    defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)
 
    fmt.Println(string(body))
 
}

Ruby


require 'uri'
require 'net/http'
 
url = URI("https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/social/scans/7c9e1f3a-4b2d-4e6f-8a1c-9d3e5b7f2a10")
 
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
 
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <api-key>'
 
response = http.request(request)
puts response.read_body

Response

200


{
  "data": {
    "job_id": "7c9e1f3a-4b2d-4e6f-8a1c-9d3e5b7f2a10",
    "scan_id": "7c9e1f3a-4b2d-4e6f-8a1c-9d3e5b7f2a10",
    "status": "completed",
    "current_step": "done",
    "channel": "reddit",
    "result_count": 5,
    "surfaced": 7,
    "scan_target": 10,
    "scan_surfaced": 10,
    "scan_split": { "reddit": 7, "linkedin": 3 },
    "credit_cost": 20,
    "is_free_scan": false,
    "opportunities_processed": 34,
    "opportunities_classified": 10,
    "drafts_generated": 0,
    "error_message": null,
    "started_at": "2026-08-27T09:12:04.000Z",
    "completed_at": "2026-08-27T09:14:41.000Z",
    "created_at": "2026-08-27T09:12:00.000Z"
  },
  "request_id": "req_4e8c1a3f7b2d46f0ba9c"
}

401


{
  "error": {
    "code": "token_expired",
    "message": "This API key has expired. Roll it from the API tab on the Connections page to get a replacement.",
    "request_id": "req_8f21c0aa47b1490d2e63"
  }
}

404


{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "request_id": "req_5b0e77d213a94f6a8ce1"
  }
}

429


{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after 24 seconds.",
    "request_id": "req_31c9ba7f0e5d4a118cc2"
  }
}

Response fields

Field	Type	Description
`data.job_id`	`uuid`	required
`data.scan_id`	`uuid`	required. The scan this job belongs to; every channel’s job shares it
`data.status`	`string`	required. `pending`, `running`, `completed`, `failed`, or `cancelled`
`data.current_step`	`string \| null`	Internal pipeline step name, mainly useful for support
`data.channel`	`string \| null`	`reddit` or `linkedin`
`data.result_count`	`integer \| null`	This channel’s starting share of the scan: 5 of 10 with two channels, 10 with one
`data.surfaced`	`integer \| null`	What this channel surfaced, once completed. Can exceed `result_count` when it covered the other channel’s gap
`data.scan_target`	`integer \| null`	Results the whole scan aims for: `10`
`data.scan_surfaced`	`integer \| null`	What the whole scan surfaced, once completed
`data.scan_split`	`object \| null`	Per channel, what the whole scan surfaced, e.g. `{"reddit": 7, "linkedin": 3}`
`data.credit_cost`	`integer \| null`	The whole scan’s price, on its first job (`0` on the others). `0` when the scan was free
`data.is_free_scan`	`boolean \| null`
`data.opportunities_processed`	`integer`	required. Threads or posts examined so far
`data.opportunities_classified`	`integer`	required. Of those, how many were kept as real opportunities
`data.drafts_generated`	`integer`	required. Always `0` for a scan started through this endpoint — drafting is a separate step
`data.error_message`	`string \| null`	Set when `status` is `failed`
`data.started_at`	`timestamptz \| null`
`data.completed_at`	`timestamptz \| null`
`data.created_at`	`timestamptz`	required
`request_id`	`string`	required. Also returned as the `x-request-id` header. Quote it when contacting support

Errors

Status	Code	When
401	`invalid_token`	The key is missing, malformed, or does not exist
401	`token_expired`	The key passed its expiry date
401	`token_revoked`	The key was revoked
404	`not_found`	The brand does not exist, the scan does not exist, or this key is not allowed to reach either. All three are deliberately indistinguishable
429	`rate_limited`	Over 300 requests per minute. See the `Retry-After` header

Notes

There is no list endpoint for past scans yet — only lookup by the job_id a start call returned. Keep it if you want to check back on it.

opportunities_processed and opportunities_classified update while the scan runs, not only at the end. A scan that never finds anything relevant can legitimately complete with both at 0.