Beamer API API Reference

These are the developer docs for the Beamer API.

You can find your API key under Settings > API .

For more information on how to use Beamer in your site, check out our web Documentation. For any other doubts you may have about how Beamer works, check out our Help Center.

Rate limit

Our API currently enforces a rate limit of 30 requests per second for paid accounts, in addition to a total daily limit depending on your current plan. If you need an extension, please contact us on our Support chat.

API Endpoint
https://api.getbeamer.com/v0
Contact: info@getbeamer.com
Schemes: https
Version: 0.1.0

Authentication

Beamer-Api-Key

type
apiKey
in
header
name
Beamer-Api-Key

Feed

Operations on your feed

Feed

Get the URL for your feed

GET /url

Use /url to retrieve the URL for your feed.

language
in query
string

Retrieve the URL for your feed in a specific language. The language must follow the ISO-639 two-letter code format. [Only available on the Startup plan (and up)]

filterByUrl
in query
boolean

Whether to apply URL filtering to the feed. [Only available on the Pro plan (and up)]

filter
in query
string

Retrieve posts with a matching segmentation filter. [Only available on the Pro plan (and up)]

userFirstName
in query
string

First name of the user viewing the feed (for Analytics).

userLastName
in query
string

Last name of the user viewing the feed (for Analytics).

userEmail
in query
string

Email of the user viewing the feed (for Analytics).

userId
in query
string

ID of the user viewing the feed (for Analytics).

200 OK

Request authenticated. The request returns a JSON object containing the URL for your standalone feed.

type
object
401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (200 OK) 
{
  "url": "https://app.getbeamer.com/beamer/"
}
Beamer-Api-Key

Ping

Ping the Beamer API

Ping

Ping the API

POST /ping

Use /ping to check you are correctly authenticating your requests with your API key.

200 OK

Request authenticated. The request returns a JSON object containing the name of your product on Beamer.

type
object
401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (200 OK) 
{
  "name": "Beamer"
}
Beamer-Api-Key

Posts

Operations on your posts

Posts

Get existing posts

GET /posts

Use the GET method to query and retrieve existing posts from your account.

filter
in query
string

Retrieve posts with a matching segmentation filter. [Only available on the Pro plan (and up)]

dateFrom
in query
string

Retrieve posts published after this date. The date must follow the ISO-8601 format.

dateTo
in query
string current date/time

Retrieve posts published before this date. The date must follow the ISO-8601 format.

language
in query
string

Retrieve posts with translations in this language. The language must follow the ISO-639 two-letter code format.

category
in query
string

Retrieve posts with this category.

published
in query
boolean

Retrieve only published (or draft) posts. If unspecified, both types of posts will be retrieved.

archived
in query
boolean

Retrieve only archived (or not archived) posts. If unspecified, both types of posts will be retrieved.

expired
in query
boolean

Retrieve only expired (or not expired) posts; posts without an expiration date are considered not expired. If unspecified, both types of posts will be retrieved. [Only available on the Startup plan (and up)]

filterByUserId
in query
boolean false

If true, single-user posts will be retrieved when matching the userId parameter. If false (or if no userId is provided), single-user posts will not be retrieved. [Only available on the Enterprise plan]

userFirstName
in query
string

First name of the user viewing these posts (for Analytics).

userLastName
in query
string

Last name of the user viewing these posts (for Analytics).

userEmail
in query
string

Email of the user viewing these posts (for Analytics).

userId
in query
string

ID of the user viewing these posts (for Analytics).

maxResults
in query
integer

Retrieve this many posts (at most). The default number of posts returned is 10, and the maximum is 100.

page
in query
integer

Combined with the value of 'maxResults' (or its default value), paginate the retrieval of posts.

200 OK
Post

Posts retrieved.

type
Post
400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "id": "123",
    "date": "2018-12-31T00:00:00Z",
    "dueDate": "2019-12-31T00:00:00Z",
    "published": "true",
    "pinned": "false",
    "showInWidget": "true",
    "showInStandalone": "true",
    "category": "new",
    "boostedAnnouncement": "snippet",
    "translations": [
      {
        "title": "Title of the post.",
        "content": "Content of the post.",
        "contentHtml": "<p>Content of the post.</p>",
        "language": "EN",
        "category": "Category",
        "linkUrl": "https://www.getbeamer.com/",
        "linkText": "Click here!",
        "images": [
          "https://app.getbeamer.com/pictures?id=123"
        ]
      }
    ],
    "filter": "admins",
    "autoOpen": "false",
    "editionDate": "2018-12-31T10:00:00Z",
    "feedbackEnabled": "true",
    "reactionsEnabled": "true"
  }
]
Beamer-Api-Key
Posts

Create a new post

POST /posts

Use the POST method to create a new post on your account.

PostCreation

Send a JSON object in the body of the request containing the details of the post to create.

All the main content fields of the post (such as title and content) are arrays of strings, in order to allow the creation of several translations simultaneously.

If you are creating a post with several translations, keep the same order when completing all of the translation-specific fields ( title, content, language, link text and link URL).

The first translation will be created from the first language, the first title, the first content, the first link text, and the first link URL (if any).

Likewise, the second translation will be created from the second title, the second content, and so on.

Multiple translations are only available on the Startup plan (and up).

Request Content-Types: application/json
Request Example
{
  "title": [
    "Title of your post"
  ],
  "content": [
    "Content of your post"
  ],
  "category": "new",
  "publish": true,
  "archive": false,
  "pinned": "false",
  "showInWidget": "true",
  "showInStandalone": "true",
  "boostedAnnouncement": "snippet",
  "linkUrl": [
    "https://www.getbeamer.com/"
  ],
  "linkText": [
    "https://www.getbeamer.com/"
  ],
  "linksInNewWindow": true,
  "date": "2018-12-31T00:00:00",
  "dueDate": "2019-12-31T00:00:00Z",
  "language": [
    "EN"
  ],
  "filter": "admins",
  "filterUserId": "1234",
  "filterUrl": "https://www.getbeamer.com/*",
  "enableFeedback": true,
  "enableReactions": true,
  "enableSocialShare": true,
  "autoOpen": true,
  "sendPushNotification": true,
  "userEmail": "example@getbeamer.com"
}
201 Created
Post

Post created.

The request returns a JSON object containing the details of the post.

400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (201 Created) 
{
  "id": "123",
  "date": "2018-12-31T00:00:00Z",
  "dueDate": "2019-12-31T00:00:00Z",
  "published": "true",
  "pinned": "false",
  "showInWidget": "true",
  "showInStandalone": "true",
  "category": "new",
  "boostedAnnouncement": "snippet",
  "translations": [
    {
      "title": "Title of the post.",
      "content": "Content of the post.",
      "contentHtml": "<p>Content of the post.</p>",
      "language": "EN",
      "category": "Category",
      "linkUrl": "https://www.getbeamer.com/",
      "linkText": "Click here!",
      "images": [
        "https://app.getbeamer.com/pictures?id=123"
      ]
    }
  ],
  "filter": "admins",
  "autoOpen": "false",
  "editionDate": "2018-12-31T10:00:00Z",
  "feedbackEnabled": "true",
  "reactionsEnabled": "true"
}
Beamer-Api-Key
Posts

Count existing posts

GET /posts/count

Use the GET method to count existing posts from your account.

filter
in query
string

Count posts with a matching segmentation filter. [Only available on the Pro plan (and up)]

dateFrom
in query
string

Count posts published after this date. The date must follow the ISO-8601 format.

dateTo
in query
string current date/time

Count posts published before this date. The date must follow the ISO-8601 format.

language
in query
string

Count posts with translations in this language. The language must follow the ISO-639 two-letter code format. [Only available on the Startup plan (and up)]

category
in query
string

Count posts with this category.

published
in query
boolean

Count only published (or draft) posts. If unspecified, both types of posts will be counted.

archived
in query
boolean

Count only archived (or not archived) posts. If unspecified, both types of posts will be counted.

expired
in query
boolean

Count only expired (or not expired) posts; posts without an expiration date are considered not expired. If unspecified, both types of posts will be counted.

filterByUserId
in query
boolean false

If true, single-user posts will be counted when matching the userId parameter. If false (or if no userId is provided), single-user posts will not be counted. [Only available on the Enterprise plan]

userId
in query
string

For using with the filterByUserId parameter only.

200 OK

Posts count.

type
object
400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (200 OK) 
{
  "count": 99
}
Beamer-Api-Key
Posts

Get post by ID

GET /posts/{postId}

Returns a post

postId
in path
integer (int64)

ID of the post to retrieve.

userFirstName
in query
string

First name of the user viewing these posts (for Analytics).

userLastName
in query
string

Last name of the user viewing these posts (for Analytics).

userEmail
in query
string

Email of the user viewing these posts (for Analytics).

userId
in query
string

ID of the user viewing these posts (for Analytics).

200 OK
Post

Post retrieved.

400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

404 Not Found

Post not found.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (200 OK) 
{
  "id": "123",
  "date": "2018-12-31T00:00:00Z",
  "dueDate": "2019-12-31T00:00:00Z",
  "published": "true",
  "pinned": "false",
  "showInWidget": "true",
  "showInStandalone": "true",
  "category": "new",
  "boostedAnnouncement": "snippet",
  "translations": [
    {
      "title": "Title of the post.",
      "content": "Content of the post.",
      "contentHtml": "<p>Content of the post.</p>",
      "language": "EN",
      "category": "Category",
      "linkUrl": "https://www.getbeamer.com/",
      "linkText": "Click here!",
      "images": [
        "https://app.getbeamer.com/pictures?id=123"
      ]
    }
  ],
  "filter": "admins",
  "autoOpen": "false",
  "editionDate": "2018-12-31T10:00:00Z",
  "feedbackEnabled": "true",
  "reactionsEnabled": "true"
}
Beamer-Api-Key
Posts

Update an existing post

PUT /posts/{postId}

Updates the post with the existing ID.

PostCreation

JSON object containing the details of the post to update.

postId
in path
integer (int64)

ID of the post to update.

Request Content-Types: application/json
Request Example
{
  "title": [
    "Title of your post"
  ],
  "content": [
    "Content of your post"
  ],
  "category": "new",
  "publish": true,
  "archive": false,
  "pinned": "false",
  "showInWidget": "true",
  "showInStandalone": "true",
  "boostedAnnouncement": "snippet",
  "linkUrl": [
    "https://www.getbeamer.com/"
  ],
  "linkText": [
    "https://www.getbeamer.com/"
  ],
  "linksInNewWindow": true,
  "date": "2018-12-31T00:00:00",
  "dueDate": "2019-12-31T00:00:00Z",
  "language": [
    "EN"
  ],
  "filter": "admins",
  "filterUserId": "1234",
  "filterUrl": "https://www.getbeamer.com/*",
  "enableFeedback": true,
  "enableReactions": true,
  "enableSocialShare": true,
  "autoOpen": true,
  "sendPushNotification": true,
  "userEmail": "example@getbeamer.com"
}
200 OK
Post

Post updated.

400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

404 Not Found

Post not found.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (200 OK) 
{
  "id": "123",
  "date": "2018-12-31T00:00:00Z",
  "dueDate": "2019-12-31T00:00:00Z",
  "published": "true",
  "pinned": "false",
  "showInWidget": "true",
  "showInStandalone": "true",
  "category": "new",
  "boostedAnnouncement": "snippet",
  "translations": [
    {
      "title": "Title of the post.",
      "content": "Content of the post.",
      "contentHtml": "<p>Content of the post.</p>",
      "language": "EN",
      "category": "Category",
      "linkUrl": "https://www.getbeamer.com/",
      "linkText": "Click here!",
      "images": [
        "https://app.getbeamer.com/pictures?id=123"
      ]
    }
  ],
  "filter": "admins",
  "autoOpen": "false",
  "editionDate": "2018-12-31T10:00:00Z",
  "feedbackEnabled": "true",
  "reactionsEnabled": "true"
}
Beamer-Api-Key
Posts

Deletes a post

DELETE /posts/{postId}

Deletes the post with the given ID.

postId
in path
integer (int64)

ID of the post to delete.

204 No Content

Post deleted.

400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

404 Not Found

Post not found.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.
Beamer-Api-Key
Posts

Get unread posts

GET /unread

Use the GET method to query and retrieve unread posts from your account. Only posts that are visible in your feed are retrieved by this endpoint (draft, deleted, archived, expired and scheduled posts are not retrieved).

filter
in query
string

Retrieve posts with a matching segmentation filter. [Only available on the Pro plan (and up)]

dateFrom
in query
string

Retrieve posts published after this date. The date must follow the ISO-8601 format.

language
in query
string

Retrieve posts with translations in this language. The language must follow the ISO-639 two-letter code format. [Only available on the Startup plan (and up)]

category
in query
string

Retrieve posts with this category.

userFirstName
in query
string

First name of the user viewing these posts (for Analytics).

userLastName
in query
string

Last name of the user viewing these posts (for Analytics).

userEmail
in query
string

Email of the user viewing these posts (for Analytics).

userId
in query
string

ID of the user viewing these posts (for Analytics). If single-user posts are enabled, posts with a matching userId will be retrieved. [Only available on the Enterprise plan] If multi-device synchronization is enabled, the dateFrom parameter will be overridden by this user's last date of viewing your feed - if any. dateFrom can be omitted in this case. [Only available on the Pro plan (and up)]

maxResults
in query
integer

Retrieve this many posts (at most). The default number of posts returned is 10, and the maximum is 100.

page
in query
integer

Combined with the value of 'maxResults' (or its default value), paginate the retrieval of posts.

200 OK
Post

Posts retrieved.

type
Post
400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "id": "123",
    "date": "2018-12-31T00:00:00Z",
    "dueDate": "2019-12-31T00:00:00Z",
    "published": "true",
    "pinned": "false",
    "showInWidget": "true",
    "showInStandalone": "true",
    "category": "new",
    "boostedAnnouncement": "snippet",
    "translations": [
      {
        "title": "Title of the post.",
        "content": "Content of the post.",
        "contentHtml": "<p>Content of the post.</p>",
        "language": "EN",
        "category": "Category",
        "linkUrl": "https://www.getbeamer.com/",
        "linkText": "Click here!",
        "images": [
          "https://app.getbeamer.com/pictures?id=123"
        ]
      }
    ],
    "filter": "admins",
    "autoOpen": "false",
    "editionDate": "2018-12-31T10:00:00Z",
    "feedbackEnabled": "true",
    "reactionsEnabled": "true"
  }
]
Beamer-Api-Key
Posts

Count unread posts

GET /unread/count

Use the GET method to count unread posts from your account. Only posts that are visible in your feed are retrieved by this endpoint (draft, deleted, archived, expired and scheduled posts are not counted).

filter
in query
string

Count posts with a matching segmentation filter. [Only available on the Pro plan (and up)]

dateFrom
in query
string

Count posts published after this date. The date must follow the ISO-8601 format.

language
in query
string

Count posts with translations in this language. The language must follow the ISO-639 two-letter code format.

category
in query
string

Count posts with this category.

userFirstName
in query
string

First name of the user viewing these posts (for Analytics).

userLastName
in query
string

Last name of the user viewing these posts (for Analytics).

userEmail
in query
string

Email of the user viewing these posts (for Analytics).

userId
in query
string

ID of the user viewing these posts (for Analytics). If single-user posts are enabled, posts with a matching userId will be counted. [Only available on the Enterprise plan] If multi-device synchronization is enabled, the dateFrom parameter will be overridden by this user's last date of viewing your feed - if any. dateFrom can be omitted in this case. [Only available on the Pro plan (and up)]

200 OK

Posts count.

type
object
400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (200 OK) 
{
  "count": 99,
  "url": "https://app.getbeamer.com/news?app_id=mZXqptmd65"
}
Beamer-Api-Key

Users

Operations on your users [Only available on the Enterprise plan]

Users

Get users from your Analytics

GET /users

Use the GET method to query and retrieve users from your account's Analytics.

userId
in query
string

ID of the user (as defined in the embed script's user_id parameter).

beamerId
in query
string

Beamer generated ID for the user.

userEmail
in query
string

Email of the user.

sort
in query
string

Sort users by this attribute (in ascending order). This parameter can contain any of the user attributes returned by this endpoint, including custom attributes.

Adding a hyphen ('-') before the attribute will sort the results in descending order. For example, sort=lastSeen will first retrieve users with the oldest 'last seen' date, while sort=-lastSeen will retrieve users that were 'last seen' most recently.

By default, users are sorted by firstSeen (oldest first).

maxResults
in query
integer

Retrieve this many users (at most). The default number of users returned is 10, and the maximum is 100.

page
in query
integer

Combined with the value of 'maxResults' (or its default value), paginate the retrieval of users.

200 OK
User

Users retrieved.

type
User
400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "beamerId": "12345-67890",
    "userId": "1234",
    "userEmail": "example@getbeamer.com",
    "userFirstName": "Example",
    "userLastName": "Beamer",
    "language": "EN",
    "filter": "example-filter",
    "firstSeen": "2018-12-31T10:00:00Z",
    "lastSeen": "2019-01-01T10:00:00Z",
    "ip": "127.0.0.1",
    "browser": "Chrome",
    "os": "Mac OS",
    "city": "Barcelona",
    "country": "Spain",
    "latitude": "0.0",
    "longitude": "0.0"
  }
]
Beamer-Api-Key
Users

Create a new user

POST /users

Use the POST method to create a new user on your account's Analytics.

UserCreation

Send a JSON object in the body of the request containing the details of the user to create.

Request Content-Types: application/json
Request Example
{
  "userId": "1234",
  "userEmail": "example@getbeamer.com",
  "userFirstName": "Example",
  "userLastName": "Beamer",
  "filter": "role-admin;paid-user",
  "language": "EN",
  "ip": "127.0.0.1",
  "browser": "Chrome",
  "os": "Mac OS",
  "city": "Barcelona",
  "country": "Spain",
  "latitude": "0.0",
  "longitude": "0.0"
}
201 Created
User

User created.

The request returns a JSON object containing the details of the user.

400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (201 Created) 
{
  "beamerId": "12345-67890",
  "userId": "1234",
  "userEmail": "example@getbeamer.com",
  "userFirstName": "Example",
  "userLastName": "Beamer",
  "language": "EN",
  "filter": "example-filter",
  "firstSeen": "2018-12-31T10:00:00Z",
  "lastSeen": "2019-01-01T10:00:00Z",
  "ip": "127.0.0.1",
  "browser": "Chrome",
  "os": "Mac OS",
  "city": "Barcelona",
  "country": "Spain",
  "latitude": "0.0",
  "longitude": "0.0"
}
Beamer-Api-Key
Users

Update matching users

PUT /users

Updates existing users.

UserCreation

JSON object containing the details to update for users that match the query.

userId
in query
string

ID of the user to update.

beamerId
in query
string

Beamer generated ID of the user to update.

userEmail
in query
string

Email of the user to update.

Request Content-Types: application/json
Request Example
{
  "userId": "1234",
  "userEmail": "example@getbeamer.com",
  "userFirstName": "Example",
  "userLastName": "Beamer",
  "filter": "role-admin;paid-user",
  "language": "EN",
  "ip": "127.0.0.1",
  "browser": "Chrome",
  "os": "Mac OS",
  "city": "Barcelona",
  "country": "Spain",
  "latitude": "0.0",
  "longitude": "0.0"
}
200 OK
User

Users updated.

type
User
400 Bad Request

Some parameter is missing or doesn't follow the API specification.

401 Unauthorized

Either no API key was provided or the provided API key is invalid

403 Forbidden

Not allowed to access this resource.

405 Method Not Allowed

This method is not allowed on this resource.

500 Internal Server Error

Something went wrong on our side.

Response Content-Types: application/json
Response Example (200 OK) 
[
  {
    "beamerId": "12345-67890",
    "userId": "1234",
    "userEmail": "example@getbeamer.com",
    "userFirstName": "Example",
    "userLastName": "Beamer",
    "language": "EN",
    "filter": "example-filter",
    "firstSeen": "2018-12-31T10:00:00Z",
    "lastSeen": "2019-01-01T10:00:00Z",
    "ip": "127.0.0.1",
    "browser": "Chrome",
    "os": "Mac OS",
    "city": "Barcelona",
    "country": "Spain",
    "latitude": "0.0",
    "longitude": "0.0"
  }
]
Beamer-Api-Key

Schema Definitions

Category: string

Category of the post. Multiple categories can be passed in, separated by semicolons (;). Basic categories include 'new', 'improvement', 'fix', 'comingsoon', 'announcement' and 'other'; other categories may not be available on the Free plan.

Post: object

id: integer (int64)

Unique identifier of this post.

date: string

Publication date of this post in ISO-8601 format.

dueDate: string

Expiration date of this post in ISO-8601 format.

published: boolean

Whether this post is published or a draft.

pinned: boolean

Whether this post is pinned to the top of the feed.

showInWidget: boolean

Whether this post shows up in the embedded feed.

showInStandalone: boolean

Whether this post shows up in the standalone feed.

category: Category
boostedAnnouncement: string

Type of boosted announcement to set for this post.

translations: Translation
Translation
filter: string

Segmentation filter for this post.

autoOpen: boolean

Whether this post automatically opens Beamer's sidebar the first time the user gets it. [Deprecated]

editionDate: string

Date of the last edition made on this post in ISO-8601 format.

feedbackEnabled: boolean

Whether this user feedback is enabled for this post.

reactionsEnabled: boolean

Whether this user reactions are enabled for this post.

Example
{
  "id": "123",
  "date": "2018-12-31T00:00:00Z",
  "dueDate": "2019-12-31T00:00:00Z",
  "published": "true",
  "pinned": "false",
  "showInWidget": "true",
  "showInStandalone": "true",
  "category": "new",
  "boostedAnnouncement": "snippet",
  "translations": [
    {
      "title": "Title of the post.",
      "content": "Content of the post.",
      "contentHtml": "<p>Content of the post.</p>",
      "language": "EN",
      "category": "Category",
      "linkUrl": "https://www.getbeamer.com/",
      "linkText": "Click here!",
      "images": [
        "https://app.getbeamer.com/pictures?id=123"
      ]
    }
  ],
  "filter": "admins",
  "autoOpen": "false",
  "editionDate": "2018-12-31T10:00:00Z",
  "feedbackEnabled": "true",
  "reactionsEnabled": "true"
}

PostCreation: object

title: string[]

Title of the post.

string
content: string[]

Content of the post.

string
category: Category
publish: boolean

Whether to publish this post or save it as a draft.

archive: boolean

Whether to archive this post or not.

pinned: boolean

Whether this post should be pinned to the top of the feed. [Only available on the Startup plan (and up)]

showInWidget: boolean

Whether this post should show up in the embedded feed.

showInStandalone: boolean

Whether this post should show up in the standalone feed.

boostedAnnouncement: string top-bar, popup, snippet, tooltip

Type of boosted announcement to set for this post. [Only available with the Boosted Announcements add-on]

linkUrl: string[]

The URL where users will be redirected to if they click the header of the post or the link shown at the bottom of it.

string
linkText: string[]

The text shown in the link ("linkUrl") of this post.

string
linksInNewWindow: boolean

Whether to open links in a new window/tab (true) or in the same window/tab (false) for this post.

date: string

Publication date for this post in ISO-8601 format. [Future dates / post scheduling are only available on the Startup plan (and up)]

dueDate: string

Expiration date for this post in ISO-8601 format. [Only available on the Startup plan (and up)]

language: string[]

Language of this translation (in ISO-639 two-letter code format). [Only available on the Startup plan (and up)]

string
filter: string

Segmentation filter (or filters) for this post. [Only available on the Pro plan (and up)]

filterUserId: string

User ID to apply as a filter. This post will only be shown to users that have the same ' user_id' parameter in the embed script. [Only available on the Enterprise plan]

filterUrl: string

URL where this post will be shown. If the embedded feed is opened in any URL other than this, the post will not be shown. An asterisk (*) can be used as a wildcard. Multiple URLs can be passed in, separated by semicolons (;). [Only available on the Pro plan (and up)]

enableFeedback: boolean

Whether to enable or disable user feedback for this post [Only available on the Pro plan (and up)]

enableReactions: boolean

Whether to enable or disable user reactions for this post [Only available on the Pro plan (and up)]

enableSocialShare: boolean

Enable this to show options for your users to share this post on social media.

autoOpen: boolean

Enable this to automatically open Beamer's sidebar the first time the user gets this post [Only available on the Startup plan (and up)] [Deprecated]

sendPushNotification: boolean

Enable this to send a web push notification for this post to all your subscribed users. [Only available on the Pro plan (and up)]

userEmail: string

Email of the user in your account creating this post.

Example
{
  "title": [
    "Title of your post"
  ],
  "content": [
    "Content of your post"
  ],
  "category": "new",
  "publish": true,
  "archive": false,
  "pinned": "false",
  "showInWidget": "true",
  "showInStandalone": "true",
  "boostedAnnouncement": "snippet",
  "linkUrl": [
    "https://www.getbeamer.com/"
  ],
  "linkText": [
    "https://www.getbeamer.com/"
  ],
  "linksInNewWindow": true,
  "date": "2018-12-31T00:00:00",
  "dueDate": "2019-12-31T00:00:00Z",
  "language": [
    "EN"
  ],
  "filter": "admins",
  "filterUserId": "1234",
  "filterUrl": "https://www.getbeamer.com/*",
  "enableFeedback": true,
  "enableReactions": true,
  "enableSocialShare": true,
  "autoOpen": true,
  "sendPushNotification": true,
  "userEmail": "example@getbeamer.com"
}

Translation: object

title: string

Title of the post.

content: string

Content of the post (plain text).

contentHtml: string

Content of the post (original HTML format).

language: string

Language of this post (in ISO-639 two-letter code format).

category: string

Custom category of this post.

linkUrl: string

The URL where users will be redirected to if they click the header of the post or the link shown at the bottom of it.

linkText: string

The text shown in the link ("linkUrl") of this post.

images: string[]

URLs of the images embedded in this post.

string
Example
{
  "title": "Title of the post.",
  "content": "Content of the post.",
  "contentHtml": "<p>Content of the post.</p>",
  "language": "EN",
  "category": "Category",
  "linkUrl": "https://www.getbeamer.com/",
  "linkText": "Click here!",
  "images": [
    "https://app.getbeamer.com/pictures?id=123"
  ]
}

User: object

beamerId: string

Beamer generated ID for this user.

userId: string

ID of the user (as defined in the embed script's user_id parameter).

userEmail: string

Email of the user.

userFirstName: string

First name of the user.

userLastName: string

Last name of the user.

language: string

Last detected language for this user.

filter: string

Segmentation filters applied to this user.

firstSeen: string

First detected access of this user, in ISO-8601 format.

lastSeen: string

Last detected access of this user, in ISO-8601 format.

ip: string

Last detected IP from where this user accessed.

browser: string

Last detected browser from where this user accessed.

os: string

Last detected operating system from where this user accessed.

city: string

Last detected city from where this user accessed.

country: string

Last detected country from where this user accessed.

latitude: string

Last detected latitude from where this user accessed.

longitude: string

Last detected longitude from where this user accessed.

Example
{
  "beamerId": "12345-67890",
  "userId": "1234",
  "userEmail": "example@getbeamer.com",
  "userFirstName": "Example",
  "userLastName": "Beamer",
  "language": "EN",
  "filter": "example-filter",
  "firstSeen": "2018-12-31T10:00:00Z",
  "lastSeen": "2019-01-01T10:00:00Z",
  "ip": "127.0.0.1",
  "browser": "Chrome",
  "os": "Mac OS",
  "city": "Barcelona",
  "country": "Spain",
  "latitude": "0.0",
  "longitude": "0.0"
}

UserCreation: object

userId: string

Unique identifier for this user.

userEmail: string

Email for this user.

userFirstName: string

First name for this user.

userLastName: string

Last name for this user.

filter: string

Segmentation filter (or filters) for this user.

language: string

Language for this user. The language must follow the ISO-639 two-letter code format.

ip: string

IP from where this user accessed.

browser: string

Browser from where this user accessed.

os: string

Operating system from where this user accessed.

city: string

City from where this user accessed.

country: string

Country from where this user accessed.

latitude: string

Latitude from where this user accessed.

longitude: string

Longitude from where this user accessed.

Example
{
  "userId": "1234",
  "userEmail": "example@getbeamer.com",
  "userFirstName": "Example",
  "userLastName": "Beamer",
  "filter": "role-admin;paid-user",
  "language": "EN",
  "ip": "127.0.0.1",
  "browser": "Chrome",
  "os": "Mac OS",
  "city": "Barcelona",
  "country": "Spain",
  "latitude": "0.0",
  "longitude": "0.0"
}
Documentation by Spectacle