Create Monitor

Keep a search or an agent request and run it on a schedule. Each run is the ordinary search or agent run, charged as one; when it ends it is compared with the last run that answered -- new, dropped and moved results, or the answer's added, changed and removed values -- and the webhook hears search.changed / agent.changed when something did. The first run is baselineId's (a finished run with the same request) or starts now.

post/api/v1/monitors

Request

  • Base URL: https://api.mesharc.dev (the document declares no server; this is the origin it was published from)
  • URL: https://api.mesharc.dev/api/v1/monitors
  • Auth: none declared

Headers

authorizationstring nullable
x-mesharc-tenantstring nullable

Request body

kindstring required
requestobject required
schedulestring required
namestring nullable
baselineIdstring nullable
budgetobject nullable
alertsobject nullable
addToProjectstring nullable
destinationstring nullable

Response

Successful Response

idstring required
kindstring required
namestring required
requestobject required
schedulestring required
statusstring required
webhookobject nullable
budgetobject nullable
spentThisMonthinteger
alertsobject nullable
addToProjectstring nullable
rowsobject nullable
destinationstring nullable
sentimentobject nullable
nextRunAtstring nullable
lastRunAtstring nullable
createdAtstring nullable
webhookSecretstring nullable

Changes

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