Get a Watcher
One watcher with its schedule and run counters.
GET
/
v3
/
watchers
/
{watcher_id}
Get a Watcher
curl --request GET \
--url https://api.orbitsearch.com/v3/watchers/{watcher_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, 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.
Response
The 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.
Available options:
existing_sources, existing_socials, new_sources When the next run is scheduled.
Outcome of the most recent run.
Available options:
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.
⌘I
Get a Watcher
curl --request GET \
--url https://api.orbitsearch.com/v3/watchers/{watcher_id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
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}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, 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
}
}