Update a Watcher
Pause, resume, retime or rescope a watcher. Only the fields you send change.
curl --request PATCH \
--url https://api.orbitsearch.com/v3/watchers/{watcher_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": false
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: false})
};
fetch('https://api.orbitsearch.com/v3/watchers/{watcher_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.orbitsearch.com/v3/watchers/{watcher_id}"
payload = { "enabled": False }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orbit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true,
"interval_seconds": 123,
"created_at": "2023-11-07T05:31:56Z",
"phases": [
"existing_sources"
],
"next_run_at": "2023-11-07T05:31:56Z",
"last_run_at": "2023-11-07T05:31:56Z",
"last_run_status": "dispatched",
"run_count": 123,
"update_count": 123,
"paused_reason": "<string>"
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}Authorizations
Use an Orbit API key from the Developer Dashboard.
Path Parameters
The watcher ID returned at creation.
Body
Send the fields you want to change.
false pauses the watcher; true resumes it and schedules the next run.
3600 <= x <= 2592000Send null to run all three phases.
existing_sources watches sources already on the profile for updates; existing_socials watches the person's social activity; new_sources looks for new sources about the person.
existing_sources, existing_socials, new_sources Response
The updated watcher.
The watched profile.
Whether runs are scheduled.
Seconds between runs, from 3600 (hourly) to 2592000 (every 30 days).
Phases each run covers; null runs all three.
existing_sources watches sources already on the profile for updates; existing_socials watches the person's social activity; new_sources looks for new sources about the person.
existing_sources, existing_socials, new_sources When the next run is scheduled.
Outcome of the most recent run.
dispatched, completed, failed, null Runs that found new information: a recent or upcoming event, a changed section, a new source, or new social activity.
Set when Orbit paused the watcher, for example insufficient_credits.
curl --request PATCH \
--url https://api.orbitsearch.com/v3/watchers/{watcher_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": false
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({enabled: false})
};
fetch('https://api.orbitsearch.com/v3/watchers/{watcher_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.orbitsearch.com/v3/watchers/{watcher_id}"
payload = { "enabled": False }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orbit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"enabled": true,
"interval_seconds": 123,
"created_at": "2023-11-07T05:31:56Z",
"phases": [
"existing_sources"
],
"next_run_at": "2023-11-07T05:31:56Z",
"last_run_at": "2023-11-07T05:31:56Z",
"last_run_status": "dispatched",
"run_count": 123,
"update_count": 123,
"paused_reason": "<string>"
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}