engagement

Collect people on a post

Changed on

Everyone who reacted to or commented on up to 10 posts, replies included, saved as contacts and into the caller's list. Any public post works. One call reads one page of each list per post; untilCount reads page after page until that many people are saved or every list has ended, and more true continues where the last call stopped. Each person comes with their name, headline, profile and photo, and their reaction or what they wrote, up to date, in 1 to 2 seconds a page of up to 100 people. Cost: 1 credit a page of up to 100 people, nothing for a page that brought nobody, and a post already read again costs nothing. creditsUsed says what the call spent.

post/collect/linkedin/engagers

Request

  • Base URL: https://api.bereach.ai
  • URL: https://api.bereach.ai/collect/linkedin/engagers
  • Auth: HTTP bearer

Request body

postUrlsstring[] required

LinkedIn feed/update or /posts/ URLs only. Not Pulse articles, Sales Navigator or company pages.

moreboolean

Next page of the same posts, set only when they asked for more people.

untilCountinteger

Target size they named, at most 500: the call reads page after page until that many people are saved or every list has ended. Only when a size was named; one call, since the run pages itself.

surface'likes' | 'comments' | 'both'

Reactions, comments, or both (the default); pick the one the request names.

campaignSlugstring

Optional list to pin saved contacts onto. Ignored in the chat, which always saves to its own list, and on the public preview path.

Response

The people collected, with their run id

successboolean required

False when the posts could not be read now: error says why, retryAfter when to try again.

errorstring

Why nothing could be read, when success is false.

messagestring
runPeopleinteger

With more: the people the whole run has saved, the same number as count. This call's own new people are the people list.

runIdstring

Present when the people were collected. People are saved as contacts as the run proceeds, and they appear in the list rather than in the reply. A run id means the collection ran: never explain this result as needing a connection.

statusstring

Where the run is. While it is running the list is the count, so do not state one. Once it is completed the saved number is final.

postTextstring nullable
readNotestring

How much of the posts' engagement was read, in words ready to relay, composed from totals. Present when the posts' badges were read.

countinteger

People saved by this run so far, every call on it included. The number to narrate. Zero is only an empty post when unreadable is 0; above 0 those people were not shown rather than absent.

hiddenSkippedinteger

People skipped because they need extra lookup we don't do yet. Not saved. Omit or 0 when none.

unreadableinteger

Posts whose asked-for engagement could not be read. DISTINCT posts, not a sum of the two counters below: a post that lost both its lists is one post. Above 0 means the answer is incomplete, and those posts must never be reported as having no engagement.

likesUnavailableinteger

Posts where the reaction list could not be read. On a run that read both surfaces those posts contributed commenters only; on a run scoped with surface they contributed nobody. Say so when above 0; it does not mean nobody reacted.

commentsUnavailableinteger

Posts where the comment list could not be read. The comment half of the field above, and the same rule: it does not mean nobody commented.

saveFailedinteger

People this page read and could not save. Above 0 the count is short by that much, and those people are not absent from the post.

perPostobject

People SAVED per post, keyed by post id, split into likes and comments. Someone who engaged with several of the posts is counted once, under the first post they were saved from, so these are saved counts and not that post's engagement count: say saved, never say the post had only this many engagers. They add up to count. totals is a sum across posts, not a per-post figure.

hasMoreboolean
moreAvailableboolean

True when another page of people exists. Do not fetch it unless the user asked or tapped Load more.

remainderstring

When more pages exist: this page only, do not say fully collected, all pages, or no more remain.

notestring

A caveat about this result in words ready to relay, when one applies.

creditsUsedinteger required

Credits this call spent, net of anything given back. 0 when nothing was charged: a free read, a cached answer, nothing delivered.

retryAfterinteger required

Seconds to wait before another call of the same type. 0 means no wait is needed.

Changes

  • d803625ea497Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      removed the true enum value from the response property for the response status

  • 0d86cfdab3a4Revision changes
    • info

      api tag engagement added

    • info

      api tag scrapers removed