API Reference

Lists link monitors matching the supplied search criteria.

get
https://platform.routy.app/api/v1/link-monitors

Requires the ListLinkMonitors policy. Results are scoped to the calling affiliate and
ordered by creation date descending. Filter by brand link, status, name (partial, case-insensitive)
or whether a change has ever been detected. Paginate with Skip (records to skip, default 0)
and Take (page size, default 20).

🔐 Required permission: link-monitor.read

🚩 Requires feature: link_monitor

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32

Filter by brand link ID.

BrandLinkIds
array of int32s

Filter by multiple brand link IDs.

BrandLinkIds
AffiliateIds
array of int32s

Filter by one or more affiliate IDs. Admin/cross-affiliate use only — affiliate-scoped
callers are already restricted to their own monitors by the global query filter.

AffiliateIds
AccountIds
array of int32s

Filter by one or more affiliate-program account IDs (the brand link's account/connection).
Only matches brand-link monitors.

AccountIds
string
enum

Filter by status.

Allowed:
boolean

Filter to only monitors that have detected changes.

boolean

Filter by whether snapshot (screenshot/DOM) capture is enabled.

boolean

Filter to monitors in an error/blocked/unreachable state (true) or healthy ones (false).

boolean

Filter to monitors with no successful check within the staleness window.

string

Search by name (partial match).

string

Sort key. Supported: "createdAt" (default), "name", "lastCheckAt", "lastChangeDetectedAt",
"status", "affiliateId". Prefix with "-" for descending (e.g. "-lastCheckAt").

int32

Number of records to skip for pagination.

int32

Number of records to take for pagination.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago