v3 Events

Storylines

What is developing over time. A storyline is many events, carries its summary and every event it shows by id, and goes dormant after three quiet days.

q searches storylines by topic, best match first, across every status unless status is sent; a more recently started storyline edges ahead of an older match of similar relevance. Its from and to bound when the title and summary were last rewritten (at or after lastMaterialAt), rather than lastEventAt. It takes from (optional, default the plan's history), to, entityIds and status, and serves the first 100 matches that clear a minimum relevance, none when nothing does; storylineIds, relation and order=asc are refused with it.

Cost: 1 credit.

get/v3/events/storylines

Request

  • Base URL: https://api.elfa.ai
  • URL: https://api.elfa.ai/v3/events/storylines
  • Auth: API key in header x-elfa-api-key

Query parameters

qstring

Topic to search for, up to 500 characters. Ranks by relevance.

fromnumber double

Unix seconds. Required unless storylineIds or q is sent.

tonumber double

Unix seconds. Default now.

storylineIdsstring[]

Up to 30. An id we do not hold is skipped.

entityIdsstring[]

Up to 30 family or entity UUIDs. A storyline matches if it involves any of them.

statusunknown

Default open, or any with q. any reads every status.

relationStorylineRelationV3[]

Repeatable, or comma separated. Matches storylines carrying any of them.

order'desc' | 'asc'
limitnumber double

Default 10, maximum 30.

cursorstring

Response

Ok

nextCursorstring nullable required
hasMoreboolean required
servedFromnumber double nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.