Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
A post object represents a single post from any of the supported platforms (e.g., Facebook, Instagram). All posts also contain an account object. Below are the properties of a post. See examples in /posts.
NOTE: Twitter's Developer Policy mandates that we transmit nothing via the API but Tweet IDs or User IDs, so any Twitter fields that do not meet that policy will be blank or removed. To reconstruct tweets or users, you must make API calls to Twitter with the data you get back.
|brandedContentSponsor||Account||See account. This field is only present for Facebook Page posts where there is a sponsoring Page.|
|caption||text||The caption to a photo, if available.|
|date||date ("yyyy‑mm‑dd hh:mm:ss")||The date and time the post was published. Time zone is UTC.|
|description||text||Further details, if available. Associated with links or images across different platforms.|
|expandedLinks||map of text||A map where the keys are the original links that came in the post (which are often shortened), and the values are the expanded links.|
|id||int||The unique identifier of the post in the CrowdTangle system. This ID is specific to CrowdTangle, not the platform from which the post originated.|
|link||string||An external URL that the post links to, if available. (Facebook only)|
|media||array of media||An array of available media for the post.|
|message||text||The user-submitted text on a post.|
|platform||enum (facebook, instagram, reddit, twitter, vine)||The platform on which the post was posted. E.g., Facebook, Twitter, Reddit, etc.|
|platformId||string||The platform's ID for the post.|
|postUrl||string||The URL to access the post on its platform.|
|score||double||The score of a post as measured by the request. E.g. it will represent the overperforming score if the request
|statistics||Statistics||Performance metrics associated with the post.|
|subscriberCount||int||The number of subscriber the account had when the post was published. This is in contrast to the subscriberCount found on the account, which represents the current number of subscribers an account has.|
|type||enum (photo, video, link, native_video, vine, youtube, tweet, status)||The type of the post.|
|updated||date ("yyyy‑mm‑dd hh:mm:ss")||The date and time the post was most recently updated in CrowdTangle, which is most often via getting new scores from the platform. Time zone is UTC.|
Two sets of metrics for a post:
actual represents the actual metrics of the post, e.g., likeCount or commentCount.
expected represents what that post's metrics were expected to be given that post's properties, as calculated by CrowdTangle. These metrics differ by
platform. For instance, Facebook will include, "likeCount," "commentCount," and "shareCount" while Twitter includes "likeCount" and "retweetCount." The full list is below.
|actual||Map<String, Long>||A set of key-value pairs representing the actual metrics of the post.|
|expected||Map<String, Long>||A set of key-values pairs representing the metrics CrowdTangle expected a post like this to accrue.|
|commentCount||Facebook, Instagram, Reddit, Vine|
|likeCount||Facebook, Twitter, Vine|
The media object represents a piece of media (e.g., video, photo) for a post. It contains the type, source and any additional metadata.
|full||string||The source of the full-sized version of the media.|
|height||int||The height of the media.|
|type||enum (photo or video)||The type of the media.|
|url||string||The source of the media.|
|width||int||The width of the media.|