scans

List Scans

List scans with filters (comma-separated multi-select; iab_category legacy alias).

tag_match=any (default) returns scans carrying at least one of the requested tag slugs; tag_match=all requires every one of them.

get/api/v1/scans

Request

  • Base URL: https://app.kaminari.ad
  • URL: https://app.kaminari.ad/api/v1/scans
  • Auth: HTTP bearer

Query parameters

statusstring nullable
country_codestring nullable
urlstring nullable
scan_idstring nullable
date_fromstring date nullable
date_tostring date nullable
timezonestring nullable
run_idstring nullable
campaign_idstring nullable
group_idstring nullable
parent_scan_idstring uuid nullable
tagstring nullable
tag_match'any' | 'all'

Boolean semantics of the scan-list tag filter.

ANY matches scans carrying at least one requested slug, ALL only scans carrying every one of them. ANY is the default and the historical behaviour.

ai_categorystring nullable
iab_v3_categorystring nullable
iab_categorystring nullable
brandstring nullable
pageinteger
limitinteger

Response

Successful Response

totalinteger required
pageinteger required
limitinteger required
pagesinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.