get_timeline
Retrieve chronological event timelines for a person, family, or entire genealogical tree, with generation grouping and filtering options.
Instructions
Chronological event timeline for a person, family, or the whole tree. Read-only.
kind=person -> /people//timeline; kind=family ->
/families//timeline; kind=people and kind=families return
tree-wide timelines (no handle). Events can be grouped into generations
(ancestors/offspring), filtered by event class (event_classes via
query), and paged (page/pagesize).
Args: kind: "person", "family", "people" or "families". handle: Person/family handle; required for kinds 'person' and 'family'. page: 1-based page of the event list. pagesize: Events per page. strip: If true, drop empty-valued keys from returned objects. discard_empty: If true, omit placeholder slot rows. omit_anchor: If true, exclude the anchor object's own event row. ratings: If true, include per-event relevance ratings. keys: Comma-delimited subset of object keys to return. skipkeys: Comma-delimited keys to exclude. precision: Significant time components (1-3) for age/span strings. ancestors: Number of ancestor generations to include (person kind). offspring: Number of descendant generations to include (person kind). query: Optional dict of extra timeline params (event_classes, events, relative_events, relatives, first, last, handles, ...). instance: Gramps Web base URL from get_instances; default = first.
Returns: dict: {"status", "url", "data": [timeline rows]}.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| keys | No | ||
| kind | Yes | ||
| page | No | ||
| query | No | ||
| strip | No | ||
| handle | No | ||
| ratings | No | ||
| instance | No | ||
| pagesize | No | ||
| skipkeys | No | ||
| ancestors | No | ||
| offspring | No | ||
| precision | No | ||
| omit_anchor | No | ||
| discard_empty | No |