Search Connection Health

This endpoint cached once every 24 hours. The data you see may be stale, although if you refresh a specific merchant, those updates will be reflected here. We highly recommend subscribing to our Webhooks to get accurate information about when a merchant needs attention.

Search Connection Health

post

Search, Filter and Sort Connection Health reports for all accessible merchants, paged

Query parameters
pageinteger · int32OptionalDefault: 1
sizeinteger · int32OptionalDefault: 20
app_idinteger · int32Required
exclude_publicbooleanOptionalDefault: true
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body

Request object for searching, sorting and filtering ConnectionHealth

querystringOptional

A partial match query against either merchantId or merchantName

statusstring · enumOptional

Filter by ConnectionHealth Status

Possible values:
sort_bystring · enumOptional

Property to sort by in camelCase

Possible values:
sort_directionstring · enumOptional

Direction to sort by

Possible values:
Responses
200

success

application/json
post
/operations/connection_health/search
200

success

Last updated

Was this helpful?