Stories Overview

Stories are time-limited media items attached to a story target. The SDKs support image and video stories, optional metadata, optional hyperlink story items, live retrieval, view/link analytics, and soft or hard deletion. The examples in this section use community targets, which are the common target shape across the SDKs covered here.

For a product-level walkthrough, see Stories & Ephemeral Content. The pages in this SDK section stay focused on exact SDK methods and data shapes.

Create

Publish image or video stories with optional metadata and hyperlink items.

Retrieve

Observe individual stories, active story collections, story targets, and global story targets.

Analyze

Mark stories as seen, mark hyperlink clicks, and query reached users where supported.

Story Model

The exact accessor style differs by platform, but story objects expose the same main concepts:

Field	Description
`storyId`	Unique story identifier.
`targetType` / `targetId`	Target that owns the story. The SDK examples use `community`.
`dataType`	Story content type, such as image or video.
`data`	Media-specific story data, including image/video file references where available.
`items` / `storyItems`	Interactive story items such as hyperlinks.
`metadata`	Custom metadata provided during creation.
`syncState` / `state`	Local creation state such as syncing, synced, or failed.
`isDeleted`	Whether the story is deleted.
`isSeen`	Whether the current user has seen the story.
`impression`	Total view count exposed on the story model.
`reach`	Unique reached-user count exposed on the story model.
`expiresAt`, `createdAt`, `updatedAt`	Story lifecycle timestamps.

Story Target Model

Story targets represent story availability for a target such as a community.

Field	Description
`targetType` / `targetId`	Target identity.
`hasUnseen`	Whether the current user has unseen stories for this target.
`syncingStoriesCount`	Local stories still syncing for this target.
`failedStoriesCount`	Local stories that failed to sync for this target.
`updatedAt`	Last target update timestamp.

SDK Surface

Workflow	TypeScript	iOS	Android	Flutter
Create image	`createImageStory()`	`createImageStory(options:)`	`createImageStory()`	`createImageStory()`
Create video	`createVideoStory()`	`createVideoStory(options:)`	`createVideoStory()`	`createVideoStory()`
Single story	`getStoryByStoryId()`	`getStory(storyId:)`	`getStory()`	`live.getStory()`
Active stories	`getActiveStoriesByTarget()`	`getActiveStoriesByTarget(...)`	`getActiveStories(...)`	`getActiveStories(...).build()`
Stories by targets	`getStoriesByTargetIds()`	`getStoriesByTargets(...)`	`getStoriesByTargets(...)`	`getStoriesByTargets(...).build()`
Story target	`getTargetById()`	`getStoryTarget(...)`	`getStoryTarget(...)`	`live.getStoryTaregt(...)`
Story targets	`getTargetsByTargetIds()`	`getStoryTargets(...)`	`getStoryTargets(...)`	`getStoryTargets(...).build()`
Global targets	`getGlobalStoryTargets()`	`getGlobalStoryTargets(option:)`	`getGlobalStoryTargets(...)`	`GlobalStoryTargetLiveCollection`
Analytics	`story.analytics.*`	`story.analytics.*`	`storyRepository.analytics(story).*`	`storyRepository.analytics(story).*`

Flutter’s single story-target helper is currently named getStoryTaregt in the shipped SDK. The spelling above is intentional.

Accuracy Notes

The SDK creation APIs accept image or video files and pass upload/processing errors through their platform-specific async pattern.
File size, duration, and moderation limits are enforced by backend or network configuration. This SDK reference does not hardcode those values.
Story analytics methods should be called on synced story objects. Native and Flutter SDKs explicitly no-op for unsynced stories.
SMART, UNSEEN, SEEN, and ALL query options apply to global story target retrieval.

Create Story

Publish image and video stories.

Get Stories

Retrieve story live objects and collections.

Story Targets

Retrieve target-level story availability and unseen status.

Story Impressions

Record story views, link clicks, and reached users.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Create

Retrieve

Analyze

Story Model

Story Target Model

SDK Surface

Accuracy Notes

Create Story

Get Stories

Story Targets

Story Impressions

Create

Retrieve

Analyze

​Story Model

​Story Target Model

​SDK Surface

​Accuracy Notes

​Related Topics

Create Story

Get Stories

Story Targets

Story Impressions

Story Model

Story Target Model

SDK Surface

Accuracy Notes

Related Topics