Stories
Here's an overview of stories and how you can get started with integrating them into your application
Last updated
Here's an overview of stories and how you can get started with integrating them into your application
Last updated
Stories, unlike traditional posts, excel in sharing time-sensitive updates like promotions or event highlights. The SDK provides tools for creating, viewing, and interacting with diverse story content—images, videos, links—allowing configurable content duration and expiry periods. Additionally, our dashboard offers insights through basic analytics such as views, unique users, comments, reactions, and Click-Through Rate (CTR).
A Story is multi-layered. The primary content, "Data," depending on the dataType, can be either an IMAGE or a VIDEO. The secondary content, "StoryItems," complements the main content, serving as additional components. For instance, the first supported StoryItem is a Hyperlink, containing URL information and its alias. Overlaying the main content allows users to click and be redirected to the predefined destination.
The functionality of stories can be utilized through the StoryRepository, which offers methods for interacting with a data source that stores stories. This includes methods for obtaining stories, creating a new story, and deleting a story.
Name | Data Type | Description |
storyId | String | ID of the story |
targetType | Enum | Type of target. COMMUNITY |
targetId | String | ID of the target |
dataType | Enum | Type of the story. Either IMAGE or VIDEO. |
data | Object | Data of the story based on dataType |
metadata | Object | Metadata of the story |
storyItems | Array<StoryItem> | StoryItems of the story |
syncState | Enum | Sync state of the story. [FAILED | SYNCING | SYNCED] |
isDeleted | Boolean | Flag indicates whether the story is deleted. |
isSeen | Boolean | Flag indicates whether the story has been viewed by the user |
myReactions | Array<String> | My reactions on the story |
reactionsCount | Integer | Count of reactions on the story |
commentsCount | Integer | Count of comments on the story |
reactions | Map<String, Integer> | Map containing a key | value of reaction | reactionsCount. For ex., “like” | 20 |
reach | Integer | Count of reach of the story |
impression | Integer | Count of impression of the story |
creatorId | String | ID of the user who created the story |
expiresAt | DateTime | Date/time the story expires |
createdAt | DateTime | Date/time the story was created |
Name | Data Type | Description |
targetType | Enum | Type of target |
targetId | String | ID of target |
updatedAt | DateTime | Date/time the story target was updated |
hasUnseen | Boolean | Flag indicates whether the StoryTarget possesses unseen stories. |
