For the complete documentation index, see llms.txt. This page is also available as Markdown.

Data, insights, and tools

Dashboards, metadata, events, playlists, editing, analysis, and exports.

Use these endpoints to inspect and manage CrossWatch data.

Status and insights

Endpoint group
Purpose

/api/dashboard/widgets

Dashboard widget data.

/api/insights

Aggregated insights.

/api/stats and /api/stats/raw

Calculated and raw statistics.

/api/state/wall

Provider state wall.

/api/activity/*

Recent activity and searchable history.

/api/events/*

Event search, groups, acknowledgement, and correlation.

Metadata and media data

Endpoint group
Purpose

/api/metadata/*

Search, resolve, and bulk-resolve metadata.

/art/tmdb/{typ}/{tmdb_id}

Resolve or proxy TMDb artwork.

/api/watchlist/*

Read and delete consolidated watchlist entries.

/api/playback_progress/*

Read and update resumable playback items.

/api/manual/*

Apply watched, watchlist, and rating actions.

Tools

Endpoint group
Purpose

/api/playlists/*

Configure playlist endpoints, rulesets, and mappings.

/api/tracker/*

Browse and edit a local Tracker, manage notes, and review imports.

/api/editor/*

Load, edit, import, and export local datasets.

/api/analyzer/*

Diagnose state and apply supported fixes.

/api/export/*

Read export options, preview rows, and download CSV.

GET /api/editor/statuses reads current title statuses for provider and the optional provider_instance. It is read-only and respects instance access. Unsupported providers return supported: false; incomplete or unknown statuses return null. A failed read returns HTTP 502, or 503 if interrupted.

POST /api/tracker/import/preview starts a private import review using source, source_instance, provider_instance and features. It returns an Interactive Sync session without importing records or saving a sync pair. Administrators can use provider_instance: "new" and name; the new Tracker is created only when the review is applied. Import reviews do not support mapping edits.

To resolve a linked list, send POST /api/playlists/resources/resolve with provider, instance (defaults to default), and ref (the supported list URL). Resolution returns the accessible resource; it does not create an endpoint or mapping. Inaccessible instances return a permission error, and a failed resolution returns HTTP 400.

Published list reads use GET /published/{feed_id}/{name} with the list's key. The optional mediatype, sort, order, offset, and limit parameters filter, sort, and page the returned items. See Published lists for pagination and formats.

Several actions can produce mixed provider results. Check every result entry, not only the HTTP status.

Last updated

Was this helpful?