Skip to main content
Global story target APIs return story targets across the app. Use them for discovery experiences such as a global story tray.

Parameters

Query Options

Option casing follows each platform: TypeScript uses Amity.StorySeenQuery.SMART, iOS uses .smart, Android and Flutter use AmityGlobalStoryTargetsQueryOption.SMART.

Query Global Story Targets

Query global story targets for a tray or discovery surface, using the seen-state option that matches your product sort order.

Notes

  • SMART is the right default for a consumer-facing global tray because it prioritizes unseen targets.
  • Use UNSEEN for a strict “new stories only” surface.
  • Use SEEN when you need a replay or archive-style surface of already seen active targets.
  • Use ALL when your UI needs all active targets regardless of current user’s seen state.

Get Story Targets

Retrieve specific story target state.

Get Stories

Retrieve the actual story objects for one or more targets.