Skip to main content
GET
/
v1
/
brand
/
{brand_id}
/
scans
Get Brand-Related Scans
curl --request GET \
  --url https://api.urldna.io/v1/brand/{brand_id}/scans \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "submitted_url": "<string>",
    "domain": "<string>",
    "target_url": "<string>",
    "protocol": "<string>",
    "device": "DESKTOP",
    "user_agent": "<string>",
    "http_referer": "<string>",
    "nsfw": true,
    "scanned_from": "DEFAULT",
    "origin": "API",
    "width": 123,
    "height": 123,
    "private_scan": true,
    "status": "PENDING",
    "submitted_date": "2023-11-07T05:31:56Z",
    "submitter_tags": [
      "<string>"
    ],
    "error_code": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Path Parameters

​
brand_id
string
required

Unique brand identifier.

Query Parameters

​
query
string

Optional CQL query string to further filter brand scans. See POST /v1/search documentation for CQL syntax.

​
page
number
default:1

Page number for pagination (1-indexed). Pages beyond the first require PREMIUM subscription.

Response

Brand scans retrieved successfully.

Array of Scan objects associated with the brand, sorted by submission date (newest first).

​
id
string

Unique auto-generated scan identifier.

​
submitted_url
string

Original URL submitted for scanning.

​
domain
string

Extracted domain from the submitted URL.

​
target_url
string

Final destination URL after following all redirects.

​
protocol
string

Protocol used (HTTP or HTTPS).

​
device
enum<string>

Device type used for the scan simulation.

Available options:
DESKTOP,
MOBILE
​
user_agent
string

User agent string used to simulate the browser environment.

​
http_referer
string

HTTP Referer header value indicating the originating page for the request.

​
nsfw
boolean

Indicates whether the page contains Not Safe For Work (NSFW) content such as nudity or adult material.

​
scanned_from
enum<string>

Country code from which the scan was initiated. Available for PREMIUM users only.

Available options:
DEFAULT,
AU,
BE,
CA,
CH,
DE,
ES,
FR,
GB,
GR,
HU,
ID,
IT,
JP,
MX,
NL,
PT,
ZA,
TR,
US
​
origin
enum<string>

Indicates whether the scan was submitted programmatically via API or manually by a user.

Available options:
API,
USER
​
width
number

Viewport width in pixels used during the scan.

​
height
number

Viewport height in pixels used during the scan.

​
private_scan
boolean

When true, scan results are only accessible to the submitting user.

​
status
enum<string>

Current scan status. PENDING and RUNNING are transient states; DONE and ERROR are terminal states.

Available options:
PENDING,
RUNNING,
DONE,
ERROR
​
submitted_date
string<date-time>

ISO 8601 timestamp when the scan was submitted.

​
submitter_tags
string[]

User-defined tags for organizing and categorizing scans.

​
error_code
string

Error code when scan status is ERROR, indicating the reason for failure.