Dashboard API

This page is generated from the code and must not be edited by hand.

This is the Dashboard’s versioned read interface: the routes under /api/v1, which the engine serves on your own machine and which a script of yours could use as well. It listens on the loopback address only, so nothing outside the machine can reach it, and every route listed here only reads: nothing in this table changes a project or the files it describes.

It is not everything the Dashboard talks to. The Dashboard also asks the engine’s local server for other things that are not part of this versioned interface, and everything it writes (an answer, a setting, a re-run) is sent to routes outside it. Neither is listed or documented here.

Every response is one declared model, and every refusal is an ErrorResponse with a status, a code a program can branch on, and words. Every read answers from one run, and a response never mixes two runs. The interface is versioned: this is version 1.0, and a compatible addition changes the minor part only.

The whole interface is also written as an OpenAPI 3.1 document, api/openapi.json, beside this page. A route reads its query parameters from the request and does not declare them in that document; the table below names the ones the engine’s own description of the route gives.

Endpoints

Method	Path	What it returns	Query	Response model
GET	/api/v1/authors	Whom Import offers as a file’s author: the people who have answered in this project.		ImportAuthors
GET	/api/v1/claims/class	The class one claim belongs to, before an answer.	claim	ClaimClassResponse
GET	/api/v1/columns	One table’s columns and the tables they relate it to.	id	ColumnsResponse
GET	/api/v1/completeness	Every experiment of the pinned run, and the sums per person and per theme.		CompletenessResponse
GET	/api/v1/completeness/no_analysis_found	The pinned run’s experiments with no analysis found, each with its reason.		NoAnalysisResponse
GET	/api/v1/design	Every experiment of the pinned run: whether it has a grid, and the run’s summary.		DesignResponse
GET	/api/v1/entry	One entry, and every rule that said anything about it.	id	EntryResponse
GET	/api/v1/experiments/design	One experiment’s design grid, whole.		ExperimentDesignResponse
GET	/api/v1/experiments/files	One experiment’s files, a page at a time.		ExperimentFilesResponse
GET	/api/v1/explorer/axes	What a view beneath one folder can be arranged by.		AxesResponse
GET	/api/v1/explorer/children	A folder’s child folders, a page at a time.		ChildrenResponse
GET	/api/v1/explorer/claim	One published conclusion, with its rule and evidence.	id	ClaimCard
GET	/api/v1/explorer/entry	One file or folder, as every mode’s inspector shows it.		EntryCard
GET	/api/v1/explorer/files	A folder’s files in the Wheel’s order, a page at a time.		FilesResponse
GET	/api/v1/explorer/labels	Every entry’s current display label; with id, that entry’s whole history too.		LabelsResponse
GET	/api/v1/explorer/lineage	A bounded lineage around one file or folder.		LineageResponse
GET	/api/v1/explorer/lineage/families	The lineage with name families collapsed.		LineageFamiliesResponse
GET	/api/v1/explorer/measures	What each measure means, category by category.		MeasuresResponse
GET	/api/v1/explorer/overlay	Every standing statement, its state, and a history.		OverlayResponse
GET	/api/v1/explorer/plan	One saved plan, each move checked, and the diff.	id	PlanCheck
GET	/api/v1/explorer/plans	Every saved plan, newest first.		PlansResponse
GET	/api/v1/explorer/timeline	One run’s times for a file’s thread or a folder’s activity, every mark with its source.		TimelineResponse
GET	/api/v1/explorer/value	One value of an axis beneath a folder.		ValueCard
GET	/api/v1/explorer/wheel	One folder’s shape, in sectors and perimeter bins.		WheelResponse
GET	/api/v1/folder	One folder’s entries, each beside its claims and class keys.	id	FolderResponse
GET	/api/v1/graph/edge	Everything one line rests on.		EdgeDetail
GET	/api/v1/graph/find	Live folders and files whose path holds the words typed.	q	FindResponse
GET	/api/v1/graph/neighborhood	One center, its direct neighbors, and the lines.		NeighborhoodResponse
GET	/api/v1/groups/lattice	The pinned run’s lattice of shared sets, each with its state; nothing is written.		GroupLattice
GET	/api/v1/groups/resolutions	The approved cores and what each resolved in the pinned run; nothing is written.		GroupResolutions
GET	/api/v1/jobs	The project’s recent jobs, newest first, each with its history.		JobsResponse
GET	/api/v1/manifest	What changed in a run from its parent, in sentences.	run	ManifestResponse
GET	/api/v1/questions	The Questions page, its progress, filters and one page of rows.		QuestionsResponse
GET	/api/v1/questions/pack	The questions as one file: how to answer, the questions with their evidence, the answers.		QuestionPack
GET	/api/v1/questions/ranked	Every question, ranked, grouped and given a reason.		QuestionsRankedResponse
GET	/api/v1/questions/sheet	One project’s question sheet and what it settles.		QuestionSheetResponse
GET	/api/v1/restore/preview	The preview of restoring run; nothing is written.		RestorePreview
GET	/api/v1/rules	The rules the run carries, each in plain words, grouped by effect.		RulesResponse
GET	/api/v1/runs	Every published run, oldest first, and the pair a page compares.		RunsResponse
GET	/api/v1/search	Results ranked by a tuple whose parts are shown, never a score.	q	SearchResponse
GET	/api/v1/themes	Every experiment’s theme, every theme and broad theme, and the summary.		ThemesResponse
GET	/api/v1/themes/map	Where each experiment lies in the plane, with its theme and what was found of it.		ThemesMapResponse
GET	/api/v1/themes/overlap	The words each pair of lines of work have in common (the Overlap view’s table).		ThemesOverlapResponse
GET	/api/v1/themes/stability	AMI between seeds overall, NMI beside it, and each theme’s stability and core.		ThemesStabilityResponse
GET	/api/v1/themes/undated	The experiments with no year: no date in a name and no believed time of a file.		ThemesUndatedResponse
GET	/api/v1/themes/unplaced	The experiments in no theme, a page at a time (limit, offset), with why.		ThemesUnplacedResponse
GET	/api/v1/themes/who_else	Per person, the shared words, each theme’s people and lines handed on; who wrote a word.		ThemesWhoElseResponse
GET	/api/v1/themes/years	Themes over time, the year profile, and words used in each other’s place.		ThemesYearsResponse
GET	/api/v1/version	The handshake: the API’s version, the schema, the engine and the run reads serve.		VersionResponse
GET	/api/v1/word/meaning	The word’s meaning now, where it stands, and the correction in force; nothing is written.		WordMeaning
GET	/api/v1/words/cloud	The pinned run’s word cloud, most files first, with what waits on each word.		WordCloud
GET	/api/v1/words/where	Where one word or two stand in the pinned run, and the question asked of two together.		WordsWhere
GET	/api/v1/workspace	What is edited and not committed, and what waits for a re-run.		WorkspaceResponse