List Watcher Runs
Per-run history: outcome, new-event count, the sections and sources that changed, and what was billed.
GET
/
v3
/
watchers
/
{watcher_id}
/
runs
List Watcher Runs
curl --request GET \
--url https://api.orbitsearch.com/v3/watchers/{watcher_id}/runs \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orbitsearch.com/v3/watchers/{watcher_id}/runs', 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}/runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"runs": [
{
"run_id": "<string>",
"status": "dispatched",
"new_event_count": 123,
"charge_amount": 123,
"charged": true,
"changes": [
{
"change_kind": "new_source",
"section": "<string>",
"items_added": 1,
"items_removed": 1,
"link": "<string>",
"platform": "<string>",
"new_posts": 123,
"title": "<string>",
"summary": "<string>"
}
],
"dispatched_at": "2023-11-07T05:31:56Z",
"runs_covered": 123,
"duration_seconds": 123,
"events": [
{}
],
"error": "<string>",
"finished_at": "2023-11-07T05:31:56Z"
}
]
}{
"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
}
}Runs are listed newest first. Each run returns the events it added (
events: dated timeline entries with date, datePrecision, dateBasis and their sources, identical to sections.eventsTimeline on profile reads), its changes — the profile sections it changed (section_updated, with section, items_added and items_removed) and the source-level deltas behind them — and what it cost. You pay for completed runs.Authorizations
Use an Orbit API key from the Developer Dashboard.
Path Parameters
The watcher ID returned at creation.
Query Parameters
Maximum runs to return.
Required range:
1 <= x <= 200Response
The runs.
Newest first.
Show child attributes
Show child attributes
⌘I
List Watcher Runs
curl --request GET \
--url https://api.orbitsearch.com/v3/watchers/{watcher_id}/runs \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.orbitsearch.com/v3/watchers/{watcher_id}/runs', 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}/runs"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"runs": [
{
"run_id": "<string>",
"status": "dispatched",
"new_event_count": 123,
"charge_amount": 123,
"charged": true,
"changes": [
{
"change_kind": "new_source",
"section": "<string>",
"items_added": 1,
"items_removed": 1,
"link": "<string>",
"platform": "<string>",
"new_posts": 123,
"title": "<string>",
"summary": "<string>"
}
],
"dispatched_at": "2023-11-07T05:31:56Z",
"runs_covered": 123,
"duration_seconds": 123,
"events": [
{}
],
"error": "<string>",
"finished_at": "2023-11-07T05:31:56Z"
}
]
}{
"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
}
}