View as Markdown
VisualPing icon

VisualPing ACTION

Find Jobs

Searches and lists your Visualping monitoring jobs, with optional filters for mode, active/paused state, change-detection frequency, and free text. Use this to discover job ids before calling Get Job Details By Id, Update Job, or Delete Job, or to answer questions like "which jobs are still active" or "find the job monitoring example.com". Auto-paginates through the API's 100-jobs-per-page results, up to a cap of 20 pages (2,000 jobs) — plenty for typical accounts. Example: to find active jobs mentioning "pricing", call with fullTextSearchFilter="pricing" and activeFilter=true → returns matching job records with id, url, mode, interval, trigger, isActive, and more. Pass fields to shrink each result to just the fields you need. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's VisualPing account once, then configure and run Find Jobs from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "visualping-find-jobs",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    visualping: { authProvisionId: "apn_xxxxxxx" },
    organisationId: 10,
    workspaceId: 10,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Find Jobs inputs
Property Type Description
organisationId Organisation Id integer
Unique ID of the organisation. Only applies to business/team accounts — use List Workspace ID Options to discover it (returned alongside workspace ids when the account belongs to an organisation). Leave blank on a personal-tier account: it has no organisation, and this field is expected to be empty rather than guessed.
Optional
workspaceId Workspace ID integer
The workspace's numeric id. Use List Workspace ID Options to discover valid ids and names for the connected account. Example: to work in the "Marketing" workspace, call that tool first, then pass its id here, e.g. 77421.
Optional
activeFilter Active Filter boolean
Filters for active or inactive (paused) jobs.
Optional
inProgressFilter In Progress Filter boolean
Filters for jobs that are currently checking the web page.
Optional
modeFilter Mode Filter string[]
Filters jobs by mode. Multiple choices are allowed.
Optional
frequencyFilter Frequency Filter string[]
Filters jobs by scheduling frequency. Multiple choices allowed.
Optional
hasAdvancedScheduleFilter Has Advanced Schedule Filter boolean
Filters jobs by presence of an advanced schedule.
Optional
eventFilter Event Filter string
Filters jobs by the presence of at least one specific event in the considered time interval (see dateFilter/dateFilterStart). Example: changed.
Optional
dateFilter Date Filter string
Defines the time interval for eventFilter. Example: since_last_week.
Optional
dateFilterStart Date Filter Start string
Required if dateFilter is since_custom_date. Example: 2021-02-20T12:33:44.555+01:00.
Optional
fullTextSearchFilter Full Text Search Filter string
Filters jobs by the presence of a given substring in their URLs or descriptions.
Optional
labelsFilter Labels Filter integer[]
List of label IDs. Jobs without any of these labels attached will be filtered out. Example: 121,345,67. There's no label-listing endpoint in this API — find label IDs in the Visualping web dashboard, where labels are created and assigned to jobs.
Optional
pageSize Page Size integer
Limits the maximum number of jobs per page. Default: 100.
Optional
startPage Start Page integer
The page index to start fetching from (0-based). Each call auto-paginates up to 20 pages; if the summary reports more jobs remain, call again with this set to the reported nextPage to continue.
Optional
sortBy Sort By string
Sort order for the returned jobs.
Optional
fields Fields string[]
Field names to return for each job (id is always included). Omit to get the full job object (today's default output). A useful compact set: id, url, description, mode, isActive, interval, trigger, workspaceId. Pass only the fields you need — smaller responses keep the conversation fast.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
visualping-find-jobs
Version
1.0.0
App
VisualPing
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes