Download OpenAPI specification:
This is the documentation for the Brandwatch SMM v1 API. Read the content of this page carefully, including the API Licence Agreement, to understand how to be a good API citizen and to understand general restrictions and concerns. Your usage and access to the API is expressly conditioned on your compliance with the policies, restrictions and other provisions related to the API set forth in our API Licence Agreement and any other documentation we provide you. You must be compliant with these restrictions in the Brandwatch Terms of Service and the Brandwatch Privacy Policy, in all uses of the API. It also entails you must always ensure to be compliant with requirements from networks from which you use the content. If Falcon.io believes that you have or attempted to violate any term, condition or the spirit of these policies or agreements, your right to access and use the API may be temporarily or permanently revoked.
Brandwatch may modify the attributes and resources available to the API and our policies related to access and use of the API from time to time without advance notice. Brandwatch will use commercially reasonable efforts to notify you of any modifications to the API or policies through notifications or posts on the Brandwatch Developer Website. Brandwatch also tracks deprecation of attributes of the API on its Changes Roadmap. Modification of the API may have an adverse effect on Brandwatch Applications, including but not limited to changing the manner in which Brandwatch Applications communicate with the API and display or transmit Your Data. Brandwatch will not be liable to you or any third party for such modifications or any adverse effects resulting from such modifications.
Brandwatch’s SMM API is rate limited. This means we only allow a certain number of requests per customer organization. We reserve the right to adjust the rate limit for given endpoints in order to provide a high-quality of service for all clients. If the rate limit is exceeded, Brandwatch will respond with an HTTP 429 Too Many Requests response code and a body that details the reason for the limit.
Each customer can create up to 5 API keys. Each API key has a rate limit of 43.200 calls per month, bringing the monthly total to 216.000 calls per customer.
Rate limits overview
| Name | Limit | Explanation |
|---|---|---|
| RollingWindowQuota | 900 calls / 15 minutes | Spike preventing quota |
| AppQuota | 43.200 calls / month | Monthly API key quota |
| CompanyQuota | 5 API keys x 43.200 calls = 216.000 calls / month | Monthly customer limit |
In order to authenticate with the API endpoints, an apikey must be provided as a query parameter. The apikey is a secret between your organization and Brandwatch and can only be obtained
through Brandwatch. In other words, all requests to an endpoint must have ?apikey={YOUR_API_KEY} in the URL, e.g. https://api.falcon.io/teams?apikey={YOUR_API_KEY}
For instructions on how to get access please visit this link: Get access to APIs
If you have any questions please contact our support at apisupport@brandwatch.com
Facebook will sunset the API version currently used by Measure, resulting in the deprecation of certain unique metrics. Due to this change, Measure will no longer be able to fetch or update these metrics with new data when retrieving insights for Facebook-connected channels; historical data may remain available, but no further updates will be provided after the deprecation takes effect. The affected metrics are the following:
CHANNEL:
Paid reach → channel/reach_paid/day
Viral reach → channel/reach_viral/day
Non-viral reach → channel/reach_nonviral/day
Organic reach → channel/reach_organic/day
Video viewers → channel/video_viewers/day
Reach (channel/reach/day) metric will return the new Facebook Viewers value since 1 Jan 2026. Before this date, Facebook Reach values will still be returned.
CONTENT:
Paid reach → content/reach_paid/lifetime
Organic reach → content/reach_organic/lifetime
Fan reach → content/reach_fan/lifetime
Viral reach → content/reach_viral/lifetime
Non-viral reach → content/reach_nonviral/lifetime
Non fans reach → content/reach_non_fan/lifetime
Organic video viewers → content/video_viewers_organic/lifetime
Paid Video viewers → content/video_viewers_paid/lifetime
Video viewers → content/video_viewers/lifetime
Reach (content/reach/lifetime) metric will return the new Facebook Viewers value since 1 Jan 2026. Before this date, Facebook Reach values will still be returned.
Added support for TikTok in channel metrics:
Reach → channel/reach/day
Engagement Rate (Reach) -> channel/engagement_rate_reach/day
Interaction Rate (Reach) -> channel/interaction_rate_reach/day
Added support for TikTok in content metrics:
User follows → content/user_follows/lifetime
Saves → content/saves/lifetime
Updated TikTok content metrics:
content/engagements/lifetime → now includes Saves
content/interactions/lifetime → now includes Saves
New Instagram content metrics:
content/reposts/lifetime
content/skip_rate/lifetime
Updated Instagram content metrics:
content/engagements/lifetime -> Adding reposts metric
content/interactions/lifetime -> Adding reposts metric
New Instagram channel metrics:
Facebook will sunset the API version currently used by Measure, resulting in the deprecation of certain Video View (10s) metrics. Due to this change, Measure will no longer be able to fetch or update these metrics with new data when retrieving insights for Facebook-connected channels; historical data may remain available, but no further updates will be provided after the deprecation takes effect. The affected metrics are the following:
CHANNEL
CONTENT
Video views (10s): content/video_views_10s/lifetime
Organic video views (10s): content/video_views_organic_10s/lifetime
Paid video views (10s): content/video_views_paid_10s/lifetime
Video viewers (10s): content/video_viewers_10s/lifetime
Video autoplays (10s): content/video_views_autoplayed_10s/lifetime
Video click to play (10s): content/video_views_clicked_to_play_10s/lifetime
Video views with sound on (10s): content/video_views_sound_on_10s/lifetime
Video retention rate (10s): content/video_retention_rate_10s/lifetime
Removed incorrect export options in Engage.
Marked legacy Channel endpoints as deprecated in favour of v2 ones
Added new endpoints for Channels
Get Channels V2 added
Get Channel V2 added
Get Channel Groups V2 added
Get Channel Group V2 added
Measure has added the following metric names to the list of supported channel level metrics
channel/followers/day → Followers
channel/followers_decrease/day → Followers decrease
channel/followers_increase/day → Followers increase
channel/followers_net/day → Net new followers
channel/likes_total/day → Page likes (old Facebook Fans values)
channel/likes_total_increase/day → Page likes increase (old Facebook Fans increase values)
channel/likes_total_decrease/day → Page likes decrease (old Facebook Fans decrease values)
channel/net_likes_total/day → Net new page likes (old Facebook Net new fans values)
To avoid breaking existing client integrations with the Measure API, the current Fans metrics will be retained for 4 months, returning the values from the new Followers metrics. On February 1st, 2026 the following fans metrics will be removed and no longer supported.
channel/fans/day (alternative: channel/followers/day)
channel/fans_increase/day (alternative: channel/followers_increase/day)
channel/fans_decrease/day (alternative: channel/followers_decrease/day)
channel/net_fans/day (alternative: channel/followers_net/day)
Added Export CSV for Measure supported metrics
Added new endpoint for Engage
Support for YouTube draft handling
Add new targeting options for Facebook:
Feed targeting
Targeting
Support for Pinterest draft handling
Deprecation of channels in copy publishing endpoint
Facebook draft updated to include facebook REEL placement
LinkedIn draft updated to include LinkedIn Poll content type
Corrected Instagram carousel media field name (originalImage > originalPicture) when handling drafts
Added missing Title property to Facebook video content when handling drafts
LinkedIn draft updated to include LinkedIn Document content type
Deprecation: stop supporting since and until with offset without colon (eg.: +0200) within campaign's APIs
Facebook will deprecate some of their metrics:Changelog - Facebook Pages API - Documentation - Meta for Developers, Measure will no longer be able to update the metrics with new data when fetching insights for Facebook channels. The affected metrics are the following:
Engagements: channel/engagements/day
Engagement Rate: channel/engagement_rate/day
Engagement Rate (Reach): channel/engagement_rate_reach/day
Clicks: channel/clicks/day
Clicks by type: channel/clicks_by_type/button_clicks/day
Clicks by type: channel/clicks_by_type/link_clicks/day
Clicks by type: channel/clicks_by_type/other_clicks/day
Clicks by type: channel/clicks_by_type/photo_view/day
Clicks by type: channel/clicks_by_type/video_play/day
Link clicks: channel/link_clicks/day
Video plays: channel/video_plays/day
Photo clicks: channel/photo_clicks/day
Other clicks: channel/other_clicks/day
Negative actions: channel/negative_actions/day
Negative actions by type: channel/negative_actions_by_type/total/day
Negative actions by type: channel/negative_actions_by_type/hide_all_clicks/day
Negative actions by type: channel/negative_actions_by_type/hide_clicks/day
Negative actions by type: channel/negative_actions_by_type/report_spam_clicks/day
Negative actions by type: channel/negative_actions_by_type/unlike_page_clicks/day
Negative fans: channel/negative_fans/day
Channel views by logged in/out: channel/views_by_logged_in_out/total/day
Channel views by logged in/out: channel/views_by_logged_in_out/logged_out/day
Fans online by hour: channel/fans_online_by_hour/total/day
Fans online by hour: channel/fans_online_by_hour/0/day
Fans online by hour: channel/fans_online_by_hour/1/day
Fans online by hour: channel/fans_online_by_hour/2/day
Fans online by hour: channel/fans_online_by_hour/3/day
Fans online by hour: channel/fans_online_by_hour/4/day
Fans online by hour: channel/fans_online_by_hour/5/day
Fans online by hour: channel/fans_online_by_hour/6/day
Fans online by hour: channel/fans_online_by_hour/7/day
Fans online by hour: channel/fans_online_by_hour/8/day
Fans online by hour: channel/fans_online_by_hour/9/day
Fans online by hour: channel/fans_online_by_hour/10/day
Fans online by hour: channel/fans_online_by_hour/11/day
Fans online by hour: channel/fans_online_by_hour/12/day
Fans online by hour: channel/fans_online_by_hour/13/day
Fans online by hour: channel/fans_online_by_hour/14/day
Fans online by hour: channel/fans_online_by_hour/15/day
Fans online by hour: channel/fans_online_by_hour/16/day
Fans online by hour: channel/fans_online_by_hour/17/day
Fans online by hour: channel/fans_online_by_hour/18/day
Fans online by hour: channel/fans_online_by_hour/19/day
Fans online by hour: channel/fans_online_by_hour/20/day
Fans online by hour: channel/fans_online_by_hour/21/day
Fans online by hour: channel/fans_online_by_hour/22/day
Fans online by hour: channel/fans_online_by_hour/23/day
Reach by gender: channel/reach_by_gender_age/day
Reach by country: channel/reach_by_country/day
Fans increase by like source: channel/fans_increase_by_like_source/total/day
Fans increase by like source: channel/fans_increase_by_like_source/ads/day
Fans increase by like source: channel/fans_increase_by_like_source/news_feed/day
Fans increase by like source: channel/fans_increase_by_like_source/other/day
Fans increase by like source: channel/fans_increase_by_like_source/page_suggestions/day
Fans increase by like source: channel/fans_increase_by_like_source/restored_likes_from_reactivated_accounts/day
Fans increase by like source: channel/fans_increase_by_like_source/search/day
Fans increase by like source: channel/fans_increase_by_like_source/your_page/day
Fans decrease by unlike source: channel/fans_decrease_by_unlike_source/total/day
Fans decrease by unlike source: channel/fans_decrease_by_unlike_source/deactivated_or_memorialized_account_removals/day
Fans decrease by unlike source: channel/fans_decrease_by_unlike_source/other/day
Fans decrease by unlike source: channel/fans_decrease_by_unlike_source/suspicious_account_removals/day
Fans decrease by unlike source: channel/fans_decrease_by_unlike_source/unlikes_from_page_posts_or_news_feed/day
Fans decrease by unlike source: channel/fans_decrease_by_unlike_source/unlikes_from_search/day
Frequency (distribution): channel/frequency_distribution/day
Engaged users: content/engaged_users/lifetime
Engaged users rate: content/engaged_users_rate/lifetime
Engaged fans: content/engaged_fans/lifetime
Negative feedback: content/negative_feedback/lifetime
Negative users: content/negative_users/lifetime
Report as spam: content/report_spam_clicks/lifetime
Unlike page: content/unlike_clicks/lifetime
The deprecated metrics will still be available in the API. They will only be used for historical purposes.
Benchmark API Update:
Added support for YouTube network
Added Reach, Impressions, Engagement Rate properties for content on Facebook, Instagram and X(Twitter)
Fixed a few endpoint HTTP methods and misspelled variables in the payload
/channel/feed/channel/metrics/channel/metrics/followers/channel/metrics/posts/channel/metrics/engagementURL: /benchmark/v1
Added support for copying a stock in the Content Pool API. This allows for the creation of drafts from a stock.
URL: POST /publish/content-pool/stocks/{stockId}/copy
BODY: { channelUuids: string[] }
Adding support for LinkedIn in the following content metrics:
Video views: content/video_views/lifetime
Video viewers: content/video_viewers/lifetime
Video frequency: content/video_frequency/lifetime
Watch time(min): content/video_view_time/lifetime
Video view rate: content/video_view_rate/lifetime
New content metric for LinkedIn video posts:
content/post_watch_time_video_views/lifetimeData for these metrics will be available for LinkedIn video posts published from 2023-05-28
After Facebook deprecated some of their channel level metrics:Changelog - Facebook Pages API - Documentation - Meta for Developers, Measure will no longer be able to update the metrics with new data when fetching insights for Facebook channels. The affected metrics are the following:
Engaged users: channel/engaged_users/day
Comments: channel/comments/day
Shares: channel/shares/day
Clicks: channel/clicks/day
Engagements: channel/engagements/day
Interactions: channel/interactions/day
Engagement rate: channel/engagement_rate/day
Engagement rate (Reach): channel/engagement_rate_reach/day
Interaction rate: channel/interaction_rate/day
Interaction rate (Reach): channel/interaction_rate_reach/day
Positive actions by type: channel/positive_actions_by_type/total/day
Positive actions by type: Answer - channel/positive_actions_by_type/answer/day
Positive actions by type: Claim - channel/positive_actions_by_type/claim/day
Positive actions by type: Comment - channel/positive_actions_by_type/comment/day
Positive actions by type: Like - channel/positive_actions_by_type/like/day
Positive actions by type: Other - channel/positive_actions_by_type/other/day
Positive actions by type: RSVP - channel/positive_actions_by_type/rsvp/day
Positive actions by type: Share - channel/positive_actions_by_type/share/day
Fans increase by like source - channel/fans_increase_by_like_source/total/day
Fans increase by like source: Ads - channel/fans_increase_by_like_source/ads/day
Fans increase by like source: News feed - channel/fans_increase_by_like_source/news_feed/day
Fans increase by like source: Page suggestions - channel/fans_increase_by_like_source/page_suggestions/day
Fans increase by like source: Restored likes from reactivated accounts - channel/fans_increase_by_like_source/restored_likes_from_reactivated_accounts/day
Fans increase by like source: Search - channel/fans_increase_by_like_source/search/day
Fans increase by like source: Other - channel/fans_increase_by_like_source/other/day
Fans decrease by unlike source - channel/fans_decrease_by_unlike_source/total/day
Fans decrease by unlike source: Deactivated or memorialized account removals - channel/fans_decrease_by_unlike_source/deactivated_or_memorialized_account_removals/day
Fans decrease by unlike source: Suspicious account removals - channel/fans_decrease_by_unlike_source/suspicious_account_removals/day
Fans decrease by unlike source: Unlikes from page, posts, or news feed - channel/fans_decrease_by_unlike_source/unlikes_from_page_posts_or_news_feed/day
Fans decrease by unlike source: Unlikes from search - channel/fans_decrease_by_unlike_source/unlikes_from_search/day
Fans decrease by unlike source: Other - channel/fans_decrease_by_unlike_source/other/day
Engagement stories by type - channel/engagement_stories_by_type/total/day
Engagement stories by type: Checkins - channel/engagement_stories_by_type/checkins/day
Engagement stories by type: Fan posts - channel/engagement_stories_by_type/fan_posts/day
Engagement stories by type: Offer claims - channel/engagement_stories_by_type/offer_claims/day
Engagement stories by type: Page likes - channel/engagement_stories_by_type/page_likes/day
Engagement stories by type: Page mentions - channel/engagement_stories_by_type/page_mentions/day
Engagement stories by type: Page posts - channel/engagement_stories_by_type/page_posts/day
Engagement stories by type: Question answers - channel/engagement_stories_by_type/question_answers/day
Engagement stories by type: RSVP - channel/engagement_stories_by_type/rsvp/day
Engagement stories by type: Other - channel/engagement_stories_by_type/other/day
Frequency (distribution) - channel/frequency_distribution/day
Channel views by logged in/out: channel/views_by_logged_in_out/total/day
Channel views by logged in/out: Logged in - channel/views_by_logged_in_out/logged_in/day
Channel views by logged in/out: Logged out - channel/views_by_logged_in_out/logged_out/day
Storytellers by country - channel/storytellers_by_country/day
Fans by Gender and Age - channel/fans_by_gender_age/day
Storytellers by Gender and Ager - channel/storytellers_by_gender_age/day
The deprecated metrics will still be available in the API. They will only be used for historical purposes.
New content metrics for Instagram:
Plays - content/plays_total/lifetime - Available for Reels.
Replays - content/replays/lifetime - Available for Reels.
Profile activity - content/profile_activity/lifetime - Available for Reels, Images and Videos.
Adding Instagram support to the following content metrics:
Watch time (min) - content/video_view_time/lifetime - Adding support for Reels.
Average watch time - content/video_avg_time_watched/lifetime - Adding support for Reels.
User follows - content/user_follows/lifetime - Adding support for Reels, Images and Videos.
User profile clicks - content/user_profile_clicks/lifetime - Adding support for Reels, Images and Videos.
Adding support for more Instagram content types:
Shares - content/shares/lifetime - Adding support for Carousels, Images and Videos in addition to the already supported Reels.
Engagements - content/engagements/lifetime- Adding Shares to the metric for Carousels, Images and Videos in addition to the already supported Reels.
Engagement Rate - content/engagement_rate/lifetime - Adding Shares to the formula for Carousels, Images and Video in addition to the already supported Reels.
Engagement Rate (Reach) - content/engagement_rate_reach/lifetime - Adding Shares to the formula for Carousels, Images and Videos in addition to the already supported Reels.
Weighted engagements - content/engagements_weighted/lifetime - Adding Shares with weight 3 to the formula for Carousels, Images and Videos in addition to the already supported Reels.
Weighted engagement rate - content/engagement_rate_weighted/lifetime - Adding Shares with weight 3 to the formula for Carousels, Images and Videos in addition to the already supported Reels.
New content metric for Facebook, Instagram, LinkedIn and TikTok:
Instagram Images, Videos, Reels and Carousels published after 2021-12-31 are affected by the changes.
Adding support for Instagram in the following channel metrics:
Fans decrease: channel/fans_decrease/day
Engaged users: channel/engaged_users/day
Reactions: channel/reactions/day
Likes: channel/likes/day
Comments: channel/comments/day
Shares: channel/shares/day
Engagements: channel/engagements/day
Engagement rate: channel/engagement_rate/day
New Instagram channel metrics with their corresponding breakdowns:
Saves - channel/saves/day
Engaged users rate - channel/engaged_users_rate/day
Reach by media type - channel/reach_by_media_type/total/day
Reach by follow type - channel/reach_by_follow_type/total/day
Engagements by media type - channel/engagements_by_media_type/total/day
Likes by media type - channel/likes_by_media_type/total/day
Comments by media type - channel/comments_by_media_type/total/day
Shares by media type - channel/shares_by_media_type/total/day
Saves by media type - channel/saves_by_media_type/total/day
Profile activity by type - channel/profile_activity_by_type/total/day
Engagement rate (reach) by media type - channel/engagement_rate_reach_by_media_type/total/day
New channel metric for Facebook, Instagram and LinkedIn:
The list of all supported metrics has been updated with the new changes, including the description for each metric. The list can be accessed from the following link: https://app.falcon.io/measure/public-api/v2/metrics/export/csv?level=channel
New metrics in Measure API v2
Content metrics - Twitter
Organic Likes: content/likes_organic/lifetime
Paid Likes: content/likes_paid/lifetime
Organic Comments: content/comments_organic/lifetime
Paid Comments: content/comments_paid/lifetime
Organic Shares: content/shares_organic/lifetime
Paid Shares: content/shares_paid/lifetime
Organic Engagements: content/engagements_organic/lifetime
Paid Engagements: content/engagements_paid/lifetime
Organic Engagement Rate: content/engagement_rate_organic/lifetime
Paid Engagement Rate: content/engagement_rate_paid/lifetime
Organic Link clicks: content/link_clicks_organic/lifetime
Paid Link clicks : content/link_clicks_paid/lifetime
Organic User profile clicks: content/user_profile_clicks_organic/lifetime
Paid User profile clicks: content/user_profile_clicks_paid/lifetime
Organic Interactions: content/interactions_organic/lifetime
Paid Interactions content/interactions_paid/lifetime
Organic Interaction Rate: content/interaction_rate_organic/lifetime
Paid Interaction Rate: content/interaction_rate_paid/lifetime
Organic Link CTR: content/ctr_link_organic/lifetime
Paid Link CTR: content/ctr_link_paid/lifetime
Organic Video starts: content/video_starts_organic/lifetime
Paid Video starts: content/video_starts_paid/lifetime
Organic Video views (25%): content/video_views_25_organic/lifetime
Paid Video views (25%): content/video_views_25_paid/lifetime
Organic Video views (50%): content/video_views_50_organic/lifetime
Paid Video views (50%): content/video_views_50_paid/lifetime
Organic Video views (75%): content/video_views_75_organic/lifetime
Paid Video views (75%): content/video_views_75_paid/lifetime
Organic Video views (100%): content/video_views_100_organic/lifetime
Paid Video views (100%): content/video_views_100_paid/lifetime
Video completion rate: content/video_completion_rate_100/lifetime
Organic Video completion rate: content/video_completion_rate_100_organic/lifetime
Paid Video completion rate: content/video_completion_rate_100_paid/lifetime
Please note that these new metrics can be accessed from 20th of May 2023 for organic tweets and 20th of July 2023 for promoted tweets.
Added Link In Bio API. This api allows getting, adding, and deleting links from a link in bio page.
Corrected documentation on the Short URL API.
As of August 1st, Twitter has deprecated the InsightsTrack API. Consequently, Measure API v2 will cease to provide support for the following "Content metrics" for Twitter:
content/reach/lifetime
content/engaged_users/lifetime
content/detail_expands/lifetime
content/unfavorites/lifetime
content/unreplies/lifetime
content/unretweets/lifetime
content/user_follows/lifetime
content/user_unfollows/lifetime
content/email_clicks/lifetime
content/unquote_retweets/lifetime
content/hashtag_clicks/lifetime
content/photo_view_clicks/lifetime
content/permalink_clicks/lifetime
content/video_views_95/lifetime
content/app_open_clicks/lifetime
content/app_install_clicks/lifetime
content/engagement_rate_reach/lifetime
content/interaction_rate_reach/lifetime
content/frequency/lifetime
content/engaged_users_rate/lifetime
content/engagement_rate_link/lifetime (using reach, Measure will add it using impressions)
content/photo_view_rate/lifetime
content/other_clicks/lifetime
Please note that these metrics will remain accessible through the API until March 2024, with data available until August 1st, 2023
New metrics in Measure API v2
Channel metrics - Facebook and LinkedIn
Interaction rate: channel/interaction_rate/day
Interaction rate (reach): channel/interaction_rate_reach/day
Content metrics - Facebook
Non fans reach: content/reach_non_fan/lifetime
Non fans impressions: content/impressions_non_fan/lifetime
Video views (complete): content/video_views_complete/lifetime
Video viewers (complete): content/video_viewers_complete/lifetime
Video views (30s): content/video_views_30s/lifetime
Measure API V1 is deprecated. These are all endpoints containing "measure/api/v1" in their path.
The documentation for Measure API V1 is removed.
Update Publishing API to contain Placement field for all network types.
Announcing change in field requirements, starting from 2023-03-01 Placement will be a required field for all content types.
Added Measure API V2
Announce 3 months deprecation period for Measure API V1. The following endpoints will be decommissioned on 2023-02-01: Get Facebook and Instagram Page insights metrics; Get content metrics by channel ids; Get content metrics by content ids; Get Instagram Content
Support for Instagram Reels has been added
Support for placement are added
Content can be filtered by placements
See Instagram drafts and Channel Content for more details.
Documentation relative to the deprecated Content Pool API has been deleted.
Documentation relative to the deprecated Approval flow endpoints and payload has been deleted.
The Approval object from all the Publishing endpoints payloads has been ´deprecated´ and will stop being accepted in 60 days.
The "Send for approval" endpoint has been deprecated. It will be removed in 60 days and for the time being it won't be replaced.
The "Schedule draft" endpoint has been deprecated and is replaced by this new endpoint. It will be removed in 60 days.
New Content Pool API added. Check here.
Old Content Pool API marked as deprecated
Falcon is working on delivering an improved Measure API V2 endpoints during 2022. For this reason, from July 2021 onwards, the following endpoints are deprecated and no new customers will be able to receive data from them:
Expose new payload to return appended SRT files for video templates.
Expose new payload to append SRT files to Templates.
The link on the description of the fields in Engage Export API was added.
uuid field is added to the response of Get channels endpoint.
Engage Export API was added. The API provides an opportunity to retrieve Engage Export that is available on the web version of Engage through REST. The API contains two endpoints that allow to request the export and check its status.
These changes all apply to Channel Content API and Get copies API:
Remove documentation for twitter-only fields: retweetProperties
Group facebook-only properties under a new field facebook. We also added a new field to this object hideLastCard
Field publishingId renamed to originPublishing.
Field tags renamed to labels.
Field link replaced by links to support Carousels posts.
Fields channel and channels are both replaced by externalChannels.
Map missing fields
These changes all apply to Templates API:
Remove documentation for twitter-only fields: retweetProperties
Group facebook-only properties under a new field facebook. We also added a new field to this object hideLastCard
Field publishingId renamed to originPublishing.
Field tags renamed to labels.
Field link replaced by links to support Carousels posts.
Fields channel and channels are both replaced by externalChannels.
Map missing fields
It is now possible to define an embargoDate and expirationDate fields when creating or updating Publish Templates.
It is also possible to retrieve these two fields when getting a Template by ID or a list of templates.
Add video field to content of LinkedIn Draft.
Get Channel Content now returns information on where content was copied from. Potential origins are: stock template, existing publication or scheduled publishing.
Added new endpoint to search for Facebook locations.
Added new endpoint to search for Instagram locations.
Added new endpoint to search for Twitter locations.
Fix place object of Instagram options: Instagram Draft.
Fix place object of Twitter options: Twitter Draft.
Deprecated fields removed in Facebook picture payload: picture.fileName, picture.url, picture.originalPicture.
Add place field to Instagram options Instagram Draft.
Add locales field to Facebook Feed Targeting in Facebook Draft and Get Channel Content sections.
Mark single-picture fields in Facebook Draft as deprecated.
Introducing APIs for Content Labeling and Draft Label Handling.
Listen Get Topic Metrics now return the top phrases and their count.
The content metrics facebook/post_video_view_time_by_age_bucket_and_gender/lifetime and facebook/post_video_view_time_by_region_id/lifetime are deprecated as they return totals and not the breakdowns. Please use facebook/post_video_view_time/lifetime instead to get the totals.
We're happy to inform that we have raised the RollingWindowQuota to 900 calls / 15 minutes to better cater to customer needs.
Due to the deprecation of Twitter Insights metrics in Falcon.io API and Google’s announcement that Google+ API’s will be deprecated in 90 days, we have retired the Get Channel insight metrics endpoint. You can still get insights metrics for Facebook and Instagram channels via the endpoints Get Facebook and Instagram Page insights metrics, Get content metrics by channel ids and Get content metrics by content ids
Please note that due to Twitter API policy we are as of 10th of December 2018, unable to provide full data regarding Twitter accounts and published Twitter content. Therefore, only Twitter account IDs and post IDs will be returned along with some internal Falcon.io workflow data for each channel and post. You will also no longer be able to retrieve insights for your Twitter accounts via our API. If you wish to retrieve all this Twitter data and use it in your own application, then we recommend registering your application with Twitter and retrieving it using Twitter API directly.
Get content metrics by content ids endpoint accepts post ids which come from the specified network (facebook or instagram). These post ids are also called "externalIds".
The content metric facebook/post_fan_reach/lifetime has been deprecated in Facebook Graph Api 3.0 Changelog. Please use facebook/post_impressions_fan_unique/lifetime instead.
Provide documentation for Publish get copied content API
Removal of YouTube metrics from the Channel insight metrics API due to YouTube compliance.
Removal of deprecated User and Team performance metrics APIs.
Rename channel and content level metrics according to changes in Facebook Graph Api 3.1 insights
Facebook changed definition of the organic impression both on channel and content level. Facebook Graph Api 2.12 Changelog
Prior to that point, organic did not include viral impressions. This means that the total was: organic + viral + paid.
After this point the viral impressions are also counted in organic impressions. This means that the total now is: organic + paid.
Introduction of object - shorteningUrls types in the body of individual networks Publishing draft APIs.
| limit | number Example: limit=50 Limits the number of team channels output, default = 50. |
| offset | number Example: offset=0 Offset from the first team channel, default = 0. |
| id required | string |
| name required | string |
| color required | string or null |
| orgId required | number |
[- {
- "id": "8ad597b9503d53ce01504171775d655e",
- "name": "Community Managers",
- "color": null,
- "orgId": 35901
}, - {
- "id": "8aa7c89c43bf32210143bfa31c100331",
- "name": "Falcon Marketing",
- "color": "#b347b3",
- "orgId": 35901
}, - {
- "id": "8ad00c1344788eb6014488d221e61129",
- "name": "Helle's Team!",
- "color": "#b2b347",
- "orgId": 35901
}, - {
- "id": "8ad187d0544488d50144f9602fc50c80",
- "name": "Inbound",
- "color": "#47b2b3",
- "orgId": 35901
}
]| team_id required | string Example: 8aa7c89c43bf32210143bfa31c100331 Unique team id |
| id | string |
| name | string |
| color | string or null |
| orgId | number |
[- {
- "id": "8ad597b9503d53ce01504171775d655e",
- "name": "Community Managers",
- "color": null,
- "orgId": 35901
}
]| team_id required | string Example: 8aa7c89c43bf32210143bfa31c100331 Unique team id. |
| limit | number Example: limit=50 Limits the number of team channels output, default = 50. |
| offset | number Example: offset=0 Offset from the first team channel, default = 0. |
| alsoDeleted | boolean Example: alsoDeleted=false Also return deleted users, default = false. |
| userId required | string |
| fbId required | string or null |
| firstName required | string |
| lastName required | string |
| name required | string |
| email required | string |
| createDate required | string |
| lastLoginDate required | string |
| modifiedDate required | string or null |
| userType required | number |
| userType2 required | any |
| loginCount required | number |
| profilePicture required | string or null |
| useDateFormat required | boolean |
| deletedAt required | string or null |
| orgId required | number |
| teamId required | string |
| teamIds required | Array of any |
| defaultTargetingCities required | string or null |
| defaultTargetingCityNames required | string or null |
| defaultTargetingRegions required | string or null |
| defaultTargetingRegionNames required | string or null |
| defaultTargetingLocales required | string or null |
| defaultTargetingCountryCodes required | string or null |
| defaultTargetingCountryNames required | string or null |
| defaultTargetingLocaleNames required | string or null |
| pipedriveApiToken required | string or null |
| credentials required | any |
| admin required | boolean |
| defaultChannelRole required | string |
| accessContentPool required | boolean |
| adminWithoutTeam required | boolean |
| superUser required | boolean |
[- {
- "userId": "ae053f8d849e4835a51f294f9c3fde58",
- "fbId": null,
- "firstName": "Alex",
- "lastName": "Jensen",
- "name": "Alex Jensen",
- "email": "alex.jensen@falcon.io",
- "createDate": "2015-07-06T14:18:59.859Z",
- "lastLoginDate": "2015-10-10T22:52:29.287Z",
- "modifiedDate": null,
- "userType": 0,
- "userType2": null,
- "loginCount": 34,
- "profilePicture": null,
- "useDateFormat": false,
- "deletedAt": null,
- "orgId": 35901,
- "teamId": "8aa7d89c43bf32210143bfa31c100251",
- "teamIds": [ ],
- "defaultTargetingCities": null,
- "defaultTargetingCityNames": null,
- "defaultTargetingRegions": null,
- "defaultTargetingRegionNames": null,
- "defaultTargetingLocales": null,
- "defaultTargetingCountryCodes": null,
- "defaultTargetingCountryNames": null,
- "defaultTargetingLocaleNames": null,
- "pipedriveApiToken": null,
- "credentials": null,
- "admin": true,
- "defaultChannelRole": "EDITOR",
- "accessContentPool": true,
- "adminWithoutTeam": false,
- "superUser": true
}, - {
- "userId": "8ad187d044f488d50144fa001fb71043",
- "fbId": null,
- "firstName": "John",
- "lastName": "Doe",
- "name": "John Doe",
- "email": "john@falcon.io",
- "createDate": "2014-03-25T16:08:35.667Z",
- "lastLoginDate": "2015-10-12T12:06:33.564Z",
- "modifiedDate": null,
- "userType": 0,
- "userType2": null,
- "loginCount": 24,
- "useDateFormat": false,
- "deletedAt": null,
- "orgId": 35901,
- "teamId": "8aa7c89c43gf32210143bfa31c100251",
- "teamIds": [ ],
- "defaultTargetingCities": "",
- "defaultTargetingCityNames": "",
- "defaultTargetingRegions": "",
- "defaultTargetingRegionNames": "",
- "defaultTargetingLocales": "",
- "defaultTargetingCountryCodes": "",
- "defaultTargetingCountryNames": "",
- "defaultTargetingLocaleNames": "",
- "pipedriveApiToken": null,
- "credentials": null,
- "admin": false,
- "defaultChannelRole": "EDITOR",
- "accessContentPool": true,
- "adminWithoutTeam": false,
- "superUser": true
}
]Array of objects |
{- "responseFields": [
- "id",
- "name",
- "teams"
], - "nameContains": "test"
}{- "items": [
- {
- "id": "000b45f0-ba80-454a-b5dd-dedca0679fb3",
- "name": "Happy Test Page",
- "teams": [
- "8a81800666ed1a940166f02547781283",
- "8a8180066643d366016662a2e14d6c0c"
]
}, - {
- "id": "07ec5e36-b41c-400d-840a-62637ecddf94",
- "name": "Another Test Page",
- "teams": [
- "8aacaeae90c0ad6e0190c0eb75cb00c0",
- "8aac97879102cc66019102d56101000a",
- "8a8180196610ae1201663eaa18f655a4",
- "8aaac1cd83c0cd9b01843d752409472a",
- "8aac80658b231956018b2403898c04bb"
]
}
]
}| channel_id required | string Example: 000b48f0-ba80-354a-b5dd-dedca0679fb3 The channel you want to get |
| id | string |
| legacyId | string |
| state | string |
| networkType | string |
| name | string |
| overriddenName | string or null |
| connectedTime | string |
| lastConnectedAt | string |
| networkId | string |
| networkCorrelationId | string |
| networkUrl | string |
| thumbnailUrl | string |
| organizationId | string |
| followerCount | number |
object | |
object | |
| vanityDomain | string or null |
| normalizedName | string |
| healthyScopes | Array of any |
| faultyScopes | Array of any |
| scopes | Array of any |
Array of objects | |
| authorizations | any |
| tokens | Array of any |
| groups | Array of any |
| teams | Array of strings |
| indexingHash | string or null |
| permissions | Array of strings |
| role | string |
{- "id": "000b48f0-ba80-354a-b5dd-dedca0679fb3",
- "legacyId": "2075357186060123",
- "state": "DISCONNECTED",
- "networkType": "facebook",
- "name": "Happy Test Page",
- "overriddenName": null,
- "connectedTime": "2020-03-10T18:35:13.139Z",
- "lastConnectedAt": "2020-03-10T18:35:13.139Z",
- "networkId": "2085357196060968",
- "networkCorrelationId": "2085357196060968",
- "organizationId": "6352",
- "followerCount": 8,
- "customAttributes": {
- "isPublished": "true"
}, - "computedAttributes": {
- "hasSystemUserToken": "false"
}, - "vanityDomain": null,
- "normalizedName": "happy-test-page",
- "healthyScopes": [ ],
- "faultyScopes": [ ],
- "scopes": [ ],
- "organizationList": [
- {
- "context": "SMM",
- "orgId": "6352"
}
], - "authorizations": null,
- "tokens": [ ],
- "groups": [ ],
- "teams": [
- "8a81800666ed1a940166f02547781283",
- "8a8180066643d366016662a2e14d6c0c"
], - "indexingHash": null,
- "permissions": [
- "copyPost",
- "deletePost",
- "editPost",
- "read",
- "savePostAsDraft",
- "deletePostNotPublished",
- "publishPost",
- "addNote",
- "createPost",
- "editNote",
- "approvePost",
- "submitPostForApproval"
], - "role": "EDITOR"
}| name | string Example: name=test string the name should contain |
| size | number Example: size=100 items to display per call type: integer default: 0 |
| sort | string Example: sort=title,asc property to sort by: string default: title,asc |
| count | number |
| totalCount | number |
| pageSize | number |
| currentPage | number |
| totalPages | number |
Array of objects |
{- "count": 2,
- "totalCount": 2,
- "pageSize": 100,
- "currentPage": 0,
- "totalPages": 1,
- "items": [
- {
- "id": "3140b22c-6191-48ac-a1b6-e9e82919e666",
- "title": "My Brandwatch Channel Group",
- "organizationId": "6352",
- "createdAt": "2025-07-30T09:30:09.538941Z",
- "channelIds": [
- "75fa22d5-89f3-42a4-85b7-726049b1a512",
- "0493a199-0e68-4ddc-a8f0-617691525a63",
- "e45b66ee-d7b9-4a63-803a-6c33c1438dab",
- "b739e4eb-c993-4a39-8a87-e3e2162cc067",
- "a4a1eceb-b9f3-4644-b151-10512e89938f"
]
}, - {
- "id": "8aac9b58-90c5-8b1d-0190-c5d3a27f013c",
- "title": "Another Brandwatch Channel group",
- "organizationId": "6352",
- "createdAt": "2024-07-18T12:31:39.647Z",
- "channelIds": [ ]
}
]
}| group_id required | string Example: 3140b22c-6191-48ac-a1b6-e9e82919e666 The group you want to get |
| id | string |
| title | string |
| organizationId | string |
| createdAt | string |
| channelIds | Array of strings |
{- "id": "3140b22c-6191-48ac-a1b6-e9e82919e666",
- "title": "My Brandwatch Group",
- "organizationId": "6352",
- "createdAt": "2025-07-30T09:30:09.538941Z",
- "channelIds": [
- "0493a199-0e68-4ddc-a8f0-617691525a63",
- "75fa22d5-89f3-42a4-85b7-726049b1a512",
- "a4a1eceb-b9f3-4644-b151-10512e89938f",
- "b739e4eb-c993-4a39-8a87-e3e2162cc067",
- "e45b66ee-d7b9-4a63-803a-6c33c1438dab"
]
}| ids | string Example: ids=25a399f604ed4cd897e7d7704f275cc1,b0c920181 |
| since | string Example: since=2015-07-30T22:00:00.000Z date time in yyyy-MM-dd'T'HH:mm:ss.SSSZZ format |
| until | string Example: until=2015-07-31T22:00:00.000Z date time in yyyy-MM-dd'T'HH:mm:ss.SSSZZ format |
| limit | number Example: limit=10 items to display per call type: integer default: 30 |
| offset | number Example: offset=10 offset of the pagination: integer default: 0 |
| networks | string Example: networks=facebook,twitter a comma separated string of networks you wish to receive data on |
| channels | string Example: channels=465659043535667,linkedin_35901_2684372 a comma separated string of channel IDs that you wish to receive data. |
| statuses | string Example: statuses=draft,unapproved,scheduled,scheduledError,published a comma separated list of statuses |
| tags | string Example: tags=tbt,falcon,marketing a comma separated string of labels that you wish to receive data on. |
| includeHidden | boolean Example: includeHidden=false Includes hidden items, default: false |
| filterAllByDate | boolean Example: filterAllByDate=false flag to disable since/until filter. Default: false. |
| visibility | string Example: visibility=dark,page a comma separated list of visibility options. Default: dark, page. |
| promotion | string Example: promotion=promoted,notPromoted a comma separated list of visibility options. Default: all. |
| placements | string Example: placements=FEED,REEL,STORY,MESSAGE a comma separated list of placement options. Default: all. |
{- "fault": {
- "faultstring": "Invalid ApiKey",
- "detail": {
- "errorcode": "oauth.v2.InvalidApiKey"
}
}
}| publicationId required | string Example: a1b2c3d4e5f ID of a valid Publication |
Array of objects |
{- "items": [
- {
- "id": 1,
- "name": "My Label"
}
]
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid draft |
| date required | string Schedule date in the future. |
| zoneName | string Zone Id of the date. |
{- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}{- "fault": {
- "faultstring": "Invalid ApiKey",
- "detail": {
- "errorcode": "oauth.v2.InvalidApiKey"
}
}
}| publishingId required | string Example: bdf7bce4a7fb11ef8d9223440487231f Publishing ID of a valid draft |
| network required | string Enum: "facebook" "twitter" "linkedin" "instagram" "pinterest" "youtube" "tiktok" Example: facebook Videos, Facebook Albums not supported |
| channels | Array of any Deprecated, replaced by |
| channelUuids | Array of any Channel UUIDs to copy this publishing to. Channels must belong to the same network. |
| Location | string |
| id required | string New Publishing ID |
| channels | Array of any UUIDS of the channels the Publishing has been copied too (if the deprecated |
{- "channels": [
- "channel1",
- "channel2"
], - "channelUuids": [
- "af1370da-a7f9-11ef-a491-d7c9309cce5d",
- "6e8cdc8e-a7fb-11ef-b580-3f764fcadca6"
]
}{- "id": "fdd3f1e8a7fb11ef8b95c3708bec0fce",
- "channels": [
- "af1370da-a7f9-11ef-a491-d7c9309cce5d",
- "6e8cdc8e-a7fb-11ef-b580-3f764fcadca6"
]
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid draft |
| status | string Enum: "draft" "unapproved" "scheduled" "scheduledError" "published" Status of the Post |
| publicationStatuses | Array of any |
{- "status": "scheduledError",
- "publicationStatuses": [
- {
- "channelId": "channelId",
- "meta": {
- "self": {
- "href": "/publish/publications/{network}/{id}",
- "method": "GET"
}
}, - "status": "error",
- "errorType": "channelConnection",
- "error": "Please reconnect the channel"
}
]
}Resources for operations on a specific Facebook draft.
Note on Facebook Link Editing When creating or editing Facebook Links, the caption, description & picture fields found under content link in the message body are optional and in fact should be left empty if the URL specified in the link field does not belong to a domain that is claimed by the Facebook page. Publishing Facebook posts with custom link metadata when the link is not claimed by the Facebook page will result in post failure. Learn more here.
| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contains only one property at the time |
| Location | string |
{- "channels": [
- "channel1"
], - "options": {
- "dark": false,
- "geoGating": {
- "include": [
- {
- "key": "",
- "name": "",
- "type": ""
}
], - "exclude": [
- {
- "key": "",
- "name": "",
- "type": ""
}
], - "ageMin": 13
}, - "feedTargeting": {
- "relationStatuses": [
- {
- "key": "id",
- "name": "name"
}
], - "genders": [
- {
- "key": "id",
- "name": "name"
}
], - "interestedIns": [
- {
- "key": "id",
- "name": "name"
}
], - "interests": [
- {
- "key": "id",
- "name": "name"
}
], - "collegeYears": [
- {
- "key": "id",
- "name": "name"
}
], - "geoLocations": [
- {
- "key": "",
- "name": "",
- "type": ""
}
], - "educationStatuses": [
- {
- "key": "id",
- "name": "name"
}
], - "locales": [
- {
- "key": "id",
- "name": "name"
}
], - "ageRange": {
- "ageMin": 13,
- "ageMax": 65
}
}, - "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen",
- "queuedToNetwork": false
}, - "shorteningUrls": {
- "enabled": false,
- "urls": [
- {
- "channelId": "channelId",
- "url": "www.falconsocial.com",
- "enableTracking": false,
- "customId": "customId"
}
]
}, - "place": {
- "id": "1234567"
}, - "placement": "FEED"
}, - "content": {
- "text": {
- "text": ""
}, - "link": {
- "message": "content of the publishing",
- "caption": "a caption",
- "description": "a description",
- "link": "www.falconsocial.com",
- "picture": "url/to/thumbnail",
- "callToAction": {
- "type": "bookTravel"
}
}, - "links": {
- "message": "some message",
- "link": "www.falcon.io",
- "picture": "path/to/image",
- "links": [
- {
- "message": "content of the publishing",
- "caption": "a caption",
- "description": "a description",
- "link": "www.falconsocial.com",
- "picture": "url/to/thumbnail",
- "callToAction": {
- "type": "bookTravel"
}
}
]
}, - "album": {
- "albumName": "My Album",
- "albumDescription": "a description",
- "pictures": [
- {
- "description": "some text",
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg"
}
]
}, - "picture": {
- "message": "some text",
- "pictures": [
- {
- "description": "some text",
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg"
}
], - "album": {
- "id": "albumId",
- "name": "My Album"
}
}, - "video": {
- "title": "title",
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "callToAction": {
- "type": "bookTravel",
- "link": "www.falconsocial.com"
}
}
}
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid Facebook Publishing |
| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contains only one property at the time |
{- "channels": [
- "channel1"
], - "options": {
- "dark": false,
- "geoGating": {
- "include": [
- {
- "key": "",
- "name": "",
- "type": ""
}
], - "exclude": [
- {
- "key": "",
- "name": "",
- "type": ""
}
], - "ageMin": 13
}, - "feedTargeting": {
- "relationStatuses": [
- {
- "key": "id",
- "name": "name"
}
], - "genders": [
- {
- "key": "id",
- "name": "name"
}
], - "interestedIns": [
- {
- "key": "id",
- "name": "name"
}
], - "interests": [
- {
- "key": "id",
- "name": "name"
}
], - "collegeYears": [
- {
- "key": "id",
- "name": "name"
}
], - "geoLocations": [
- {
- "key": "",
- "name": "",
- "type": ""
}
], - "educationStatuses": [
- {
- "key": "id",
- "name": "name"
}
], - "locales": [
- {
- "key": "id",
- "name": "name"
}
], - "ageRange": {
- "ageMin": 13,
- "ageMax": 65
}
}, - "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen",
- "queuedToNetwork": false
}, - "shorteningUrls": {
- "enabled": false,
- "urls": [
- {
- "channelId": "channelId",
- "url": "www.falconsocial.com",
- "enableTracking": false,
- "customId": "customId"
}
]
}, - "place": {
- "id": "1234567"
}, - "placement": "FEED"
}, - "content": {
- "text": {
- "text": ""
}, - "link": {
- "message": "content of the publishing",
- "caption": "a caption",
- "description": "a description",
- "link": "www.falconsocial.com",
- "picture": "url/to/thumbnail",
- "callToAction": {
- "type": "bookTravel"
}
}, - "carousel": {
- "message": "some message",
- "link": "www.falcon.io",
- "picture": "path/to/image",
- "links": [
- {
- "message": "content of the publishing",
- "caption": "a caption",
- "description": "a description",
- "link": "www.falconsocial.com",
- "picture": "url/to/thumbnail",
- "callToAction": {
- "type": "bookTravel"
}
}
]
}, - "album": {
- "albumName": "My Album",
- "albumDescription": "a description",
- "pictures": [
- {
- "description": "some text",
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg"
}
]
}, - "picture": {
- "message": "some text",
- "pictures": [
- {
- "description": "some text",
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg"
}
], - "album": {
- "id": "albumId",
- "name": "My Album"
}
}, - "video": {
- "title": "title",
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "callToAction": {
- "type": "bookTravel",
- "link": "www.falconsocial.com"
}
}
}
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid Facebook Publishing |
| id required | string ID of the Facebook Publishing |
| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contains only one property at the time | |
object | |
object (Notes) | |
object (Copies) | |
object (PublishingLabelsMeta) | |
| status required | string Enum: "draft" "unapproved" "scheduled" "scheduledError" "published" "scheduledExternally" Publishing status. |
object (FacebookPublishingMeta) | |
object (FacebookPublishingPromotions) |
{- "id": "a1b2c3d4e5ffg",
- "channels": [
- "channel1"
], - "options": {
- "dark": false,
- "geoTargeting": {
- "regions": [
- {
- "key": "id",
- "name": "name"
}
], - "locales": [
- {
- "key": "id",
- "name": "name"
}
], - "cities": [
- {
- "key": "id",
- "name": "name"
}
], - "countries": [
- {
- "key": "id",
- "name": "name"
}
]
}, - "feedTargeting": {
- "relationStatuses": [
- {
- "key": "id",
- "name": "name"
}
], - "genders": [
- {
- "key": "id",
- "name": "name"
}
], - "interestedIns": [
- {
- "key": "id",
- "name": "name"
}
], - "interests": [
- {
- "key": "id",
- "name": "name"
}
], - "collegeYears": [
- {
- "key": "id",
- "name": "name"
}
], - "geoLocations": [
- {
- "key": "",
- "name": "",
- "type": ""
}
], - "educationStatuses": [
- {
- "key": "id",
- "name": "name"
}
], - "locales": [
- {
- "key": "id",
- "name": "name"
}
], - "ageRange": {
- "ageMin": 13,
- "ageMax": 65
}
}, - "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen",
- "queuedToNetwork": false
}, - "shorteningUrls": {
- "enabled": false,
- "urls": [
- {
- "channelId": "channelId",
- "url": "www.falconsocial.com",
- "enableTracking": false,
- "customId": "customId"
}
]
}, - "place": {
- "id": "12345",
- "name": "Falcon HQ",
- "picture": "/path/to/image",
- "location": {
- "street": "",
- "city": "",
- "state": "",
- "country": "",
- "zip": "",
- "latitude": 0,
- "longitude": 0
}
}, - "placement": "FEED"
}, - "content": {
- "text": {
- "text": ""
}, - "link": {
- "message": "content of the publishing",
- "caption": "a caption",
- "description": "a description",
- "link": "www.falconsocial.com",
- "picture": "url/to/thumbnail",
- "callToAction": {
- "type": "bookTravel"
}
}, - "links": {
- "message": "some message",
- "link": "www.falcon.io",
- "picture": "path/to/image",
- "links": [
- {
- "message": "content of the publishing",
- "caption": "a caption",
- "description": "a description",
- "link": "www.falconsocial.com",
- "picture": "url/to/thumbnail",
- "callToAction": {
- "type": "bookTravel"
}
}
]
}, - "album": {
- "albumName": "My Album",
- "albumDescription": "a description",
- "pictures": [
- {
- "description": "some text",
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg"
}
]
}, - "picture": {
- "message": "some text",
- "pictures": [
- {
- "description": "some text",
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg"
}
], - "album": {
- "id": "albumId",
- "name": "My Album"
}
}, - "video": {
- "title": "title",
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "callToAction": {
- "type": "bookTravel",
- "link": "www.falconsocial.com"
}
}
}, - "created": {
- "date": "2015-01-01T00:00:00"
}, - "notes": {
- "create": {
- "href": "/.../{id}/notes",
- "method": "POST"
}, - "self": {
- "href": "/.../{id}/notes",
- "method": "GET"
}
}, - "copies": {
- "self": {
- "href": "/publish/items/{id}/copies",
- "method": "GET"
}
}, - "labels": {
- "self": {
- "href": "/publish/publishing/{id}/labels",
- "method": "GET"
}, - "addLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "PUT"
}, - "removeLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "DELETE"
}
}, - "status": "draft",
- "meta": {
- "schedule": {
- "href": "/publish/publishing/workflows/{id}/schedule",
- "method": "POST"
}, - "unschedule": {
- "href": "/publish/publishing/{id}/unschedule",
- "method": "POST"
}, - "delete": {
- "href": "/publish/publishing/{id}",
- "method": "DELETE"
}, - "extraStatusInfo": {
- "href": "/publish/publishing/{id}/status",
- "method": "GET"
}, - "self": {
- "href": "/publish/publishing/facebook/{id}",
- "method": "GET"
}, - "update": {
- "href": "/publish/publishing/facebook/{id}",
- "method": "PUT"
}, - "copy": {
- "href": "/publish/publishing/facebook/{id}/copy",
- "method": "POST"
}
}, - "promotions": {
- "self": {
- "href": "/publish/publishing/facebook/{id}/promotions",
- "method": "GET"
}, - "create": {
- "href": "/publish/publishing/facebook/{id}/promotions",
- "method": "POST"
}
}
}| channelId required | string Example: 1234 ID of a valid channel. Necessary to serve relevant locations. |
| q required | string Example: q=Copenhagen query string |
| offset | number Example: offset=0 search offset |
| limit | number Default: 10 Example: limit=10 search limit |
| items | Array of any Array of places |
object Previous page, if applicable | |
object Next page, if applicable |
{- "items": [
- {
- "id": "12345",
- "name": "Falcon HQ",
- "picture": "/path/to/image",
- "location": {
- "street": "",
- "city": "",
- "state": "",
- "country": "",
- "zip": "",
- "latitude": 0,
- "longitude": 0
}
}
], - "previous": {
- "href": "/publish/publishing/facebook/locations?offset=&q=&limit=&apikey=",
- "method": "GET"
}, - "next": {
- "href": "/publish/publishing/facebook/locations?offset=&q=&limit=&apikey=",
- "method": "GET"
}
}| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contains only one property at the time |
| Location | string |
{- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "shorteningUrls": {
- "enabled": false
}, - "place": {
- "id": ""
}, - "placement": "FEED"
}, - "content": {
- "text": {
- "text": ""
}, - "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "userTags": [
- {
- "username": "marynkas_marsviner"
}
]
}, - "pictures": {
- "message": "",
- "pictures": [
- {
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg"
}
]
}
}
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid Twitter draft |
| channels required | Array of any Channel IDs this LinkedIn is assigned to |
required | object |
object Content can contains only one property at the time |
{- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "shorteningUrls": {
- "enabled": false
}, - "place": {
- "id": ""
}, - "placement": "FEED"
}, - "content": {
- "text": {
- "text": ""
}, - "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "userTags": [
- {
- "username": "marynkas_marsviner"
}
]
}, - "pictures": {
- "message": "",
- "pictures": [
- {
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg"
}
]
}
}
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid Twitter draft |
| id required | string ID of the Facebook LinkedIn |
| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contains only one property at the time | |
object | |
object (Notes) | |
object (Copies) | |
object (PublishingLabelsMeta) | |
| status required | string Enum: "draft" "unapproved" "scheduled" "scheduledError" "published" Publishing status. |
object (TwitterPublishingMeta) |
{- "id": "a1b2c3d4e5f",
- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "shorteningUrls": {
- "enabled": false,
- "urls": [
- {
- "channelId": "channelId",
- "url": "www.falconsocial.com",
- "enableTracking": false,
- "customId": "customId"
}
]
}, - "place": {
- "id": "12345",
- "name": "Falcon HQ",
- "type": "office",
- "location": {
- "street": "Andersen Boulevard",
- "country": "Copenhagen"
}
}, - "placement": "FEED"
}, - "content": {
- "text": {
- "text": ""
}, - "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "userTags": [
- {
- "username": "marynkas_marsviner"
}
]
}, - "pictures": {
- "message": "",
- "pictures": [
- {
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg"
}
]
}
}, - "created": {
- "date": "2015-01-01T00:00:00"
}, - "notes": {
- "create": {
- "href": "/.../{id}/notes",
- "method": "POST"
}, - "self": {
- "href": "/.../{id}/notes",
- "method": "GET"
}
}, - "copies": {
- "self": {
- "href": "/publish/items/{id}/copies",
- "method": "GET"
}
}, - "labels": {
- "self": {
- "href": "/publish/publishing/{id}/labels",
- "method": "GET"
}, - "addLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "PUT"
}, - "removeLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "DELETE"
}
}, - "status": "draft",
- "meta": {
- "schedule": {
- "href": "/publish/publishing/workflows/{id}/schedule",
- "method": "POST"
}, - "unschedule": {
- "href": "/publish/publishing/{id}/unschedule",
- "method": "POST"
}, - "delete": {
- "href": "/publish/publishing/{id}",
- "method": "DELETE"
}, - "extraStatusInfo": {
- "href": "/publish/publishing/{id}/status",
- "method": "GET"
}, - "self": {
- "href": "/publish/publishing/twitter/{id}",
- "method": "GET"
}, - "update": {
- "href": "/publish/publishing/twitter/{id}",
- "method": "PUT"
}, - "copy": {
- "href": "/publish/publishing/twitter/{id}/copy",
- "method": "POST"
}
}
}| channelId required | string Example: 12345 Valid ID of the twitter channel. Necessary to make the returned payload to be contextual to the user. |
| q required | string Example: q=Falcon query string |
| limit | number Default: 10 Example: limit=10 search limit |
| items | Array of any |
{- "items": [
- {
- "id": "12345",
- "name": "Falcon HQ",
- "type": "office",
- "location": {
- "street": "Andersen Boulevard",
- "country": "Copenhagen"
}
}
]
}| channels required | Array of any Channel IDs this publishing is assigned to. Limitation: max 1. |
required | object |
object Content can contains only one property at the time |
| Location | string |
{- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen",
- "queuedToNetwork": false
}, - "shorteningUrls": {
- "enabled": false,
- "urls": [
- {
- "channelId": "channelId",
- "url": "www.falconsocial.com",
- "enableTracking": false,
- "customId": "customId"
}
]
}, - "publisher": {
- "id": "123io1uy29367897"
}, - "place": {
- "id": "1234567"
}, - "firstComment": "Hello, World!",
- "placement": "FEED",
- "shareToFeed": true,
- "audioName": "unoriginal music",
- "collaboratorTags": [
- {
- "username": "marynkas_marsviner"
}
]
}, - "content": {
- "picture": {
- "message": "some text",
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg",
- "userTags": [
- {
- "username": "marynkas_marsviner",
- "x": 0.5,
- "y": 0.8
}
]
}, - "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "userTags": [
- {
- "username": "marynkas_marsviner"
}
]
}, - "carousel": {
- "message": "some text",
- "medias": [
- {
- "@type": "picture",
- "url": "/path/to/image",
- "originalPicture": "path/to/image",
- "fileName": "image.jpg",
- "thumbnailFrameMillisec": 2000
}
]
}
}
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid Instagram Draft |
| channels required | Array of any Channel IDs this publishing is assigned to. Limitation: max 1. |
required | object |
object Content can contains only one property at the time |
{- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen",
- "queuedToNetwork": false
}, - "shorteningUrls": {
- "enabled": false,
- "urls": [
- {
- "channelId": "channelId",
- "url": "www.falconsocial.com",
- "enableTracking": false,
- "customId": "customId"
}
]
}, - "publisher": {
- "id": "123io1uy29367897"
}, - "place": {
- "id": "1234567"
}, - "firstComment": "Hello, World!",
- "placement": "FEED",
- "shareToFeed": true,
- "audioName": "unoriginal music",
- "collaboratorTags": [
- {
- "username": "marynkas_marsviner"
}
]
}, - "content": {
- "picture": {
- "message": "some text",
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg",
- "userTags": [
- {
- "username": "marynkas_marsviner",
- "x": 0.5,
- "y": 0.8
}
]
}, - "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "userTags": [
- {
- "username": "marynkas_marsviner"
}
]
}, - "carousel": {
- "message": "some text",
- "medias": [
- {
- "@type": "picture",
- "url": "/path/to/image",
- "originalPicture": "path/to/image",
- "fileName": "image.jpg",
- "thumbnailFrameMillisec": 2000
}
]
}
}
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid Instagram Draft |
| id required | string ID of the Instagram Publishing |
| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contains only one property at the time | |
object | |
object (Notes) | |
object (Copies) | |
object (PublishingLabelsMeta) | |
| status required | string Enum: "draft" "unapproved" "scheduled" "scheduledError" "published" Publishing status. |
object (InstagramPublishingMeta) |
{- "id": "a1b2c3d4e5ffg",
- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen",
- "queuedToNetwork": false
}, - "shorteningUrls": {
- "enabled": false,
- "urls": [
- {
- "channelId": "channelId",
- "url": "www.falconsocial.com",
- "enableTracking": false,
- "customId": "customId"
}
]
}, - "publisher": {
- "id": "123io1uy29367897"
}, - "place": {
- "id": "12345",
- "name": "Falcon HQ",
- "picture": "/path/to/image",
- "location": {
- "street": "",
- "city": "",
- "state": "",
- "country": "",
- "zip": "",
- "latitude": 0,
- "longitude": 0
}
}, - "firstComment": "Hello, World!",
- "placement": "FEED",
- "shareToFeed": true,
- "audioName": "unoriginal music",
- "collaboratorTags": [
- {
- "username": "marynkas_marsviner"
}
]
}, - "content": {
- "picture": {
- "message": "some text",
- "url": "absolute/url/to/image",
- "originalPicture": "absolute/url/to/image",
- "fileName": "file.jpg",
- "userTags": [
- {
- "username": "marynkas_marsviner",
- "x": 0.5,
- "y": 0.8
}
]
}, - "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "userTags": [
- {
- "username": "marynkas_marsviner"
}
]
}, - "carousel": {
- "message": "some text",
- "medias": [
- {
- "@type": "picture",
- "url": "/path/to/image",
- "originalPicture": "path/to/image",
- "fileName": "image.jpg",
- "thumbnailFrameMillisec": 2000
}
]
}
}, - "created": {
- "date": "2015-01-01T00:00:00"
}, - "notes": {
- "create": {
- "href": "/.../{id}/notes",
- "method": "POST"
}, - "self": {
- "href": "/.../{id}/notes",
- "method": "GET"
}
}, - "copies": {
- "self": {
- "href": "/publish/items/{id}/copies",
- "method": "GET"
}
}, - "labels": {
- "self": {
- "href": "/publish/publishing/{id}/labels",
- "method": "GET"
}, - "addLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "PUT"
}, - "removeLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "DELETE"
}
}, - "status": "draft",
- "meta": {
- "schedule": {
- "href": "/publish/publishing/workflows/{id}/schedule",
- "method": "POST"
}, - "unschedule": {
- "href": "/publish/publishing/{id}/unschedule",
- "method": "POST"
}, - "delete": {
- "href": "/publish/publishing/{id}",
- "method": "DELETE"
}, - "extraStatusInfo": {
- "href": "/publish/publishing/{id}/status",
- "method": "GET"
}, - "self": {
- "href": "/publish/publishing/instagram/{id}",
- "method": "GET"
}, - "update": {
- "href": "/publish/publishing/instagram/{id}",
- "method": "PUT"
}, - "copy": {
- "href": "/publish/publishing/instagram/{id}/copy",
- "method": "POST"
}
}
}| channelId required | string Example: 1234 ID of a valid channel. Necessary to serve relevant locations. |
| q required | string Example: q=Copenhagen query string |
| offset | number Example: offset=0 search offset |
| limit | number Default: 10 Example: limit=10 search limit |
| items | Array of any Array of places |
object Previous page, if applicable | |
object Next page, if applicable |
{- "items": [
- {
- "id": "12345",
- "name": "Falcon HQ",
- "picture": "/path/to/image",
- "location": {
- "street": "",
- "city": "",
- "state": "",
- "country": "",
- "zip": "",
- "latitude": 0,
- "longitude": 0
}
}
], - "previous": {
- "href": "/publish/publishing/facebook/locations?offset=&q=&limit=&apikey=",
- "method": "GET"
}, - "next": {
- "href": "/publish/publishing/facebook/locations?offset=&q=&limit=&apikey=",
- "method": "GET"
}
}| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contains only one property at the time |
| Location | string |
{- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "targeting": {
- "industries": [
- "urn:li:industry_1"
], - "interfaceLocates": [
- {
- "language": "da",
- "country": "DK"
}
], - "jobFunctions": [
- "urn:li:function:job_2"
], - "geoLocations": [
- {
- "entity": "urn:li:geo:90000091"
}
], - "seniorities": [
- "urn:li:seniority:4"
], - "staffCountRanges": [
- ""
], - "degrees": [
- "urn:li:degree:258"
], - "fieldsOfStudy": [
- "urn:li:fieldOf:Study:100203"
], - "schools": [
- "urn:li:organization:1353655"
]
}, - "visibility": "anyone",
- "shorteningUrls": {
- "enabled": false
}, - "placement": "FEED"
}, - "content": {
- "text": {
- "text": ""
}, - "link": {
- "message": "content of the publishing",
- "caption": "a caption",
- "description": "a description",
- "link": "www.falconsocial.com",
- "picture": "url/to/thumbnail"
}, - "picture": {
- "message": "`some text",
- "pictures": [
- {
- "description": "text",
- "originalPicture": "https:/absolute.url/to/image",
- "fileName": "file.jpg"
}
], - "fileName": "file.jpg"
}, - "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "title": "some text"
}, - "document": {
- "message": "`some text",
- "title": "`some text",
- "fileName": "file.pdf"
}, - "poll": {
- "message": "some text",
- "question": "some text",
- "options": [
- {
- "text": "some text"
}
], - "settings": {
- "duration": "ONE_DAY"
}
}
}
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid LinkedIn draft |
| channels required | Array of any Channel IDs this LinkedIn is assigned to |
required | object |
object Content can contains only one property at the time |
{- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "targeting": {
- "industries": [
- "urn:li:industry_1"
], - "interfaceLocates": [
- {
- "language": "da",
- "country": "DK"
}
], - "jobFunctions": [
- "urn:li:function:job_2"
], - "geoLocations": [
- {
- "entity": "urn:li:geo:90000091"
}
], - "seniorities": [
- "urn:li:seniority:4"
], - "staffCountRanges": [
- ""
], - "degrees": [
- "urn:li:degree:258"
], - "fieldsOfStudy": [
- "urn:li:fieldOf:Study:100203"
], - "schools": [
- "urn:li:organization:1353655"
]
}, - "visibility": "anyone",
- "shorteningUrls": {
- "enabled": false
}, - "placement": "FEED"
}, - "content": {
- "text": {
- "text": ""
}, - "link": {
- "message": "content of the publishing",
- "caption": "a caption",
- "description": "a description",
- "link": "www.falconsocial.com",
- "picture": "url/to/thumbnail"
}, - "picture": {
- "message": "`some text",
- "pictures": [
- {
- "description": "text",
- "originalPicture": "https:/absolute.url/to/image",
- "fileName": "file.jpg"
}
], - "fileName": "file.jpg"
}, - "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "title": "some text"
}, - "document": {
- "message": "`some text",
- "title": "`some text",
- "fileName": "file.pdf"
}, - "poll": {
- "message": "some text",
- "question": "some text",
- "options": [
- {
- "text": "some text"
}
], - "settings": {
- "duration": "ONE_DAY"
}
}
}
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid LinkedIn draft |
| id required | string ID of the LinkedIn draft. |
| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contain only one property at the time | |
object | |
object (Notes) | |
object (Copies) | |
object (PublishingLabelsMeta) | |
| status required | string Enum: "draft" "unapproved" "scheduled" "scheduledError" "published" Publishing status. |
object (LinkedInPublishingMeta) |
{- "id": "a1b2c3d4e5f",
- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "targeting": {
- "industries": [
- "urn:li:industry_1"
], - "interfaceLocates": [
- {
- "language": "da",
- "country": "DK"
}
], - "jobFunctions": [
- "urn:li:function:job_2"
], - "geoLocations": [
- {
- "entity": "urn:li:geo:90000091"
}
], - "seniorities": [
- "urn:li:seniority:4"
], - "staffCountRanges": [
- ""
], - "degrees": [
- "urn:li:degree:258"
], - "fieldsOfStudy": [
- "urn:li:fieldOf:Study:100203"
], - "schools": [
- "urn:li:organization:1353655"
]
}, - "visibility": "anyone",
- "shorteningUrls": {
- "enabled": false,
- "urls": [
- {
- "channelId": "channelId",
- "url": "www.falconsocial.com",
- "enableTracking": false,
- "customId": "customId"
}
]
}, - "placement": "FEED"
}, - "content": {
- "text": {
- "text": ""
}, - "link": {
- "message": "content of the publishing",
- "caption": "a caption",
- "description": "a description",
- "link": "www.falconsocial.com",
- "picture": "url/to/thumbnail"
}, - "picture": {
- "message": "`some text",
- "pictures": [
- {
- "description": "text",
- "originalPicture": "https:/absolute.url/to/image",
- "fileName": "file.jpg"
}
], - "fileName": "file.jpg"
}, - "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "title": "some text"
}, - "document": {
- "message": "`some text",
- "title": "`some text",
- "fileName": "file.pdf"
}, - "poll": {
- "message": "some text",
- "question": "some text",
- "options": [
- {
- "text": "some text"
}
], - "settings": {
- "duration": "ONE_DAY"
}
}
}, - "created": {
- "date": "2015-01-01T00:00:00"
}, - "notes": {
- "create": {
- "href": "/.../{id}/notes",
- "method": "POST"
}, - "self": {
- "href": "/.../{id}/notes",
- "method": "GET"
}
}, - "copies": {
- "self": {
- "href": "/publish/items/{id}/copies",
- "method": "GET"
}
}, - "labels": {
- "self": {
- "href": "/publish/publishing/{id}/labels",
- "method": "GET"
}, - "addLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "PUT"
}, - "removeLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "DELETE"
}
}, - "status": "draft",
- "meta": {
- "schedule": {
- "href": "/publish/publishing/workflows/{id}/schedule",
- "method": "POST"
}, - "unschedule": {
- "href": "/publish/publishing/{id}/unschedule",
- "method": "POST"
}, - "delete": {
- "href": "/publish/publishing/{id}",
- "method": "DELETE"
}, - "extraStatusInfo": {
- "href": "/publish/publishing/{id}/status",
- "method": "GET"
}, - "self": {
- "href": "/publish/publishing/linkedin/{id}",
- "method": "GET"
}, - "update": {
- "href": "/publish/publishing/linkedin/{id}",
- "method": "PUT"
}, - "copy": {
- "href": "/publish/publishing/linkedin/{id}/copy",
- "method": "POST"
}
}
}| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contains only one property at the time |
| Location | string |
{- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "shorteningUrls": {
- "enabled": false
}, - "disableDuet": false,
- "disableStitch": false,
- "disableComment": false,
- "placement": "FEED"
}, - "content": {
- "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "embedUrl": "absolute/url/to/embeddable",
- "thumbnailFrameMillisec": 8000
}
}
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid TikTok draft |
| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contains only one property at the time |
| id required | string ID of the TikTok draft. |
| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contains only one property at the time |
{- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "shorteningUrls": {
- "enabled": false
}, - "disableDuet": false,
- "disableStitch": false,
- "disableComment": false,
- "placement": "FEED"
}, - "content": {
- "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "embedUrl": "absolute/url/to/embeddable",
- "thumbnailFrameMillisec": 8000
}
}
}{- "id": "a1b2c3d4e5f",
- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "shorteningUrls": {
- "enabled": false
}, - "disableDuet": false,
- "disableStitch": false,
- "disableComment": false,
- "placement": "FEED"
}, - "content": {
- "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "embedUrl": "absolute/url/to/embeddable",
- "thumbnailFrameMillisec": 8000
}
}
}| publishingId required | string Example: a1b2c3d4e5f Publishing ID of a valid TikTok draft |
| id required | string ID of the TikTok draft. |
| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content can contain only one property at the time | |
| status required | string Enum: "draft" "unapproved" "scheduled" "scheduledError" "published" Publishing status. |
object | |
object (Notes) | |
object (Copies) | |
object (PublishingLabelsMeta) | |
object (TikTokPublishingMeta) |
{- "id": "a1b2c3d4e5f",
- "channels": [
- "channel1"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "shorteningUrls": {
- "enabled": false
}, - "disableDuet": false,
- "disableStitch": false,
- "disableComment": false,
- "placement": "FEED"
}, - "content": {
- "video": {
- "message": "some text",
- "url": "absolute/url/to/video",
- "fileName": "file.mp4",
- "thumbnail": "absolute/url/to/thumbnail",
- "embedUrl": "absolute/url/to/embeddable",
- "thumbnailFrameMillisec": 8000
}
}, - "status": "draft",
- "created": {
- "date": "2015-01-01T00:00:00",
- "by": "347834738473"
}, - "notes": {
- "create": {
- "href": "/.../{id}/notes",
- "method": "POST"
}, - "self": {
- "href": "/.../{id}/notes",
- "method": "GET"
}
}, - "copies": {
- "self": {
- "href": "/publish/items/{id}/copies",
- "method": "GET"
}
}, - "labels": {
- "self": {
- "href": "/publish/publishing/{id}/labels",
- "method": "GET"
}, - "addLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "PUT"
}, - "removeLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "DELETE"
}
}, - "meta": {
- "schedule": {
- "href": "/publish/publishing/workflows/{id}/schedule",
- "method": "POST"
}, - "unschedule": {
- "href": "/publish/publishing/{id}/unschedule",
- "method": "POST"
}, - "delete": {
- "href": "/publish/publishing/{id}",
- "method": "DELETE"
}, - "extraStatusInfo": {
- "href": "/publish/publishing/{id}/status",
- "method": "GET"
}, - "self": {
- "href": "/publish/publishing/tiktok/{id}",
- "method": "GET"
}, - "update": {
- "href": "/publish/publishing/tiktok/{id}",
- "method": "PUT"
}, - "copy": {
- "href": "/publish/publishing/tiktok/{id}/copy",
- "method": "POST"
}
}
}| channels required | Array of any Channel UUIDs this publishing is assigned to |
required | object |
object Content must contain exactly one property of either |
| Location | string |
{- "channels": [
- "af1370da-a7f9-11ef-a491-d7c9309cce5d"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "boardId": "572942369493",
- "boardSectionId": "8946798234",
- "placement": "FEED"
}, - "content": {
- "picture": {
- "title": "Title",
- "description": "Description",
- "fileName": "image.jpg",
- "altText": "Alternative"
}, - "video": {
- "title": "Title",
- "description": "Description",
- "fileName": "video.mp4",
- "altText": "Alternative"
}, - "carousel": {
- "title": "Title",
- "description": "Description",
- "media": [
- {
- "title": "Title",
- "description": "Description",
- "fileName": "image.jpg",
}
], - "altText": "Alternative"
}
}
}| id required | string Example: 90fd0acca81011efabfc3ff335174a64 Publishing ID of a valid Pinterest draft |
| channels required | Array of any Channel UUIDs this publishing is assigned to |
required | object |
object Content must contain exactly one property of either |
{- "channels": [
- "af1370da-a7f9-11ef-a491-d7c9309cce5d"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "boardId": "572942369493",
- "boardSectionId": "8946798234",
- "placement": "FEED"
}, - "content": {
- "picture": {
- "title": "Title",
- "description": "Description",
- "fileName": "image.jpg",
- "altText": "Alternative"
}, - "video": {
- "title": "Title",
- "description": "Description",
- "fileName": "video.mp4",
- "altText": "Alternative"
}, - "carousel": {
- "title": "Title",
- "description": "Description",
- "media": [
- {
- "title": "Title",
- "description": "Description",
- "fileName": "image.jpg",
}
], - "altText": "Alternative"
}
}
}| id required | string Example: 90fd0acca81011efabfc3ff335174a64 Publishing ID of a valid Pinterest draft |
| id required | string Id of the Pinterest draft |
| channels required | Array of any Channel UUIDs this publishing is assigned to |
required | object |
object Content contains exactly one property of either | |
| status required | string Enum: "draft" "unapproved" "scheduled" "scheduledError" "published" Publishing status. |
object | |
object (Notes) | |
object (Copies) | |
object (PublishingLabelsMeta) | |
object (PinterestPublishingMeta) |
{- "id": "90fd0acca81011efabfc3ff335174a64",
- "channels": [
- "af1370da-a7f9-11ef-a491-d7c9309cce5d"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "boardId": "572942369493",
- "boardSectionId": "8946798234",
- "placement": "FEED"
}, - "content": {
- "picture": {
- "title": "Title",
- "description": "Description",
- "fileName": "image.jpg",
- "altText": "Alternative"
}, - "video": {
- "title": "Title",
- "description": "Description",
- "fileName": "video.mp4",
- "altText": "Alternative"
}, - "carousel": {
- "title": "Title",
- "description": "Description",
- "media": [
- {
- "title": "Title",
- "description": "Description",
- "fileName": "image.jpg",
}
], - "altText": "Alternative"
}
}, - "status": "draft",
- "created": {
- "date": "2024-11-21T00:00:00",
- "by": "265a3698a81711ef9c824fc1caa32f14"
}, - "notes": {
- "create": {
- "href": "/.../{id}/notes",
- "method": "POST"
}, - "self": {
- "href": "/.../{id}/notes",
- "method": "GET"
}
}, - "copies": {
- "self": {
- "href": "/publish/items/{id}/copies",
- "method": "GET"
}
}, - "labels": {
- "self": {
- "href": "/publish/publishing/{id}/labels",
- "method": "GET"
}, - "addLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "PUT"
}, - "removeLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "DELETE"
}
}, - "meta": {
- "schedule": {
- "href": "/publish/publishing/workflows/{id}/schedule",
- "method": "POST"
}, - "unschedule": {
- "href": "/publish/publishing/{id}/unschedule",
- "method": "POST"
}, - "delete": {
- "href": "/publish/publishing/{id}",
- "method": "DELETE"
}, - "extraStatusInfo": {
- "href": "/publish/publishing/{id}/status",
- "method": "GET"
}, - "self": {
- "href": "/publish/publishing/pinterest/{id}",
- "method": "GET"
}, - "update": {
- "href": "/publish/publishing/pinterest/{id}",
- "method": "PUT"
}, - "copy": {
- "href": "/publish/publishing/pinterest/{id}/copy",
- "method": "POST"
}
}
}| channelUuid required | string Example: af1370da-a7f9-11ef-a491-d7c9309cce5d UUID of a Pinterest channel |
| items | Array of any array of boards |
{- "items": [
- {
- "id": "572942369493",
- "name": "Board name",
- "description": "Board description",
- "privacyLevel": "PUBLIC"
}
]
}| channelUuid required | string Example: af1370da-a7f9-11ef-a491-d7c9309cce5d UUID of a Pinterest channel |
| boardId required | string Example: 572942369493 ID of a Pinterest board |
| items | Array of any array of board sections |
{- "items": [
- {
- "id": "6790287934",
- "name": "Board section name"
}
]
}| channels required | Array of any Channel UUIDs this publishing is assigned to |
required | object |
object Content contains exactly one property of |
| Location | string |
{- "channels": [
- "af1370da-a7f9-11ef-a491-d7c9309cce5d"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "tags": [ ],
- "playlistIds": [ ],
- "privacyStatus": "PRIVATE",
- "placement": "FEED"
}, - "content": {
- "video": {
- "title": "Title",
- "description": "Description",
- "fileName": "video.mp4",
- "captions": {
- "tracks": [
- {
- "locale": "en_GB",
- "name": "Descriptive name",
}
]
}
}
}
}| id required | string Example: 90fd0acca81011efabfc3ff335174a64 Publishing ID of a valid YouTube draft |
| channels required | Array of any Channel UUIDs this publishing is assigned to |
required | object |
object Content contains exactly one property of |
{- "channels": [
- "af1370da-a7f9-11ef-a491-d7c9309cce5d"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "tags": [ ],
- "playlistIds": [ ],
- "privacyStatus": "PRIVATE",
- "placement": "FEED"
}, - "content": {
- "video": {
- "title": "Title",
- "description": "Description",
- "fileName": "video.mp4",
- "captions": {
- "tracks": [
- {
- "locale": "en_GB",
- "name": "Descriptive name",
}
]
}
}
}
}| id required | string Example: 90fd0acca81011efabfc3ff335174a64 Publishing ID of a valid YouTube draft |
| id required | string Id of the YouTube draft |
| channels required | Array of any Channel IDs this publishing is assigned to |
required | object |
object Content contains exactly one property of | |
| status required | string Enum: "draft" "unapproved" "scheduled" "scheduledError" "published" Publishing status. |
object | |
object (Notes) | |
object (Copies) | |
object (PublishingLabelsMeta) | |
object (YoutubePublishingMeta) |
{- "id": "90fd0acca81011efabfc3ff335174a64",
- "channels": [
- "youtube_42_UCVGwD-qAF8MPI1-uHfH_8XY"
], - "options": {
- "schedule": {
- "date": "2018-01-01T00:00:00Z",
- "zoneName": "Europe/Copenhagen"
}, - "tags": [ ],
- "playlistIds": [ ],
- "privacyStatus": "PRIVATE",
- "placement": "FEED"
}, - "content": {
- "video": {
- "title": "Title",
- "description": "Description",
- "fileName": "video.mp4",
- "captions": {
- "tracks": [
- {
- "locale": "en_GB",
- "name": "Descriptive name",
}
]
}
}
}, - "status": "draft",
- "created": {
- "date": "2024-11-21T00:00:00",
- "by": "265a3698a81711ef9c824fc1caa32f14"
}, - "notes": {
- "create": {
- "href": "/.../{id}/notes",
- "method": "POST"
}, - "self": {
- "href": "/.../{id}/notes",
- "method": "GET"
}
}, - "copies": {
- "self": {
- "href": "/publish/items/{id}/copies",
- "method": "GET"
}
}, - "labels": {
- "self": {
- "href": "/publish/publishing/{id}/labels",
- "method": "GET"
}, - "addLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "PUT"
}, - "removeLabel": {
- "href": "/publish/publishing/{id}/labels/{labelId}",
- "method": "DELETE"
}
}, - "meta": {
- "schedule": {
- "href": "/publish/publishing/workflows/{id}/schedule",
- "method": "POST"
}, - "unschedule": {
- "href": "/publish/publishing/{id}/unschedule",
- "method": "POST"
}, - "delete": {
- "href": "/publish/publishing/{id}",
- "method": "DELETE"
}, - "extraStatusInfo": {
- "href": "/publish/publishing/{id}/status",
- "method": "GET"
}, - "self": {
- "href": "/publish/publishing/youtube/{id}",
- "method": "GET"
}, - "update": {
- "href": "/publish/publishing/youtube/{id}",
- "method": "PUT"
}, - "copy": {
- "href": "/publish/publishing/youtube/{id}/copy",
- "method": "POST"
}
}
}| channelUuid required | string Example: af1370da-a7f9-11ef-a491-d7c9309cce5d UUID of a YouTube channel |
| limit | number Example: limit=25 maximum number of items returned |
| items | Array of any array of playlists |
object | |
object |
{- "items": [
- {
- "id": "2342523423523",
- "itemCount": 42,
- "title": "'Title'",
- "description": "description",
- "privacyStatus": "PRIVATE"
}
], - "previous": {
- "method": "GET",
- "href": "/publish/youtube/{channelUuid}'/playlists?previous=token"
}, - "next": {
- "method": "GET",
- "href": "/publish/youtube/{channelUuid}'/playlists?next=token"
}
}| contentId required | string Example: d8b639b1-3021-48a6-b55c-c8d2a5745d90 UUID of the Link In Bio page |
| apiKey | string Example: apiKey=76ysaduhdsa9a API key provided by Brandwatch |
| channelUUIDs | string Example: channelUUIDs=d8b639b1-3021-48a6-b55c-c8d2a5745d90 List of channel UUIDs to get the links for |
| items | Array of any |
{
}| pageId required | string Example: d8b639b1-3021-48a6-b55c-c8d2a5745d90 UUID of the Link In Bio page |
| channelUUID required | string Example: d8b639b1-3021-48a6-b55c-c8d2a5745d90 UUID of the channel the link should appear on |
| apiKey | string Example: apiKey=76ysaduhdsa9a API key provided by Brandwatch |
| contentId | string UUID of the post to associate the link with |
| url | string URL that is used as the link |
| contentType | string Enum: "PUBLISHED" "DRAFT" Status of the post |
{- "contentId": "d8b639b1-3021-48a6-b55c-c8d2a5745d90",
- "contentType": "DRAFT"
}| pageId required | string Example: d8b639b1-3021-48a6-b55c-c8d2a5745d90 UUID of the Link In Bio page |
| channelUUID required | string Example: d8b639b1-3021-48a6-b55c-c8d2a5745d90 UUID of the channel the link should appear on |
| contentId required | string Example: d8b639b1-3021-48a6-b55c-c8d2a5745d90 UUID of the post the link being removed is associated with |
| apiKey | string Example: apiKey=76ysaduhdsa9a API key provided by Brandwatch |
| targetUrl | string media-management/ (required, string) - URL resource to place behind Short URL |
| domain required | string Domain to use when creating the Short URL |
| path | string Optional key to use as path element for the Short URL |
| targetUrl | string media-management/ (string) - URL resource to place behind Short URL |
| shortUrl | string Newly created Short URL |
{- "domain": "brnw.ch",
- "path": "abcd"
}{- "shortUrl": "brnw.ch/abcd"
}Resources for operations on Campaigns.
Terminology:
Campaign is the overall entity that connects 1+ Collaboration Groups (or Teams) to a list of Resources (or Attachments).
A Campaign can have Reminders, sent my email to specific Collaboration group members
A Resource can be attached to 1+ Campaigns and in the current iteration is always a Stock
Stock Ids & Resource/Attachments Ids are not the same.
To add/remove reminders, use the Update Campaign endpoint.
| notify | boolean Example: notify=false Notify collaborators that a new Campaign was created. |
| applyLabels | boolean Example: applyLabels=false Apply Campaign labels to all attached stocks. |
| timezoneid | string Example: Europe/Copenhagen e.g. Europe/Copenhagen |
| Location | string Example: /publish/campaigns/{id} e.g. /publish/campaigns/{id} |
| title required | string Campaign title |
| description A description | string |
| color required | number Enum: 0 1 2 3 4 5 Color |
| labels | Array of any |
| collaborationGroups required | Array of any At least 1 team id. Use Team API to retrieve team ids |
| startDate required | string The start date of query in ISO-8601 date format. |
| endDate required | string The end date of query in ISO-8601 date format. |
| timezoneId | |
| reminders required | Array of any |
| attachments | Array of any |
| timezoneid | string |
| Location | string |
{- "title": "A title",
- "color": 0,
- "labels": [
- "label1",
- "label2"
], - "collaborationGroups": [
- "abcdef1234"
], - "startDate": "2017-01-30T22:00:00.000Z",
- "endDate": "2017-02-30T22:00:00.000Z",
- "timezoneId": "Europe/Copenhagen",
- "reminders": [
- {
- "collaborator": "abc123",
- "offset": "1",
- "timeUnit": "days",
- "at": "12:00:00"
}
], - "attachments": [
- {
- "id": "abc123",
- "type": "type"
}
]
}{- "status": 500,
- "message": "Bad request",
- "errorMessage": "Message for end-user",
- "errorCode": "500"
}| since | string Example: since=2017-01-30T22:00:00.000Z |
| until | string Example: until=2017-02-31T22:00:00.000Z |
| labels | string Example: labels=tag1,tag2 Comma separated list of labels. |
| collaborationgroups | string Example: collaborationgroups=collaborator permissions Comma separated list of collaboration groups |
| limit | integer Example: limit=5 number of notes to retrieve, default: 5 |
| offset | integer Example: offset=0 offset of the pagination, default: 0 |
| campaignId required | string Example: abc123 Campaign ID |
| orgId | number |
| id | string |
| title | string |
| description | string |
| color | string |
| labels | Array of strings |
| collaborationGroups | Array of strings |
| startDate | string |
| endDate | string |
| timezoneId | string |
Array of objects | |
Array of objects | |
object |
{- "orgId": 42,
- "id": "",
- "title": "",
- "description": "",
- "color": "",
- "labels": [
- ""
], - "collaborationGroups": [
- ""
], - "startDate": "",
- "endDate": "",
- "timezoneId": "",
- "reminders": [
- {
- "collaborator": "",
- "offset": 1,
- "timeUnit": "",
- "at": ""
}
], - "attachments": [
- {
- "id": "",
- "type": "",
- "meta": {
- "resource": {
- "href": "/content-pool/stocks/{stockId}",
- "method": "GET"
}, - "remove": {
- "href": "/publish/campaigns/{campaignId}/attachments/{id}",
- "method": "DELETE"
}
}
}
], - "meta": {
- "self": {
- "href": "/publish/campaigns/{id}",
- "method": "GET"
}, - "getStocks": {
- "href": "publish/content-pool/search",
- "method": "POST"
}, - "update": {
- "href": "/publish/campaigns/{id}",
- "method": "PUT"
}, - "delete": {
- "href": "/publish/campaigns/{id}",
- "method": "DELETE"
}
}
}| campaignId required | string Example: abc123 Campaign ID |
| notify | boolean Example: notify=false Notify collaborators that a new Campaign was created. |
| applyLabels | boolean Example: applyLabels=false Apply Campaign labels to all attached stocks. |
| timezoneid | string Example: Europe/Copenhagen e.g. Europe/Copenhagen |
| Location | string Example: /publish/campaigns/{id} e.g. /publish/campaigns/{id} |
| title required | string Campaign title |
| description A description | string |
| color required | number Enum: 0 1 2 3 4 5 Color |
| labels | Array of any |
| collaborationGroups required | Array of any At least 1 team id. Use Team API to retrieve team ids |
| startDate required | string The start date of query in ISO-8601 date format. |
| endDate required | string The end date of query in ISO-8601 date format. |
| timezoneId | |
| reminders required | Array of any |
| attachments | Array of any |
| timezoneid | string |
| Location | string |
| title required | string Campaign title |
| description A description | string |
| color required | number Enum: 0 1 2 3 4 5 Color |
| labels | Array of any |
| collaborationGroups required | Array of any At least 1 team id. Use Team API to retrieve team ids |
| startDate required | string The start date of query in ISO-8601 date format. |
| endDate required | string The end date of query in ISO-8601 date format. |
| timezoneId | |
| reminders required | Array of any |
| attachments | Array of any |
{- "title": "A title",
- "description A description": "string",
- "color": 0,
- "labels": [
- null
], - "collaborationGroups": [
- null
], - "startDate": "2017-01-30T22:00:00.000Z",
- "endDate": "2017-02-30T22:00:00.000Z",
- "timezoneId": "Europe/Copenhagen",
- "reminders": [
- null
], - "attachments": [
- null
]
}{- "title": "A title",
- "color": 0,
- "labels": [
- "label1",
- "lable2"
], - "collaborationGroups": [
- "abcdef1234"
], - "startDate": "2017-01-30T22:00:00.000Z",
- "endDate": "2017-02-30T22:00:00.000Z",
- "timezoneId": "Europe/Copenhagen",
- "reminders": [
- {
- "collaborator": "abc123",
- "offset": "1",
- "timeUnit": "days",
- "at": "12:00:00"
}
], - "attachments": [
- {
- "id": "abc123",
- "type": "type"
}
]
}| ids | string Example: ids=abc123,def456 Comma separated list of resource ids |
| resourceId | string |
Array of objects |
[- {
- "resourceId": "",
- "items": [
- {
- "orgId": 42,
- "id": "",
- "title": "",
- "labels": [
- ""
], - "collaborationGroups": [
- ""
], - "startDate": "2015-06-30T22:00:00.000Z",
- "endDate": "2015-06-30T22:00:00.000Z",
- "timezoneId": "Europe/Berlin",
- "meta": {
- "self": {
- "href": "/publish/campaigns/{id}",
- "method": "GET"
}, - "getStocks": {
- "href": "/publish/content-pool/search",
- "method": "POST"
}, - "update": {
- "href": "/publish/campaigns/{id}",
- "method": "PUT"
}, - "delete": {
- "href": "/publish/campaigns/{id}",
- "method": "DELETE"
}
}
}
]
}
]| campaignId required | string Example: abc123 Campaign ID |
| stockId required | string Example: def456 Stock ID |
| notify | boolean Example: notify=false Notify collaborators that a new Campaign was created. |
| applyLabels | boolean Example: applyLabels=false Apply Campaign labels to all attached stocks. |
Brandwatch’s Content Pool is a container of Stocks. Stocks can contain multiple assets (text, link, media or captions) accessible to all users in the org. Stocks can be copied to create social posts. Read more about Falcon's Content Pool here
| ids | string Example: ids=123123,567567,1232432 Searches for Stocks having the given ids. This filter |
| stockValidSince | string Example: stockValidSince=2020-12-01T00:00:00Z Search for Stocks that are not expired/embargoed in the given time range (since) |
| stockValidUntil | string Example: stockValidUntil=2022-12-01T00:00:00Z Search for Stocks that are not expired/embargoed in the given time range (until) |
| ignoreCreatedAt | string Example: ignoreCreatedAt=true Ignore the Stock creation date when filtering by 'stockValidSince' and 'stockValidUntil'. Default is 'true'. |
| assetTypes | string Example: assetTypes=text,image Searches for Stocks having Assets with the given types. Allowed values: image, video, caption, text, link. Default: all asset types are included. |
| stockStatuses | string Example: stockStatuses=LIVE,ARCHIVED Searches for Stocks having the given statuses. Allowed values: LIVE, ARCHIVED. Default: all statuses |
| text | string Example: text=a keyword Searches for Stocks having the given text in title or Asset content |
| page | number Example: page=0 Specifies the index of the page. |
| size | number Example: size=30 Specifies the number of stock cards to return on the current page. |
| stockLabels.type | string Example: stockLabels.type=ALL Searches Stocks by matching ALL or ANY given labels. Allowed values are: ALL, ANY. |
| stockLabels.labels | string Example: stockLabels.labels=label1,label2,label3 Specifies the labels. |
| sortProperty | string Example: sortProperty=createdAt Specifies the property for sorting the stock search results. Allowed values are: createdAt, numberOfCopies. Default is: createdAt |
| sortDirection | string Example: sortDirection=ASC Specifies the direction for sorting. Allowed values are: ASC, DESC. Default is: ASC. |
| items | Array of any |
object |
{- "items": [
- {
- "stockId": "67890-abcde-12345-abcde",
- "title": "My first Stock",
- "text": "My first text asset message",
- "covers": [
- {
- "type": "VIDEO"
}
], - "status": "LIVE",
- "numberOfAssetsByType": {
- "video": "1",
- "image": "0",
- "link": "0",
- "text": "1",
- "caption": "3"
}, - "highlightedText": [
- "My <em>first</em> text asset message",
- "My <em>first</em> Stock"
], - "numberOfCopies": 3,
- "createdAt": "2020-12-01T00:00:00Z",
- "embargoDate": "2020-12-01T00:00:00Z",
- "expirationDate": "2022-12-01T00:00:00Z",
- "labels": [
- "label1",
- "label2",
- "label3"
]
}
], - "paging": {
- "numberOfElements": 10,
- "totalElements": 1000,
- "pageSize": 10,
- "pageNumber": 2,
- "totalPages": 100,
- "prev": {
- "href": "[server domain]/content-pool/stocks/?page=1&..."
}, - "next": {
- "href": "[server domain]/content-pool/stocks/?page3&..."
}
}
}| title required | string Stock title. |
| embargoDate | string Suggest the earliest schedule date when copied. |
| expirationDate | string Suggest the latest time to copy this stock. |
| Location | string |
| id | string |
| title | string |
| embargoDate | string |
| expirationDate | string |
| status | string Enum: "LIVE" "ARCHIVED" |
| createdAt | string |
| createdBy | string |
| modifiedAt | string |
| modifiedBy | string |
| copies | Array of any |
| orgId | number |
{- "title": "My first Stock",
- "embargoDate": "2020-12-01T00:00:00Z",
- "expirationDate": "2021-12-01T00:00:00Z"
}{- "id": "12345-abcde-12345-abcde",
- "title": "My first Stock",
- "embargoDate": "2020-12-01T00:00:00Z",
- "expirationDate": "2020-12-01T00:00:00Z",
- "status": "LIVE",
- "createdAt": "2020-12-01T00:00:00Z",
- "createdBy": "1gqwashflasflhad",
- "modifiedAt": "2020-12-01T00:00:00Z",
- "modifiedBy": "1gqwashflasflhad",
- "copies": [
- {
- "externalId": "a8y7aguyga"
}
], - "orgId": 1
}| title required | string Stock title. |
| embargoDate | string Suggest the earliest schedule date when copied. |
| expirationDate | string Suggest the latest time to copy this stock. |
| assets | Array of any |
| Location | string |
| id | string |
| title | string |
| embargoDate | string |
| expirationDate | string |
| status | string Enum: "LIVE" "ARCHIVED" |
| createdAt | string |
| createdBy | string |
| modifiedAt | string |
| modifiedBy | string |
| copies | Array of any |
| orgId | number |
{- "title": "My first Stock",
- "embargoDate": "2020-12-01T00:00:00Z",
- "expirationDate": "2021-12-01T00:00:00Z",
- "assets": [
- null
]
}{- "id": "12345-abcde-12345-abcde",
- "title": "My first Stock",
- "embargoDate": "2020-12-01T00:00:00Z",
- "expirationDate": "2020-12-01T00:00:00Z",
- "status": "LIVE",
- "createdAt": "2020-12-01T00:00:00Z",
- "createdBy": "1gqwashflasflhad",
- "modifiedAt": "2020-12-01T00:00:00Z",
- "modifiedBy": "1gqwashflasflhad",
- "copies": [
- {
- "externalId": "a8y7aguyga"
}
], - "orgId": 1
}| stockid required | string Example: a1b2c3d4e5f Stock Id |
| title required | string Stock title. |
| embargoDate | string Suggest the earliest schedule date when copied. |
| expirationDate | string Suggest the latest time to copy this stock. |
| id | string |
| title | string |
| embargoDate | string |
| expirationDate | string |
| status | string Enum: "LIVE" "ARCHIVED" |
| createdAt | string |
| createdBy | string |
| modifiedAt | string |
| modifiedBy | string |
| copies | Array of any |
| orgId | number |
{- "title": "My first Stock",
- "embargoDate": "2020-12-01T00:00:00Z",
- "expirationDate": "2021-12-01T00:00:00Z"
}{- "id": "12345-abcde-12345-abcde",
- "title": "My first Stock",
- "embargoDate": "2020-12-01T00:00:00Z",
- "expirationDate": "2020-12-01T00:00:00Z",
- "status": "LIVE",
- "createdAt": "2020-12-01T00:00:00Z",
- "createdBy": "1gqwashflasflhad",
- "modifiedAt": "2020-12-01T00:00:00Z",
- "modifiedBy": "1gqwashflasflhad",
- "copies": [
- {
- "externalId": "a8y7aguyga"
}
], - "orgId": 1
}| stockid required | string Example: a1b2c3d4e5f Stock Id |
| id | string |
| title | string |
| embargoDate | string |
| expirationDate | string |
| status | string Enum: "LIVE" "ARCHIVED" |
| createdAt | string |
| createdBy | string |
| modifiedAt | string |
| modifiedBy | string |
| copies | Array of any |
| orgId | number |
{- "id": "12345-abcde-12345-abcde",
- "title": "My first Stock",
- "embargoDate": "2020-12-01T00:00:00Z",
- "expirationDate": "2020-12-01T00:00:00Z",
- "status": "LIVE",
- "createdAt": "2020-12-01T00:00:00Z",
- "createdBy": "1gqwashflasflhad",
- "modifiedAt": "2020-12-01T00:00:00Z",
- "modifiedBy": "1gqwashflasflhad",
- "copies": [
- {
- "externalId": "a8y7aguyga"
}
], - "orgId": 1
}| stockId required | string Example: 7650eec0-ef38-4139-bce1-695e348aa3ce Stock Id |
| channelUuids required | Array of any Channel UUID, supports dashed and dashless UUIDs. |
| Location | string |
{- "channelUuids": [
- "be839f380f6645db86281b67c45a8110",
- "7650eec0-ef38-4139-bce1-695e348aa3ce"
]
}required | object (AssetPayloadDto) |
| stockId required | string |
| Location | string |
| id | string |
| stockId | string |
| createdAt | string |
| createdBy | string |
| modifiedAt | string |
| modifiedBy | string |
| orgId | number |
required | object (AssetPayloadDto) |
{- "payload": {
- "@type": "image"
}, - "stockId": "12345-abcde-12345-abcde"
}{- "id": "12345-abcde-12345-abcde",
- "stockId": "67890-abcde-12345-abcde",
- "createdAt": "2020-12-01T00:00:00Z",
- "createdBy": "1a2b3c4d5e",
- "modifiedAt": "2020-12-01T00:00:00Z",
- "modifiedBy": "1a2b3c4d5e",
- "orgId": 1,
- "payload": {
- "@type": "image"
}
}| stockid | string Example: stockid=a1b2c3d4e5f Stock Id |
| items | Array of any |
{- "items": [
- {
- "id": "12345-abcde-12345-abcde",
- "stockId": "67890-abcde-12345-abcde",
- "createdAt": "2020-12-01T00:00:00Z",
- "createdBy": "1a2b3c4d5e",
- "modifiedAt": "2020-12-01T00:00:00Z",
- "modifiedBy": "1a2b3c4d5e",
- "orgId": 1,
- "payload": {
- "@type": "image"
}
}
]
}| assetId required | string Example: a1b2c3d4e5f Asset Id |
required | object (AssetPayloadDto) |
| id | string |
| stockId | string |
| createdAt | string |
| createdBy | string |
| modifiedAt | string |
| modifiedBy | string |
| orgId | number |
required | object (AssetPayloadDto) |
{- "payload": {
- "@type": "image"
}
}{- "id": "12345-abcde-12345-abcde",
- "stockId": "67890-abcde-12345-abcde",
- "createdAt": "2020-12-01T00:00:00Z",
- "createdBy": "1a2b3c4d5e",
- "modifiedAt": "2020-12-01T00:00:00Z",
- "modifiedBy": "1a2b3c4d5e",
- "orgId": 1,
- "payload": {
- "@type": "image"
}
}| assetId required | string Example: a1b2c3d4e5f Asset Id |
| id | string |
| stockId | string |
| createdAt | string |
| createdBy | string |
| modifiedAt | string |
| modifiedBy | string |
| orgId | number |
required | object (AssetPayloadDto) |
{- "id": "12345-abcde-12345-abcde",
- "stockId": "67890-abcde-12345-abcde",
- "createdAt": "2020-12-01T00:00:00Z",
- "createdBy": "1a2b3c4d5e",
- "modifiedAt": "2020-12-01T00:00:00Z",
- "modifiedBy": "1a2b3c4d5e",
- "orgId": 1,
- "payload": {
- "@type": "image"
}
}Labels API enables Brandwatch users to create, update, get and/or search for labels within their organization.
| name required | string Label name (max length: 100 characters) |
| color | string The 6-charachters Hex color code |
| color | string |
| created_at | string |
| id | number |
| last_used | number |
| name | string |
| org_id | number |
| slug | string |
| times_used | number |
{- "name": "My Label",
- "color": "FF0000"
}{- "color": "FF0000",
- "created_at": "2017-12-12T09:37:03.643Z",
- "id": 1214,
- "last_used": 0,
- "name": "My Label",
- "org_id": 1,
- "slug": "my-label",
- "times_used": 0
}| name | string Example: name=My labe Name (or part of the name) to search for in your labels collection |
| offset | number Example: offset=1 Search pagination offset (i.e: return search results starting from |
| size | number Default: 20 Example: size=5 Search results page size |
| order | string Default: "name" Enum: "name" "-name" "created" "-created" "last_used" "-last_used" "times_used" "-times_used" Example: order=-name Search results order-by field |
| total | number |
Array of objects |
{- "total": 167,
- "labels": [
- {
- "color": null,
- "created_at": "2017-11-14T15:26:23.733Z",
- "id": 143,
- "last_used": "2017-12-04T14:03:22.568Z",
- "name": "🇩🇰",
- "org_id": 1,
- "slug": "",
- "times_used": 6
}, - {
- "color": null,
- "created_at": "2017-12-04T14:09:11.935Z",
- "id": 1277,
- "last_used": "2017-12-04T14:25:08.580Z",
- "name": "0001",
- "org_id": 1,
- "slug": "0001",
- "times_used": 2
}, - {
- "color": null,
- "created_at": "2017-12-01T12:58:33.661Z",
- "id": 1259,
- "last_used": "2017-12-01T12:58:33.766Z",
- "name": "ABBA",
- "org_id": 1,
- "slug": "abba",
- "times_used": 1
}, - {
- "color": null,
- "created_at": "2017-12-04T14:25:08.679Z",
- "id": 180,
- "last_used": "2017-12-04T14:25:15.475Z",
- "name": "acookieaday",
- "org_id": 1,
- "slug": "acookieaday",
- "times_used": 2
}, - {
- "color": null,
- "created_at": "2017-11-14T13:30:19.322Z",
- "id": 22,
- "last_used": "2017-11-22T13:55:34.934Z",
- "name": "ad",
- "org_id": 1,
- "slug": "ad",
- "times_used": 2
}
]
}| label_id required | number Example: 1234 Numeric ID of the label to get its details |
| color | string |
| created_at | string |
| id | number |
| last_used | number |
| name | string |
| org_id | number |
| slug | string |
| times_used | number |
{- "color": "FF0000",
- "created_at": "2017-12-12T09:37:03.643Z",
- "id": 1214,
- "last_used": 0,
- "name": "My Label",
- "org_id": 1,
- "slug": "my-label",
- "times_used": 0
}| label_id required | number Example: 1234 Numeric ID of the label to delete |
| color | string |
| created_at | string |
| id | number |
| last_used | number |
| name | string |
| org_id | number |
| slug | string |
| times_used | number |
{- "color": "FF0000",
- "created_at": "2017-12-12T09:37:03.643Z",
- "id": 1214,
- "last_used": 0,
- "name": "My Label",
- "org_id": 1,
- "slug": "my-label",
- "times_used": 0
}| conversationId required | string Example: c7c77559-50b0-401e-aaa4-05189328d3a8 or c7c7755950b0401eaaa405189328d3a8 Provided in Engage Exported File |
| parentId | string The id of the comment to reply to |
| message required | string The message to create |
required | object |
{- "parentId": "c7c77559-50b0-401e-aaa4-05189328d3a8|c7c7755950b0401eaaa405189328d3a8",
- "message": "any text message",
- "networkContext": {
- "when the social network is Facebook": {
- "Empty object": ""
}, - "when the social network is Instagram": {
- "Empty object": ""
}, - "when the social network is YouTube": {
- "Empty object": ""
}, - "when the social network is WhatsApp": {
- "Type": "TEXT"
}, - "when the social network is X": {
- "id": ""
}, - "when the social network is TikTok": {
- "Empty object": ""
}, - "when the. network is LinkedIn": {
- "Empty object": ""
}, - "when the social network is GoogleMyBusiness": {
- "Empty object": ""
}
}
}{- "uuid": "c7c77559-50b0-401e-aaa4-05189328d3a8"
}| startDate required | string The beginning of the export's period |
| endDate required | string The end of the export's period |
| networks required | Array of any The list of social networks, the information from which should be in the export. Twitter requires pre-approval to use. |
| channels | Array of any The list of the channels' UUIDs, the information from which should be in the export. If the list is empty, all data associated with the apikey's organization will be added to the export. The UUID of channels can be retrieved by the following endpoint Get Channels |
| types required | Array of any The types of content that should be in the export. |
{- "startDate": "2020-11-10T00:00:00.000Z",
- "endDate": "2020-11-17T23:59:59.999Z",
- "networks": [
- "facebook",
- "instagram",
- "youtube",
- "whatsapp",
- "twitter",
- "tiktok",
- "googlemybusiness"
], - "channels": [
- "c7c77559-50b0-401e-aaa4-05189328d3a8"
], - "types": [
- "post",
- "comment",
- "reply",
- "dm"
]
}{- "uuid": "c7c77559-50b0-401e-aaa4-05189328d3a8"
}| uuid required | string Example: c7c77559-50b0-401e-aaa4-05189328d3a8 Export's uuid that is returned by "Created an export" endpoint. |
| url | string The link on the file in .csv format that contains the exported data |
| status `COMPLETED` required | string Enum: "COMPLETED" "IN_PROGRESS" The status of the export |
{- "status": "COMPLETED"
}Engage Team Performance Metrics API enables Brandwatch users to export team performance metrics data from Engage.
| from required | string The beginning of the export's period. |
| to required | string The end of the export's period. |
| timezone | string The timezone of the export. The timezone should be in the format of "Continent/City" (e.g., "Europe/Copenhagen"). Default is UTC. |
| within_business_hours | boolean If true, metrics calculations will exclude time outside of the configured business hours. If false, whole days will be applied. Default is false. |
| teams | Array of any Users within teams with the given IDs will have metrics exported. If the list is empty, data will be exported for all users. Team IDs can be retrieved by calling the following endpoint Get Teams |
| channels | Array of any Metrics calculated on data associated with the given channel UUIDs will be exported. If the list is empty, metrics will be calculated on data for all channels. The UUIDs of channels can be retrieved by calling the following endpoint Get Channels |
| users | Array of any Metrics will be exported for users with the given IDs. If the list is empty, data will be exported for all users. User IDs for teams can be retrieved by calling the following endpoint Get Team Users |
| networks | Array of any Metrics calculated on data associated with the given social networks will be exported. If the list is empty, metrics will be calculated on data for all supported social networks. |
| content_types | Array of any Metrics calculated on the given types of data will be exported. If the list is empty, metrics will be calculated on all supported types of data. |
object |
{- "from": "2025-01-01",
- "to": "2025-01-07",
- "timezone": "UTC",
- "within_business_hours": false,
- "teams": [
- "c7c7755950b0401eaaa405189328d3a8"
], - "channels": [
- "c7c77559-50b0-401e-aaa4-05189328d3a8"
], - "users": [
- "c7c77559-50b0-401e-aaa4-05189328d3a8"
], - "networks": [
- "facebook",
- "instagram",
- "youtube",
- "whatsapp",
- "twitter",
- "tiktok",
- "linkedin"
], - "content_types": [
- "post",
- "comment",
- "reply",
- "message"
]
}{- "data": {
- "users": [
- {
- "user_id": "9c29ddc1a74042f5921934619fdd73a5",
- "user_name": "Peter Parker",
- "sent": 14,
- "reviewed": 3,
- "responded_within_service_target": 6,
- "responded_above_service_target": 0,
- "responded": 6,
- "median_review_time": 36,
- "median_response_time": 63,
- "median_handle_time": 63,
- "handled": 9,
- "average_review_time": 67,
- "average_response_time": 301,
- "average_handle_time": 223
}
], - "summary": {
- "sent": 16,
- "reviewed": 3,
- "responded_within_service_target": 7,
- "responded_above_service_target": 0,
- "responded": 7,
- "median_review_time": 36,
- "median_response_time": 63,
- "median_handle_time": 51,
- "incoming": 21,
- "handled": 10,
- "average_review_time": 67,
- "average_response_time": 263,
- "average_handle_time": 204
}, - "created_at": "2025-04-01T11:47:59.050425Z"
}
}The Measure API V2 allows you to build integrations between Measure and third-party systems (Google Data Studio, Power BI, etc.) that you use to analyze your social media performance. The API enables you to get insights across even more social media networks. Besides, as it includes the same metrics as Measure dashboards, it allows you to build more unified reporting moving forward.
| networks | string Example: networks=facebook ... filter by network. Default: all. |
Array of objects |
{- "data": [
- {
- "id": "channel/shares/day",
- "level": "CHANNEL",
- "networks": [
- "LINKEDIN",
- "TIKTOK",
- "FACEBOOK"
], - "title": "Shares",
- "description": "The total number of shares on the posts in the period."
}, - {
- "id": "channel/engagements/day",
- "level": "CHANNEL",
- "networks": [
- "LINKEDIN",
- "TIKTOK",
- "FACEBOOK"
], - "title": "Engagements",
- "description": "The number of reactions, comments and shares on your posts during the period.",
- "formula": "channel/reactions/day + channel/comments/day + channel/shares/day"
}, - {
- "id": "channel/likes/day",
- "level": "CHANNEL",
- "networks": [
- "TIKTOK",
- "FACEBOOK"
], - "title": "Likes",
- "description": "The total likes reactions for the period. This metric does not include the other type of reactions like love, haha, angry, etc.\n"
}, - {
- "id": "channel/engagement_rate/day",
- "level": "CHANNEL",
- "networks": [
- "LINKEDIN",
- "TIKTOK",
- "FACEBOOK"
], - "title": "Engagement rate",
- "description": "The Engagement rate is the percentage of people who engage with your posts after seeing it.\n\nIt is computed by dividing the Engagements (Reactions, Comments, Shares) to the Impressions.",
- "formula": "100 * channel/engagements/day / channel/impressions/day"
}
]
}| since required | string |
| until required | string |
| metricIds required | Array of any |
| channelIds required | Array of any |
| insightsRequestId | string |
{- "since": "2022-07-01",
- "until": "2022-08-01",
- "metricIds": [
- "channel/impressions/day",
- "channel/fans/day"
], - "channelIds": [
- "b31a4b131f7c49d3990e62dc02f4577c",
- "d31a4b131f7c49d3990e62dc02f4577c"
]
}{- "insightsRequestId": "284f5fa2-f304-4f6e-9485-20c7f0521f84"
}| networks | string Example: networks=TIKTOK |
Array of objects |
{- "data": [
- {
- "id": "content/likes/lifetime",
- "level": "CONTENT",
- "networks": [
- "TWITTER",
- "INSTAGRAM",
- "TIKTOK",
- "FACEBOOK"
], - "title": "Likes",
- "description": "Likes on a post. Facebook likes on shares are not included. Twitter includes paid favorites on the tweet."
}, - {
- "id": "content/engagement_rate_reach/lifetime",
- "level": "CONTENT",
- "networks": [
- "TWITTER",
- "INSTAGRAM",
- "TIKTOK",
- "FACEBOOK"
], - "title": "Engagement rate (reach)",
- "description": "Total engagements as a percentage of the reached people. Formula: 100 * Engagements / Reach.",
- "formula": "100 * content/engagements/lifetime / content/reach/lifetime"
}, - {
- "id": "content/engagements/lifetime",
- "level": "CONTENT",
- "networks": [
- "TWITTER",
- "INSTAGRAM",
- "LINKEDIN",
- "TIKTOK",
- "FACEBOOK"
], - "title": "Engagements",
- "description": "The reactions, comments, and shares on a post. Clicks are not included.",
- "formula": "content/reactions/lifetime + content/comments/lifetime + content/shares/lifetime"
}, - {
- "id": "content/impressions/lifetime",
- "level": "CONTENT",
- "networks": [
- "TWITTER",
- "INSTAGRAM",
- "LINKEDIN",
- "TIKTOK",
- "FACEBOOK"
], - "title": "Impressions",
- "description": "The number of times the post/story was shown in a person's feed."
}, - {
- "id": "content/engagement_rate/lifetime",
- "level": "CONTENT",
- "networks": [
- "TWITTER",
- "INSTAGRAM",
- "LINKEDIN",
- "TIKTOK",
- "FACEBOOK"
], - "title": "Engagement rate",
- "description": "Total engagements as a percentage of the impressions. Formula: 100 * Engagements / Impressions",
- "formula": "100 * content/engagements/lifetime / content/impressions/lifetime"
}, - {
- "id": "content/video_full_watch_rate/lifetime",
- "level": "CONTENT",
- "networks": [
- "TIKTOK"
], - "title": "Full video watch rate",
- "description": "Percentage of views that completed watching the full video."
}, - {
- "id": "content/video_viewers/lifetime",
- "level": "CONTENT",
- "networks": [
- "TIKTOK",
- "FACEBOOK"
], - "title": "Video viewers",
- "description": "The number of people that watched the video for at least 3 seconds."
}, - {
- "id": "content/video_views/lifetime",
- "name": "post_video_views",
- "level": "CONTENT",
- "networks": [
- "TWITTER",
- "INSTAGRAM",
- "TIKTOK",
- "FACEBOOK"
], - "title": "Video views",
- "description": "Total number of times the video has been watched. All networks require a minimum of 3 seconds viewing time to be considered as a video view."
}
]
}| since required | string |
| until required | string |
| metricIds required | Array of any |
| channels required | Array of any |
| insightsRequestId | string |
{- "since": "2022-07-01T00:00:00+01:00",
- "until": "2022-08-01T00:00:00+01:00",
- "metricIds": [
- "content/comments/lifetime",
- "content/impressions/lifetime"
], - "channels": [
- {
- "id": "f53a57f4-17dd-43e5-9afd-df3a4729613e",
- "contentIds": [
- "678feb85-e155-5cc2-92e5-d4ce32b7aa24",
- "140cc91d-4208-5821-9bff-6c3689575f4b"
]
}, - {
- "id": "55060e786a6042c4b94c32be22575320",
- "contentIds": [
- "14754180-b51d-5284-998d-6218d7f6ffa1",
- "818c4adc-ad3e-5d28-b9c0-9805834751b1"
]
}
]
}{- "insightsRequestId": "284f5fa2-f304-4f6e-9485-20c7f0521f84"
}| insightsRequestId required | string Example: c8f99aa7-a105-4328-93ed-c2ef1d0cc3f6 |
| page | number Example: page=1 |
| status | string |
object |
{- "status": "READY",
- "data": {
- "insights": {
- "channel/impressions/day": [
- {
- "channelId": "ef967825f308499db4bd24b2d653ae04",
- "value": 10,
- "date": "2022-05-12"
}, - {
- "channelId": "ef967825f308499db4bd24b2d653ae04",
- "value": 100,
- "date": "2022-05-10"
}, - {
- "channelId": "ef967825f308499db4bd24b2d653ae04",
- "value": 48,
- "date": "2022-05-13"
}, - {
- "channelId": "ef967825f308499db4bd24b2d653ae04",
- "value": 56,
- "date": "2022-05-11"
}, - {
- "channelId": "ef967825f308499db4bd24b2d653ae04",
- "value": 84,
- "date": "2022-05-14"
}
], - "channel/fans/day": [
- {
- "channelId": "ef967825f308499db4bd24b2d653ae04",
- "value": 97,
- "date": "2022-05-12"
}, - {
- "channelId": "ef967825f308499db4bd24b2d653ae04",
- "value": 97,
- "date": "2022-05-10"
}, - {
- "channelId": "ef967825f308499db4bd24b2d653ae04",
- "value": 97,
- "date": "2022-05-13"
}, - {
- "channelId": "ef967825f308499db4bd24b2d653ae04",
- "value": 97,
- "date": "2022-05-11"
}, - {
- "channelId": "ef967825f308499db4bd24b2d653ae04",
- "value": 97,
- "date": "2022-05-14"
}
]
}, - "paging": { }
}
}The Benchmark API provides access to the data from the social media channels that you monitor in your organization from the following networks - Facebook, Instagram, X(Twitter) and YouTube. Furthermore, it enables integrations with third-party systems for in-house reporting (Google Data Studio, Power BI, etc...), and storage (Amazon Redshift, Google Big Query, etc...).
| Benchmark API Operation | Reason | Response | Error Code |
|---|---|---|---|
| Add Channel | All parameters missing - URI, handle name & network | URL or Handle/ Network required for processing. | 210 |
| Add Channel | Handle name or network is missing. | Both Handle and Network are required for processing. | 211 |
| Add Channel | URI and (handle or network) are present. | Both URL and Handle/ Network cannot be present. | 212 |
| Add Channel | URL misspelled. | URL misspelled. | 213 |
| Add Channel | Handle name misspelled. | Cannot find a channel with the provided handle/ User name. | 214 |
| Add channel | No Channel slot available. | No Channel slots available. Please free up some slots to add a channel. | 216 |
| Get/Delete channel | Channel UUID/ handle is not found under the user’s org | The channel provided cannot be found in the dataset. Please add the channel via a PUT request | 215 |
| Delete channel | The channel provided is a UI channel and not an API channel. | The channel provided cannot be deleted since it is mapped with a Brand. | 217 |
| API Request | Unclassified Internal server error while processing request in benchmark-app | Internal server error occurred. Please contact the API team. | 111 |
| API Request | Unclassified Internal server error while processing request in benchmark-post-metrics | Internal server error occurred. Please contact the API team. | 112 |
| API Request | Pagination error when user requests data for more than 31 days | Number of days provided is greater than 31 days. Please choose less than 31 days. | 300 |
| API Request | sortBy param in channel/feed request body has been misspelled | Cannot sort by the field provided. Please check the sortBy param |
218 |
Array of objects |
{- "data": [
- {
- "uuid": "553c5f3a-d42d-413a-b40a-a8b5c8c187c3",
- "network": "instagram",
- "networkId": "000000000",
- "handle": "brandwatch",
- "permLink": null,
- "status": "INDEXED"
}, - {
- "uuid": "eb9b63dd-4d9a-4a67-a2d6-d00c738e96d5",
- "network": "twitter",
- "networkId": "000000000",
- "handle": "Brandwatch",
- "status": "INDEXED"
}
]
}| uuid required | string Example: 86e74dc3-db34-4c37-b6e7-fe5b5c6d464f |
object |
{- "data": {
- "uuid": "553c5f3a-d42d-413a-b40a-a8b5c8c187c3",
- "network": "instagram",
- "networkId": "000000000",
- "handle": "brandwatch",
- "permLink": null,
- "status": "INDEXED",
- "postAvailableFrom": "2020-01-02T11:00:04",
- "fansAvailableFrom": "2021-11-30"
}
}| orgId | number |
Array of objects | |
| customized | boolean |
{- "orgId": 1,
- "metrics": [
- {
- "network": "youtube",
- "weights": [
- {
- "metric": "likes",
- "value": 1,
- "createdAt": "2025-02-28"
}, - {
- "metric": "comments",
- "value": 1,
- "createdAt": "2025-02-28"
}
]
}, - {
- "network": "twitter",
- "weights": [
- {
- "metric": "likes",
- "value": 1,
- "createdAt": "2025-02-28"
}, - {
- "metric": "replies",
- "value": 1,
- "createdAt": "2025-02-28"
}, - {
- "metric": "reposts",
- "value": 11,
- "createdAt": "2025-02-28"
}
]
}, - {
- "network": "facebook",
- "weights": [
- {
- "metric": "reactions",
- "value": 11,
- "createdAt": "2025-02-28"
}, - {
- "metric": "comments",
- "value": 1,
- "createdAt": "2025-02-28"
}, - {
- "metric": "shares",
- "value": 1,
- "createdAt": "2025-02-28"
}
]
}, - {
- "network": "instagram",
- "weights": [
- {
- "metric": "likes",
- "value": 12,
- "createdAt": "2025-02-28"
}, - {
- "metric": "comments",
- "value": 11,
- "createdAt": "2025-02-28"
}
]
}
], - "customized": true
}| since required | string |
| until required | string |
| channelId required | string |
| sortBy | string |
{- "since": "2024-07-01",
- "until": "2024-08-01",
- "channelId": "a8d5e3ab-a71a-460b-bf99-5a28e6a1cb93",
- "sortBy": "engagement"
}| since required | string |
| until required | string |
| channelId required | string |
{- "since": "2024-07-01",
- "until": "2024-08-01",
- "channelId": "1265268f-4ade-4980-979a-de8811b3424c"
}| since required | string |
| until required | string |
| channelId required | string |
{- "since": "2024-07-01",
- "until": "2024-08-01",
- "channelId": "1265268f-4ade-4980-979a-de8811b3424c"
}| since required | string |
| until required | string |
| channelId required | string |
{- "since": "2024-07-01",
- "until": "2024-08-01",
- "channelId": "1265268f-4ade-4980-979a-de8811b3424c"
}| since required | string |
| until required | string |
| channelId required | string |
{- "since": "2024-07-01",
- "until": "2024-08-01",
- "channelId": "1265268f-4ade-4980-979a-de8811b3424c"
}