Story Impressions

Story objects expose impression, reach, and isSeen state. Analytics helpers let you mark a synced story as seen and mark a story hyperlink as clicked.

Call story analytics methods on synced story objects. Native and Flutter SDKs explicitly ignore unsynced stories for these analytics calls.

Parameters

Operation	Parameter	Required	Description
Mark story as seen	Synced story object	Yes	Story object whose analytics helper records the seen event.
Mark story link as clicked	Synced story object	Yes	Story object whose analytics helper records the link-click event.
Query reached users	`viewId` / `viewedId`	Yes	Story ID used to query reached users.
Query reached users	`viewedType`	Yes	Viewed type value for stories.
Query reached users	`limit`	No	TypeScript page size for reached-user results.

Mark Story as Seen

Mark a synced story as seen after your UI decides the current user has viewed it.

import { StoryRepository } from '@amityco/ts-sdk';

const unsubscribe = StoryRepository.getStoryByStoryId(storyId, ({ data, error }) => {
  if (error) {
    handleError(error);
    return;
  }

  data?.analytics.markAsSeen();
});

unsubscribe();

token = storyRepository.getStory(storyId: "story-id").observe { object, error in
    if let error {
        handleError(error)
        return
    }

    object.snapshot?.analytics.markAsSeen()
}

fun markStoryAsSeen(
    storyRepository: AmityStoryRepository,
    story: AmityStory
) {
    storyRepository.analytics(story).markAsSeen()
}

void markStoryAsSeen(AmityStory story) {
  AmitySocialClient.newStoryRepository().analytics(story).markAsSeen();
}

Mark Story Link as Clicked

Mark a story link as clicked when the user opens the hyperlink item from the story UI.

import { StoryRepository } from '@amityco/ts-sdk';

const unsubscribe = StoryRepository.getStoryByStoryId(storyId, ({ data, error }) => {
  if (error) {
    handleError(error);
    return;
  }

  data?.analytics.markLinkAsClicked();
});

unsubscribe();

token = storyRepository.getStory(storyId: "story-id").observe { object, error in
    if let error {
        handleError(error)
        return
    }

    object.snapshot?.analytics.markLinkAsClicked()
}

fun markStoryLinkAsClicked(
    storyRepository: AmityStoryRepository,
    story: AmityStory
) {
    storyRepository.analytics(story).markLinkAsClicked()
}

void markStoryLinkAsClicked(AmityStory story) {
  AmitySocialClient.newStoryRepository().analytics(story).markLinkAsClicked();
}

Query Reached Users

Use reached-user APIs to retrieve users who viewed a story.

import { UserRepository } from '@amityco/ts-sdk';

const unsubscribe = UserRepository.getReachedUsers(
  {
    viewId: storyId,
    viewedType: 'story',
    limit: 20,
  },
  ({ data, loading, error, hasNextPage, onNextPage }) => {
    if (error) {
      handleError(error);
      return;
    }

    if (!loading) {
      renderResults(data);
    }

    if (hasNextPage) {
      onNextPage?.();
    }
  },
);

unsubscribe();

token = userRepository
    .getReachedUsers(viewedType: .story, viewedId: "story-id")
    .observe { collection, error in
        if let error {
            handleError(error)
            return
        }

        showSuccessMessage(collection.snapshots.count)
    }

fun queryStoryReachedUsers(
    userRepository: AmityUserRepository,
    storyId: String
) {
    userRepository.getReachedUsers(
        viewedType = AmityViewedType.STORY,
        viewedId = storyId
    )
        .doOnNext { users: PagingData<AmityUser> ->
            getPagingData(users)
        }
        .doOnError { error -> showErrorMessage(error = error) }
        .subscribe()
}

Future<void> queryStoryReachedUsers(String storyId) async {
  final users = await AmityCoreClient.newUserRepository()
      .getViewedUsers(
        viewedType: AmityViewedType.STORY,
        viewedId: storyId,
      )
      .query();

  showError(users.length);
}

Get Stories

Retrieve stories before recording analytics events.

Create Story

Create stories with hyperlink items.

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Parameters

Mark Story as Seen

Mark Story Link as Clicked

Query Reached Users

Get Stories

Create Story

​Parameters

​Mark Story as Seen

​Mark Story Link as Clicked

​Query Reached Users

​Related Topics

Get Stories

Create Story

Parameters

Mark Story as Seen

Mark Story Link as Clicked

Query Reached Users

Related Topics