> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Beamer

> Beamer is a platform that enables companies to announce news, updates, and features directly within their applications or websites, enhancing user engagement and communication.

![Beamer logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/beamer.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=5b51c463cd625c73b484880603b16839)

* **Category:** notifications
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 12
* **Triggers:** 0
* **Slug:** `BEAMER`
* **Version:** 20261101\_00

## Tools

> [accordion] Count Post Comments
>
> **Slug:** `BEAMER_COUNT_POST_COMMENTS`
>
> Tool to count existing comments on a specific post. Use when you need the total number of comments matching specific filters.
>
> #### Input Parameters
>
> **dateTo** `string`
>
> Retrieve comments published before this date (ISO-8601 format)
>
> **postId** `integer` *required*
>
> ID of the post to count comments for
>
> **search** `string`
>
> Retrieve comments with content that contain this text
>
> **dateFrom** `string`
>
> Retrieve comments published after this date (ISO-8601 format)
>
> **language** `string`
>
> Filter by language using ISO-639 two-letter code
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Count Post Reactions
>
> **Slug:** `BEAMER_COUNT_POST_REACTIONS`
>
> Tool to count existing reactions on a specific post. Use when you need the total number of reactions for a given post.
>
> #### Input Parameters
>
> **postId** `integer` *required*
>
> ID of the post to count reactions for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Count Posts
>
> **Slug:** `BEAMER_COUNT_POSTS`
>
> Tool to count existing posts. Use when you need the number of posts matching specific filters.
>
> #### Input Parameters
>
> **dateTo** `string`
>
> Only count posts published before this date (ISO-8601).
>
> **filter** `string`
>
> Count posts with a matching segmentation filter. \[Pro plan and up]
>
> **userId** `string`
>
> User ID to use with filterByUserId only.
>
> **expired** `boolean`
>
> Count only expired (true) or non-expired (false) posts. \[Starter plan and up]
>
> **archived** `boolean`
>
> Count only archived (true) or non-archived (false) posts.
>
> **category** `string`
>
> Only count posts in this category.
>
> **dateFrom** `string`
>
> Only count posts published after this date (ISO-8601).
>
> **language** `string`
>
> Only count posts with translations in this language (ISO-639 two-letter). \[Starter plan and up]
>
> **filterUrl** `string`
>
> Include posts matching this segmentation URL. \[Pro plan and up]
>
> **published** `boolean`
>
> Count only published (true) or draft (false) posts.
>
> **forceFilter** `string`
>
> Only count posts that match this segmentation filter. \[Pro plan and up]
>
> **ignoreFilters** `boolean`
>
> If true, ignore segmentation filters (requires permission).
>
> **filterByUserId** `boolean`
>
> If true, include single-user posts matching userId. \[Scale plan]
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Count Unread Posts
>
> **Slug:** `BEAMER_COUNT_UNREAD_POSTS`
>
> Tool to count unread posts for a user. Use when you need the number of posts the user would see when opening their Beamer feed.
>
> #### Input Parameters
>
> **filter** `string`
>
> Count unread posts with a matching segmentation filter.
>
> **userId** `string`
>
> ID of the user.
>
> **dateFrom** `string`
>
> Count unread posts published after this date (ISO-8601).
>
> **filterUrl** `string`
>
> Count unread posts with a matching segmentation URL.
>
> **userEmail** `string`
>
> Email of the user.
>
> **forceFilter** `string`
>
> Only count unread posts that match this segmentation filter.
>
> **userLastName** `string`
>
> Last name of the user.
>
> **userFirstName** `string`
>
> First name of the user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Category
>
> **Slug:** `BEAMER_GET_CATEGORY`
>
> Retrieve predefined metadata for a category by ID from a local fixed set: new, improvement, fix, comingsoon, announcement, and other.
>
> #### Input Parameters
>
> **category\_id** `string` *required*
>
> Unique identifier of the category to retrieve. Valid categories are: 'new', 'improvement', 'fix', 'comingsoon', 'announcement', and 'other'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Feed
>
> **Slug:** `BEAMER_GET_FEED`
>
> Tool to retrieve the URL for your standalone feed. Use after embedding to fetch the feed link for embedding or sharing.
>
> #### Input Parameters
>
> **theme** `string`
>
> Theme class for appearance customization via CSS. Only available on Pro plan and up.
>
> **filter** `string`
>
> Retrieve posts with a matching segmentation filter. Only available on Pro plan and up.
>
> **userId** `string`
>
> ID of the user viewing the feed (for analytics).
>
> **language** `string`
>
> Two-letter ISO-639 code to retrieve feed in a specific language. Only available on Starter plan and up.
>
> **userEmail** `string`
>
> Email of the user viewing the feed (for analytics).
>
> **filterByUrl** `boolean`
>
> Whether to apply URL filtering to the feed. Only available on Pro plan and up.
>
> **forceFilter** `string`
>
> Only retrieve posts matching this segmentation filter. Only available on Pro plan and up.
>
> **userLastName** `string`
>
> Last name of the user viewing the feed (for analytics).
>
> **ignoreFilters** `boolean`
>
> If true, all posts will be retrieved, ignoring segmentation filters. Requires special API-key permission.
>
> **userFirstName** `string`
>
> First name of the user viewing the feed (for analytics).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Notification
>
> **Slug:** `BEAMER_GET_NOTIFICATION`
>
> Tool to retrieve details of a specific notification by its unique notification ID. Use after obtaining the notification ID to fetch its full details.
>
> #### Input Parameters
>
> **notificationId** `integer` *required*
>
> ID of the notification to retrieve (post ID).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Notifications
>
> **Slug:** `BEAMER_GET_NOTIFICATIONS`
>
> Fetch unread notifications for a user, with optional filters and pagination. The request can mark retrieved notifications as read.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination of results.
>
> **filter** `string`
>
> Retrieve notifications matching this segmentation filter. (Pro plan+)
>
> **userId** `string`
>
> Analytics: ID of the viewing user (Scale plan+).
>
> **category** `string`
>
> Only notifications in this category.
>
> **dateFrom** `string`
>
> Only notifications published after this ISO-8601 timestamp.
>
> **language** `string`
>
> Two-letter ISO-639 code: only notifications in this language. (Starter plan+)
>
> **filterUrl** `string`
>
> Include notifications matching this segmentation URL. Supports wildcards. (Pro plan+)
>
> **saveViews** `boolean`
>
> Whether to record view counts for the retrieved notifications.
>
> **userEmail** `string`
>
> Analytics: email of the viewing user.
>
> **markAsRead** `boolean`
>
> Mark retrieved notifications as read. (default true)
>
> **maxResults** `integer`
>
> Maximum number of notifications to return (max 10).
>
> **forceFilter** `string`
>
> Only retrieve notifications that match this segmentation filter exactly. (Pro plan+)
>
> **userLastName** `string`
>
> Analytics: last name of the viewing user.
>
> **ignoreFilters** `boolean`
>
> Ignore segmentation filters entirely. Requires special API-key permission.
>
> **userFirstName** `string`
>
> Analytics: first name of the viewing user.
>
> **traceableLinks** `boolean`
>
> Convert links to traceable URLs for click analytics.
>
> **ignoreRequestDetails** `boolean`
>
> Ignore IP/browser/geolocation details when retrieving notifications.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Post Comments
>
> **Slug:** `BEAMER_GET_POST_COMMENTS`
>
> Tool to retrieve comments for a specific post. Use after identifying the post ID to list its comments.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (>=1)
>
> **dateTo** `string`
>
> Retrieve comments published before this ISO-8601 date
>
> **postId** `integer` *required*
>
> ID of the post to retrieve comments from
>
> **search** `string`
>
> Retrieve comments containing this substring in their text
>
> **dateFrom** `string`
>
> Retrieve comments published after this ISO-8601 date
>
> **language** `string`
>
> ISO-639 two-letter code to filter comments by language
>
> **maxResults** `integer`
>
> Maximum number of comments to return (1-10)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Post Reactions
>
> **Slug:** `BEAMER_GET_POST_REACTIONS`
>
> Retrieve reactions for a specific post, optionally filtering by date or reaction type and selecting a page of results.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination (>=1)
>
> **dateTo** `string`
>
> Only include reactions before this ISO-8601 timestamp
>
> **postId** `integer` *required*
>
> ID of the post to retrieve reactions from
>
> **dateFrom** `string`
>
> Only include reactions after this ISO-8601 timestamp
>
> **reaction** `string ("positive" | "neutral" | "negative")`
>
> Filter reactions by type: positive, neutral, or negative
>
> **maxResults** `integer`
>
> Maximum number of reactions to return (1-10)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Posts
>
> **Slug:** `BEAMER_GET_POSTS`
>
> Tool to retrieve a list of posts. Use when you need IDs and titles of posts for further operations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Ping API
>
> **Slug:** `BEAMER_PING`
>
> Tool to ping the Beamer API. Use when verifying API key authentication before making further requests.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
