Scheduled exports
Use personal API keys and the /reviewed_records endpoint when you want an automated script or scheduled cron job to fetch newly reviewed records without signing in through a browser.
For one-off interactive exports that include document images or searchable PDFs, use the Export button in the UI instead; see Export records.
Create an API key
- Sign in to OGRRE.
- Click your profile avatar in the top-right corner and select API Keys.
- Under Create New Key, enter a descriptive Key name (such as
RRC nightly export) and choose an Expiration (30 days,90 days, or1 year). - Click Create key.
- Copy the generated
ogrre_...key immediately and store it in your secret manager or cron environment. The full key is shown only once.
To revoke a key at any time, open API Keys from the profile menu and click Revoke beside the key. Revoked and expired keys are rejected immediately.
Fetch the latest reviewed records
Choose your collaborator deployment or enter a custom backend host below to populate the endpoint URLs and code examples on this page:
Send a GET request to /reviewed_records on the backend URL (https://<backend-host>/reviewed_records) with your API key in the Authorization: Bearer <key> header:
curl -fsSL \
-H "Authorization: Bearer ogrre_your_api_key_here" \
"https://<backend-host>/reviewed_records"
How incremental watermark tracking works
Every time a record is edited or its review status changes in OGRRE, its lastUpdated timestamp is updated. The /reviewed_records endpoint returns records whose review_status is reviewed and whose effective update timestamp (lastUpdated, falling back to dateCreated for older records) falls within (since, until]:
- First run (when
sinceis omitted): OGRRE returns all reviewed records in scope up to the current request time (until = now) and records a watermark for your user and scope. - Subsequent runs (when
sinceis omitted): OGRRE automatically looks up theuntiltimestamp of your most recent watermark run for that same scope and returns only reviewed records updated after that timestamp (lastUpdated > sinceandlastUpdated <= now). - Custom time windows: If you pass an explicit
untiltimestamp (for example, to replay a historical window), OGRRE returns records in(since, until]without overwriting your live watermark.
Query parameters
| Parameter | Default | Description |
|---|---|---|
since | Last watermark until (or 0 on first run) | Exclusive lower bound (> since). Accepts a Unix epoch timestamp in seconds (e.g., 1700000000) or an ISO-8601 string (e.g., 2026-01-15T00:00:00Z). |
until | Request time (now) | Inclusive upper bound (<= until). Accepts a Unix epoch timestamp or ISO-8601 string. Omit until on scheduled runs so the watermark advances automatically. |
project_id | All accessible projects in current team | Optional project ID to scope the query and watermark to one project. |
record_group_id | All accessible record groups in scope | Optional record group ID to scope the query and watermark to one record group. |
document_type | All document types | Optional document type name (for example, W-2) to filter record groups and track a watermark specific to that document type. |
format | json | Output format: json (application/json) or csv (text/csv). |
page | 0 | Zero-based page number. |
page_size | 100 | Number of records per page (1–1000). |
JSON response format
When format=json (the default), the endpoint returns pagination metadata, the effective [since, until] window, the job_id recorded in export history, and the records array:
{
"job_id": "8f1d4b92-3c7e-4b0a-9f12-6e1a2b3c4d5e",
"since": 1731500000.0,
"until": 1731586400.42,
"page": 0,
"page_size": 100,
"total_count": 2,
"has_more": false,
"records": [
{
"file": "well-completion-001.pdf",
"api_number": {
"key": "api_number",
"value": "42-123-45678",
"normalized_vertices": null,
"page": 0,
"subattributes": null,
"parentAttribute": null,
"topLevelAttribute": true,
"user_provided_coordinates": null
}
}
]
}
CSV response format
Pass format=csv to download a CSV directly:
curl -fsSL \
-H "Authorization: Bearer ogrre_your_api_key_here" \
"https://<backend-host>/reviewed_records?format=csv&page_size=1000" \
-o reviewed_records.csv
CSV responses also include watermarks and pagination metadata in response headers:
X-Export-SinceandX-Export-UntilX-Total-Count,X-Page,X-Page-Size, andX-Has-MoreX-Export-Job-Id(onpage=0)
Paginating through large runs
Only page=0 advances the saved watermark. If a run returns "has_more": true (more than page_size records matched), pass the since and until values returned from page=0 on subsequent page requests (page=1, page=2, ...) so every page reads from the exact same time window:
import os
import requests
BASE_URL = "https://<backend-host>"
API_KEY = os.environ["OGRRE_API_KEY"]
headers = {"Authorization": f"Bearer {API_KEY}"}
all_records = []
page = 0
window_params = {"page_size": 500}
while True:
response = requests.get(
f"{BASE_URL}/reviewed_records",
headers=headers,
params={**window_params, "page": page},
timeout=60,
)
response.raise_for_status()
payload = response.json()
all_records.extend(payload["records"])
if not payload["has_more"]:
break
# Lock subsequent pages to the exact [since, until] window from page 0
window_params["since"] = payload["since"]
window_params["until"] = payload["until"]
page += 1
print(f"Fetched {len(all_records)} reviewed records")
View and re-run API exports in the UI
Each page=0 call to /reviewed_records is logged in the Exports tab in the OGRRE UI:
- Format column: Labeled
Incremental (Reviewed)beneath theJSONorCSVbadge. - Availability column: Shows
Completed(Direct download), because the data was returned directly in the HTTP response rather than stored as a temporary ZIP archive. - Details dialog: Shows the exact Updated window (
since → until) and record count for that run. - Run again: Clicking Run again on an incremental API export queues a standard background export for the exact same set of records returned by that API call, packaging them into a downloadable ZIP archive in the UI without altering your API watermark.