Skip to main content
POST
web.monitor.inventory

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
limit
integer
default:20

Maximum rows per page, 1 to 100.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from the previous page.

Required string length: 1 - 64
query
string

Search text.

Required string length: 1 - 200
searchBy
enum<string>[]

Fields to search.

Maximum array length: 4
Available options:
name,
url,
instructions,
tags
searchType
enum<string>

Search matching rule.

Available options:
exact,
prefix
status
enum<string>

State filter.

Available options:
active,
paused,
failed
targetType
enum<string>

Target filter.

Available options:
page,
sitemap,
extract
detectionType
enum<string>

Detection filter.

Available options:
exact,
semantic
tags
string[]

Up to 17 unique labels; reserved system labels cannot be supplied.

Maximum array length: 17
Required string length: 1 - 50

Response

The result

results
object[]
required

Owned monitors with follow-up handles.

nextCursor
string

Pass as cursor for the next page.