Brandwatch Social Media Management API

Download OpenAPI specification:

Brandwatch API Support: apisupport@brandwatch.com

Terms of use

The API

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.

Change Policy

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.

Rate Limiting

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

Authentication

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}

Getting access and support

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

Changelog

2026-06-15

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.

2026-06-10

Removed documentation of deprecated Channels APIs

2026-04-24

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

2026-04-15

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

2026-03-19

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:

  • channel/reposts/day

2026-01-16

Added new group for Integrations Data Exporter

2026-01-13

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

  • Video views (10s): channel/video_views_10s/day

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

2025-10-16

Removed incorrect export options in Engage.

  • It is not possible to export LinkedIn content. It was previously shown as option in the Export API.

2025-10-06

Marked legacy Channel endpoints as deprecated in favour of v2 ones

2025-10-02

Added new endpoints for Channels

2025-09-30

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)

Important Note

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)

2025-09-04

Added Export CSV for Measure supported metrics

2025-07-11

Added new endpoint for Engage

2025-05-07

Support for YouTube draft handling

2025-04-08

Added new endpoint for Engage

  • TPR metrics export

2025-03-28

Added new endpoint in benchmark API

  • get custom engagement weight

2025-03-19

Add new targeting options for Facebook:

  • Feed targeting

    • College years
    • Genders
    • Interests
    • Geographic locations
  • Targeting

    • Age min

2025-01-21

2025-01-08

Facebook draft updated to include facebook REEL placement

2024-12-17

Added missing thumbnailFrameMillisec property to Content API for facebook video posts

2024-12-02

LinkedIn draft updated to include LinkedIn Poll content type

2024-11-26

Corrected Instagram carousel media field name (originalImage > originalPicture) when handling drafts

Added missing Title property to Facebook video content when handling drafts

2024-10-29

LinkedIn draft updated to include LinkedIn Document content type

2024-10-09

Added support for tagging users in instagram videos

2024-10-08

Added support for tagging collaborators in instagram posts (pictures, videos, carousels)

2024-10-07

Deprecation: stop supporting since and until with offset without colon (eg.: +0200) within campaign's APIs

2024-09-16

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.

2024-07-05

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/engagement
  • URL: /benchmark/v1

2024-06-14

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[] }

2024-06-10

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:

  • Watch time for video views: content/post_watch_time_video_views/lifetime

Data for these metrics will be available for LinkedIn video posts published from 2023-05-28

2024-04-10

Benchmark API V1 Released

2024-03-15

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.

2024-03-06

New content metrics for Instagram:

  • Plays - content/plays_total/lifetime - Available for Reels.

    • content/plays/lifetime has been renamed to “Initial plays”.
  • 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:

  • Weighted engagement rate (reach) - content/engagement_rate_reach_weighted/lifetime

Instagram Images, Videos, Reels and Carousels published after 2021-12-31 are affected by the changes.

2024-02-26

Benchmark API V1 Pre-Release

2024-01-30

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

    • Reel reach - channel/reach_reel/day
    • Story reach - channel/reach_story/day
    • Paid reach - channel/reach_ad/day
    • Photo or video reach - channel/reach_post/day
    • IGTV reach - channel/reach_igtv/day
    • Carousel reach - channel/reach_carousel/day
    • Profile pic reach - channel/reach_profile_pic/day
  • Reach by follow type - channel/reach_by_follow_type/total/day

    • Follower reach - channel/reach_follower/day
    • Non follower reach - channel/reach_non_follower/day
  • Engagements by media type - channel/engagements_by_media_type/total/day

    • Reel engagements - channel/engagements_reel/day
    • Story engagements - channel/engagements_story/day
    • Photo or video engagements - channel/engagements_post/day
    • Paid engagements - channel/engagements_ad/day
    • IGTV Engagements - channel/engagements_igtv/day
    • Live engagements - channel/engagements_live/day
  • Likes by media type - channel/likes_by_media_type/total/day

    • Reel likes - channel/likes_reel/day
    • Story likes - channel/likes_story/day
    • Photo or video likes - channel/likes_post/day
    • Carousel likes - channel/likes_carousel/day
    • Paid likes - channel/likes_ad/day
    • IGTV likes - channel/likes_igtv/day
  • Comments by media type - channel/comments_by_media_type/total/day

    • Reel comments - channel/comments_reel/day
    • Story comments - channel/comments_story/day
    • Photo or video comments - channel/comments_post/day
    • Paid comments - channel/comments_ad/day
    • Live comments - channel/comments_live/day
    • IGTV comments - channel/comments_igtv/day
  • Shares by media type - channel/shares_by_media_type/total/day

    • Reel shares - channel/shares_reel/day
    • Story shares - channel/shares_story/day
    • Photo or video shares - channel/shares_post/day
    • Carousel shares - channel/shares_carousel/day
    • Paid shares - channel/shares_ad/day
    • IGTV shares - channel/shares_igtv/day
  • Saves by media type - channel/saves_by_media_type/total/day

    • Reel saves - channel/saves_reel/day
    • Photo or video saves - channel/saves_post/day
    • Paid saves - channel/saves_ad/day
    • IGTV saves - channel/saves_igtv/day
  • Profile activity by type - channel/profile_activity_by_type/total/day

    • Book now - channel/profile_links_taps_book_now/day
    • Call - channel/profile_links_taps_call/day
    • Direction - channel/profile_links_taps_direction/day
    • Email - channel/profile_links_taps_email/day
    • Instant experience - channel/profile_links_taps_instant_experience/day
    • Text - channel/profile_links_taps_text/day
    • Website clicks - channel/website_clicks/day (Already existing metric)
  • Engagement rate (reach) by media type - channel/engagement_rate_reach_by_media_type/total/day

    • Reel engagement rate (reach) - channel/engagement_rate_reach_reel/day
    • Story engagement rate (reach) - channel/engagement_rate_reach_story/day
    • Photo or video engagement rate (reach) - channel/engagement_rate_reach_post/day
    • Paid engagement rate (reach) - channel/engagement_rate_reach_ad/day
    • IGTV engagement rate (reach) - channel/engagement_rate_reach_igtv/day

New channel metric for Facebook, Instagram and LinkedIn:

  • Engagement rate (reach) - channel/engagement_rate_reach/day

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

2024-01-11

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.

2023-10-17

Added Link In Bio API. This api allows getting, adding, and deleting links from a link in bio page.

2023-08-16

Corrected documentation on the Short URL API.

2023-08-14

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

2023-08-01

  • Added "audioName" to Instagram content.

2023-07-20

  • Retry-After response header is not supported.

2023-06-27

  • "v2" has been added to the URLs for the Engage Export API. Please note that the earlier endpoints are now deprecated. We will ensure to provide adequate notice prior to their removal.

2023-06-16

  • It is now possible to create Short URL with a dedicated endpoint

2023-06-05

  • Support for thumbnail offset in TikTok drafts video has been added

2023-04-04

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

2023-02-07

  • Measure API V1 is deprecated. These are all endpoints containing "measure/api/v1" in their path.

  • The documentation for Measure API V1 is removed.

2022-12-14

2022-11-29

  • 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.

2022-10-15

2022-08-22

  • Updated documentation on CarouselMedia of Instagram drafts.

2022-08-16

  • Updated documentation on targeting for LinkedIn drafts.

2022-08-02

2022-08-02

  • Made publisher optional for Instagram posts. Many of the formats can be published directly, without falling back to the mobile app.

2022-08-02

  • 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.

2022-08-01

2022-08-01

2022-08-01

2022-06-21

  • The API documentation for Classic Listen has been removed.

2022-05-12

  • Twitter as a network has been re-introduced in Engage Export API. To be able to use the network, the calling organization must be pre-approved to do so.

2021-10-12

  • Documentation relative to the deprecated Content Pool API has been deleted.

  • Documentation relative to the deprecated Approval flow endpoints and payload has been deleted.

2021-09-06

2021-08-13

  • 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.

2021-08-02

  • New Content Pool API added. Check here.

  • Old Content Pool API marked as deprecated

2021-07-22

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:

2021-03-26

2021-02-02

  • Expose new payload to return appended SRT files for video templates.

  • Expose new payload to append SRT files to Templates.

2020-12-15

2020-12-01

2020-11-30

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.

2020-11-23

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

2020-07-07

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.

2019-09-30

Add video field to content of LinkedIn Draft.

2019-09-13

Get Channel Content now returns information on where content was copied from. Potential origins are: stock template, existing publication or scheduled publishing.

2019-06-19

  • Added new endpoint to search for Facebook locations.

  • Added new endpoint to search for Instagram locations.

  • Added new endpoint to search for Twitter locations.

2019-06-14

  • 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.

2019-06-04

Add place field to Instagram options Instagram Draft.

2019-05-21

Add locales field to Facebook Feed Targeting in Facebook Draft and Get Channel Content sections.

2019-05-09

Mark single-picture fields in Facebook Draft as deprecated.

2019-04-14

Introducing APIs for Content Labeling and Draft Label Handling.

2019-03-13

Listen Get Topic Metrics now return the top phrases and their count.

2019-01-29

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.

2019-01-25

We're happy to inform that we have raised the RollingWindowQuota to 900 calls / 15 minutes to better cater to customer needs.

2018-12-11

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

2018-12-10

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.

2018-11-15

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".

2018-11-06

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.

2018-10-18

Provide documentation for Publish get copied content API

2018-10-04

Removal of YouTube metrics from the Channel insight metrics API due to YouTube compliance.

Removal of deprecated User and Team performance metrics APIs.

2018-08-01

Rename channel and content level metrics according to changes in Facebook Graph Api 3.1 insights

2018-05-01

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.

2018-04-23

Introduction of object - shorteningUrls types in the body of individual networks Publishing draft APIs.

Team API

Get Teams

Authorizations:
apiKey
query Parameters
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.

Responses

Response Schema: application/json
Array
id
required
string
name
required
string
color
required
string or null
orgId
required
number

Response samples

Content type
application/json
[
  • {
    • "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
    }
]

Get specific Team

Authorizations:
apiKey
path Parameters
team_id
required
string
Example: 8aa7c89c43bf32210143bfa31c100331

Unique team id

Responses

Response Schema: application/json
Array
id
string
name
string
color
string or null
orgId
number

Response samples

Content type
application/json
[
  • {
    • "id": "8ad597b9503d53ce01504171775d655e",
    • "name": "Community Managers",
    • "color": null,
    • "orgId": 35901
    }
]

Get Team Users

Authorizations:
apiKey
path Parameters
team_id
required
string
Example: 8aa7c89c43bf32210143bfa31c100331

Unique team id.

query Parameters
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.

Responses

Response Schema: application/json
Array
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

Response samples

Content type
application/json
[
  • {
    • "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
    }
]

Channels API

Get Channels V2

Authorizations:
apiKey
Request Body schema: application/json
Schema not provided

Responses

Response Schema: application/json
One of
Array of objects

Request samples

Content type
application/json
Example
{
  • "responseFields": [
    • "id",
    • "name",
    • "teams"
    ],
  • "nameContains": "test"
}

Response samples

Content type
application/json
Example
{
  • "items": [
    • {
      },
    • {
      }
    ]
}

Get Channel V2

Authorizations:
apiKey
path Parameters
channel_id
required
string
Example: 000b48f0-ba80-354a-b5dd-dedca0679fb3

The channel you want to get

Responses

Response Schema: application/json
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

Response samples

Content type
application/json
{
  • "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": [
    • {
      }
    ],
  • "authorizations": null,
  • "tokens": [ ],
  • "groups": [ ],
  • "teams": [
    • "8a81800666ed1a940166f02547781283",
    • "8a8180066643d366016662a2e14d6c0c"
    ],
  • "indexingHash": null,
  • "permissions": [
    • "copyPost",
    • "deletePost",
    • "editPost",
    • "read",
    • "savePostAsDraft",
    • "deletePostNotPublished",
    • "publishPost",
    • "addNote",
    • "createPost",
    • "editNote",
    • "approvePost",
    • "submitPostForApproval"
    ],
  • "role": "EDITOR"
}

Get Channel Groups V2

Authorizations:
apiKey
query Parameters
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

Responses

Response Schema: application/json
count
number
totalCount
number
pageSize
number
currentPage
number
totalPages
number
Array of objects

Response samples

Content type
application/json
{
  • "count": 2,
  • "totalCount": 2,
  • "pageSize": 100,
  • "currentPage": 0,
  • "totalPages": 1,
  • "items": [
    • {
      },
    • {
      }
    ]
}

Get Channel Group V2

Authorizations:
apiKey
path Parameters
group_id
required
string
Example: 3140b22c-6191-48ac-a1b6-e9e82919e666

The group you want to get

Responses

Response Schema: application/json
id
string
title
string
organizationId
string
createdAt
string
channelIds
Array of strings

Response samples

Content type
application/json
{
  • "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"
    ]
}

Content API

Get list of published, unpublished and scheduled posts for your Organization

Authorizations:
apiKey
query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "fault": {
    • "faultstring": "Invalid ApiKey",
    • "detail": {
      }
    }
}

Content Labeling

Functionality for handling labels for published content.

Get Publication Labels

Authorizations:
apiKey
path Parameters
publicationId
required
string
Example: a1b2c3d4e5f

ID of a valid Publication

Responses

Response Schema: application/json;charset=utf-8
Array of objects

Response samples

Content type
application/json;charset=utf-8
{
  • "items": [
    • {
      }
    ]
}

Add Publication Labels

Authorizations:
apiKey
path Parameters
publicationId
required
string
Example: a1b2c3d4e5f

ID of a valid Publication

labelId
required
string
Example: 1

ID of a valid Label to add

Responses

Remove Publication Labels

Authorizations:
apiKey
path Parameters
publicationId
required
string
Example: a1b2c3d4e5f

ID of a valid Publication

labelId
required
string
Example: 1

ID of a Label to remove

Responses

Publishing API

A Publishing is a draft that has been created in Brandwatch but not yet published to the intended social network. Once a draft has been published by the network it becomes a Publication.

Draft Handling

Functionality for scheduling, copying and in other ways handling drafts.

Schedule Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid draft

Request Body schema: application/json;charset=utf-8
date
required
string

Schedule date in the future.

zoneName
string

Zone Id of the date.

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "date": "2018-01-01T00:00:00Z",
  • "zoneName": "Europe/Copenhagen"
}

Response samples

Content type
application/json
{
  • "fault": {
    • "faultstring": "Invalid ApiKey",
    • "detail": {
      }
    }
}

Un-Schedule Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid draft

Responses

Response samples

Content type
application/json
{
  • "fault": {
    • "faultstring": "Invalid ApiKey",
    • "detail": {
      }
    }
}

Copy Draft

Authorizations:
apiKey
path Parameters
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

Request Body schema: application/json;charset=utf-8
channels
Array of any

Deprecated, replaced by channelUuids.

channelUuids
Array of any

Channel UUIDs to copy this publishing to. Channels must belong to the same network.

Responses

Response Headers
Location
string
Response Schema: application/json;charset=utf-8
id
required
string

New Publishing ID

channels
Array of any

UUIDS of the channels the Publishing has been copied too (if the deprecated channels field was used in the request, then the channel IDs will be returned instead).

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1",
    • "channel2"
    ],
  • "channelUuids": [
    • "af1370da-a7f9-11ef-a491-d7c9309cce5d",
    • "6e8cdc8e-a7fb-11ef-b580-3f764fcadca6"
    ]
}

Response samples

Content type
application/json;charset=utf-8
{
  • "id": "fdd3f1e8a7fb11ef8b95c3708bec0fce",
  • "channels": [
    • "af1370da-a7f9-11ef-a491-d7c9309cce5d",
    • "6e8cdc8e-a7fb-11ef-b580-3f764fcadca6"
    ]
}

Draft Status

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid draft

Responses

Response Schema: application/json;charset=utf-8
status
string
Enum: "draft" "unapproved" "scheduled" "scheduledError" "published"

Status of the Post

publicationStatuses
Array of any

Response samples

Content type
application/json;charset=utf-8
{
  • "status": "scheduledError",
  • "publicationStatuses": [
    • {
      }
    ]
}

Delete Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid draft

Responses

Response samples

Content type
application/json
{
  • "fault": {
    • "faultstring": "Invalid ApiKey",
    • "detail": {
      }
    }
}

Label Handling

Functionality for handling labels for drafts.

Get Labels

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

ID of a valid Publishing

Responses

Response Schema: application/json;charset=utf-8
Array of objects

Response samples

Content type
application/json;charset=utf-8
{
  • "items": [
    • {
      }
    ]
}

Add Label

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

ID of a valid Publishing

labelId
required
string
Example: 1

ID of a valid Label to add

Responses

Remove Label

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

ID of a valid Publishing

labelId
required
string
Example: 1

ID of a Label to remove

Responses

Facebook Draft

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.

Create Facebook Draft

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel IDs this publishing is assigned to

required
object
object

Content can contains only one property at the time

Responses

Response Headers
Location
string

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "dark": false,
    • "geoGating": {
      },
    • "feedTargeting": {
      },
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "place": {
      },
    • "placement": "FEED"
    },
  • "content": {
    • "text": {
      },
    • "link": {
      },
    • "links": {
      },
    • "album": {
      },
    • "picture": {
      },
    • "video": {
      }
    }
}

Edit Facebook Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid Facebook Publishing

Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel IDs this publishing is assigned to

required
object
object

Content can contains only one property at the time

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "dark": false,
    • "geoGating": {
      },
    • "feedTargeting": {
      },
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "place": {
      },
    • "placement": "FEED"
    },
  • "content": {
    • "text": {
      },
    • "link": {
      },
    • "carousel": {
      },
    • "album": {
      },
    • "picture": {
      },
    • "video": {
      }
    }
}

Get Facebook Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid Facebook Publishing

Responses

Response Schema: application/json;charset=utf-8
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)

Response samples

Content type
application/json;charset=utf-8
{
  • "id": "a1b2c3d4e5ffg",
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "dark": false,
    • "geoTargeting": {
      },
    • "feedTargeting": {
      },
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "place": {
      },
    • "placement": "FEED"
    },
  • "content": {
    • "text": {
      },
    • "link": {
      },
    • "links": {
      },
    • "album": {
      },
    • "picture": {
      },
    • "video": {
      }
    },
  • "created": {
    • "date": "2015-01-01T00:00:00"
    },
  • "notes": {
    • "create": {
      },
    • "self": {
      }
    },
  • "copies": {
    • "self": {
      }
    },
  • "labels": {
    • "self": {
      },
    • "addLabel": {
      },
    • "removeLabel": {
      }
    },
  • "status": "draft",
  • "meta": {
    • "schedule": {
      },
    • "unschedule": {
      },
    • "delete": {
      },
    • "extraStatusInfo": {
      },
    • "self": {
      },
    • "update": {
      },
    • "copy": {
      }
    },
  • "promotions": {
    • "self": {
      },
    • "create": {
      }
    }
}

Get Locations

Authorizations:
apiKey
path Parameters
channelId
required
string
Example: 1234

ID of a valid channel. Necessary to serve relevant locations.

query Parameters
q
required
string
Example: q=Copenhagen

query string

offset
number
Example: offset=0

search offset

limit
number
Default: 10
Example: limit=10

search limit

Responses

Response Schema: application/json;charset=utf-8
items
Array of any

Array of places

object

Previous page, if applicable

object

Next page, if applicable

Response samples

Content type
application/json;charset=utf-8
{
  • "items": [
    • {
      }
    ],
  • "previous": {
    • "href": "/publish/publishing/facebook/locations?offset=&q=&limit=&apikey=",
    • "method": "GET"
    },
  • "next": {
    • "href": "/publish/publishing/facebook/locations?offset=&q=&limit=&apikey=",
    • "method": "GET"
    }
}

Twitter Draft

Resources for operations on a specific Twitter draft.

Create Twitter Draft

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel IDs this publishing is assigned to

required
object
object

Content can contains only one property at the time

Responses

Response Headers
Location
string

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "place": {
      },
    • "placement": "FEED"
    },
  • "content": {
    • "text": {
      },
    • "video": {
      },
    • "pictures": {
      }
    }
}

Edit Twitter Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid Twitter draft

Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel IDs this LinkedIn is assigned to

required
object
object

Content can contains only one property at the time

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "place": {
      },
    • "placement": "FEED"
    },
  • "content": {
    • "text": {
      },
    • "video": {
      },
    • "pictures": {
      }
    }
}

Get Twitter Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid Twitter draft

Responses

Response Schema: application/json;charset=utf-8
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)

Response samples

Content type
application/json;charset=utf-8
{
  • "id": "a1b2c3d4e5f",
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "place": {
      },
    • "placement": "FEED"
    },
  • "content": {
    • "text": {
      },
    • "video": {
      },
    • "pictures": {
      }
    },
  • "created": {
    • "date": "2015-01-01T00:00:00"
    },
  • "notes": {
    • "create": {
      },
    • "self": {
      }
    },
  • "copies": {
    • "self": {
      }
    },
  • "labels": {
    • "self": {
      },
    • "addLabel": {
      },
    • "removeLabel": {
      }
    },
  • "status": "draft",
  • "meta": {
    • "schedule": {
      },
    • "unschedule": {
      },
    • "delete": {
      },
    • "extraStatusInfo": {
      },
    • "self": {
      },
    • "update": {
      },
    • "copy": {
      }
    }
}

Get Locations

Authorizations:
apiKey
path Parameters
channelId
required
string
Example: 12345

Valid ID of the twitter channel. Necessary to make the returned payload to be contextual to the user.

query Parameters
q
required
string
Example: q=Falcon

query string

limit
number
Default: 10
Example: limit=10

search limit

Responses

Response Schema: application/json;charset=utf-8
items
Array of any

Response samples

Content type
application/json;charset=utf-8
{
  • "items": [
    • {
      }
    ]
}

Instagram Draft

Resources for operations on a specific Instagram draft.

Create Instagram Draft

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
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

Responses

Response Headers
Location
string

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "publisher": {
      },
    • "place": {
      },
    • "firstComment": "Hello, World!",
    • "placement": "FEED",
    • "shareToFeed": true,
    • "audioName": "unoriginal music",
    • "collaboratorTags": [
      ]
    },
  • "content": {
    • "picture": {
      },
    • "video": {
      },
    • "carousel": {
      }
    }
}

Edit Instagram Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid Instagram Draft

Request Body schema: application/json;charset=utf-8
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

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "publisher": {
      },
    • "place": {
      },
    • "firstComment": "Hello, World!",
    • "placement": "FEED",
    • "shareToFeed": true,
    • "audioName": "unoriginal music",
    • "collaboratorTags": [
      ]
    },
  • "content": {
    • "picture": {
      },
    • "video": {
      },
    • "carousel": {
      }
    }
}

Get Instagram Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid Instagram Draft

Responses

Response Schema: application/json;charset=utf-8
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)

Response samples

Content type
application/json;charset=utf-8
{
  • "id": "a1b2c3d4e5ffg",
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "publisher": {
      },
    • "place": {
      },
    • "firstComment": "Hello, World!",
    • "placement": "FEED",
    • "shareToFeed": true,
    • "audioName": "unoriginal music",
    • "collaboratorTags": [
      ]
    },
  • "content": {
    • "picture": {
      },
    • "video": {
      },
    • "carousel": {
      }
    },
  • "created": {
    • "date": "2015-01-01T00:00:00"
    },
  • "notes": {
    • "create": {
      },
    • "self": {
      }
    },
  • "copies": {
    • "self": {
      }
    },
  • "labels": {
    • "self": {
      },
    • "addLabel": {
      },
    • "removeLabel": {
      }
    },
  • "status": "draft",
  • "meta": {
    • "schedule": {
      },
    • "unschedule": {
      },
    • "delete": {
      },
    • "extraStatusInfo": {
      },
    • "self": {
      },
    • "update": {
      },
    • "copy": {
      }
    }
}

Get Locations

Authorizations:
apiKey
path Parameters
channelId
required
string
Example: 1234

ID of a valid channel. Necessary to serve relevant locations.

query Parameters
q
required
string
Example: q=Copenhagen

query string

offset
number
Example: offset=0

search offset

limit
number
Default: 10
Example: limit=10

search limit

Responses

Response Schema: application/json;charset=utf-8
items
Array of any

Array of places

object

Previous page, if applicable

object

Next page, if applicable

Response samples

Content type
application/json;charset=utf-8
{
  • "items": [
    • {
      }
    ],
  • "previous": {
    • "href": "/publish/publishing/facebook/locations?offset=&q=&limit=&apikey=",
    • "method": "GET"
    },
  • "next": {
    • "href": "/publish/publishing/facebook/locations?offset=&q=&limit=&apikey=",
    • "method": "GET"
    }
}

LinkedIn Draft

Resources for operations on a specific LinkedIn draft.

Create LinkedIn Draft

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel IDs this publishing is assigned to

required
object
object

Content can contains only one property at the time

Responses

Response Headers
Location
string

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "targeting": {
      },
    • "visibility": "anyone",
    • "shorteningUrls": {
      },
    • "placement": "FEED"
    },
  • "content": {
    • "text": {
      },
    • "link": {
      },
    • "picture": {},
    • "video": {
      },
    • "document": {},
    • "poll": {
      }
    }
}

Edit LinkedIn Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid LinkedIn draft

Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel IDs this LinkedIn is assigned to

required
object
object

Content can contains only one property at the time

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "targeting": {
      },
    • "visibility": "anyone",
    • "shorteningUrls": {
      },
    • "placement": "FEED"
    },
  • "content": {
    • "text": {
      },
    • "link": {
      },
    • "picture": {},
    • "video": {
      },
    • "document": {},
    • "poll": {
      }
    }
}

Get LinkedIn Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid LinkedIn draft

Responses

Response Schema: application/json;charset=utf-8
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)

Response samples

Content type
application/json;charset=utf-8
{
  • "id": "a1b2c3d4e5f",
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "targeting": {
      },
    • "visibility": "anyone",
    • "shorteningUrls": {
      },
    • "placement": "FEED"
    },
  • "content": {
    • "text": {
      },
    • "link": {
      },
    • "picture": {},
    • "video": {
      },
    • "document": {},
    • "poll": {
      }
    },
  • "created": {
    • "date": "2015-01-01T00:00:00"
    },
  • "notes": {
    • "create": {
      },
    • "self": {
      }
    },
  • "copies": {
    • "self": {
      }
    },
  • "labels": {
    • "self": {
      },
    • "addLabel": {
      },
    • "removeLabel": {
      }
    },
  • "status": "draft",
  • "meta": {
    • "schedule": {
      },
    • "unschedule": {
      },
    • "delete": {
      },
    • "extraStatusInfo": {
      },
    • "self": {
      },
    • "update": {
      },
    • "copy": {
      }
    }
}

TikTok Draft

Resources for operations on a specific TikTok draft.

Create TikTok Draft

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel IDs this publishing is assigned to

required
object
object

Content can contains only one property at the time

Responses

Response Headers
Location
string

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "disableDuet": false,
    • "disableStitch": false,
    • "disableComment": false,
    • "placement": "FEED"
    },
  • "content": {
    • "video": {
      }
    }
}

Edit TikTok Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid TikTok draft

Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel IDs this publishing is assigned to

required
object
object

Content can contains only one property at the time

Responses

Response Schema: application/json;charset=utf-8
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

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "disableDuet": false,
    • "disableStitch": false,
    • "disableComment": false,
    • "placement": "FEED"
    },
  • "content": {
    • "video": {
      }
    }
}

Response samples

Content type
application/json;charset=utf-8
{
  • "id": "a1b2c3d4e5f",
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "disableDuet": false,
    • "disableStitch": false,
    • "disableComment": false,
    • "placement": "FEED"
    },
  • "content": {
    • "video": {
      }
    }
}

Get TikTok Draft

Authorizations:
apiKey
path Parameters
publishingId
required
string
Example: a1b2c3d4e5f

Publishing ID of a valid TikTok draft

Responses

Response Schema: application/json;charset=utf-8
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)

Response samples

Content type
application/json;charset=utf-8
{
  • "id": "a1b2c3d4e5f",
  • "channels": [
    • "channel1"
    ],
  • "options": {
    • "schedule": {
      },
    • "shorteningUrls": {
      },
    • "disableDuet": false,
    • "disableStitch": false,
    • "disableComment": false,
    • "placement": "FEED"
    },
  • "content": {
    • "video": {
      }
    },
  • "status": "draft",
  • "created": {
    • "date": "2015-01-01T00:00:00",
    • "by": "347834738473"
    },
  • "notes": {
    • "create": {
      },
    • "self": {
      }
    },
  • "copies": {
    • "self": {
      }
    },
  • "labels": {
    • "self": {
      },
    • "addLabel": {
      },
    • "removeLabel": {
      }
    },
  • "meta": {
    • "schedule": {
      },
    • "unschedule": {
      },
    • "delete": {
      },
    • "extraStatusInfo": {
      },
    • "self": {
      },
    • "update": {
      },
    • "copy": {
      }
    }
}

Pinterest Draft

Resources for operations on a specific Pinterest draft.

Create Pinterest Draft

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel UUIDs this publishing is assigned to

required
object
object

Content must contain exactly one property of either picture, video or carousel

Responses

Response Headers
Location
string

Request samples

Content type
application/json;charset=utf-8
{}

Edit Pinterest Draft

Authorizations:
apiKey
path Parameters
id
required
string
Example: 90fd0acca81011efabfc3ff335174a64

Publishing ID of a valid Pinterest draft

Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel UUIDs this publishing is assigned to

required
object
object

Content must contain exactly one property of either picture, video or carousel

Responses

Request samples

Content type
application/json;charset=utf-8
{}

Get Pinterest Draft

Authorizations:
apiKey
path Parameters
id
required
string
Example: 90fd0acca81011efabfc3ff335174a64

Publishing ID of a valid Pinterest draft

Responses

Response Schema: application/json;charset=utf-8
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 picture, video or carousel

status
required
string
Enum: "draft" "unapproved" "scheduled" "scheduledError" "published"

Publishing status.

object
object (Notes)
object (Copies)
object (PublishingLabelsMeta)
object (PinterestPublishingMeta)

Response samples

Content type
application/json;charset=utf-8
{
  • "id": "90fd0acca81011efabfc3ff335174a64",
  • "channels": [
    • "af1370da-a7f9-11ef-a491-d7c9309cce5d"
    ],
  • "options": {
    • "schedule": {
      },
    • "boardId": "572942369493",
    • "boardSectionId": "8946798234",
    • "placement": "FEED"
    },
  • "content": {},
  • "status": "draft",
  • "created": {
    • "date": "2024-11-21T00:00:00",
    • "by": "265a3698a81711ef9c824fc1caa32f14"
    },
  • "notes": {
    • "create": {
      },
    • "self": {
      }
    },
  • "copies": {
    • "self": {
      }
    },
  • "labels": {
    • "self": {
      },
    • "addLabel": {
      },
    • "removeLabel": {
      }
    },
  • "meta": {
    • "schedule": {
      },
    • "unschedule": {
      },
    • "delete": {
      },
    • "extraStatusInfo": {
      },
    • "self": {
      },
    • "update": {
      },
    • "copy": {
      }
    }
}

Get boards

Authorizations:
apiKey
path Parameters
channelUuid
required
string
Example: af1370da-a7f9-11ef-a491-d7c9309cce5d

UUID of a Pinterest channel

Responses

Response Schema: application/json;charset=utc-8
items
Array of any

array of boards

Response samples

Content type
application/json;charset=utc-8
{
  • "items": [
    • {
      }
    ]
}

Get board sections

Authorizations:
apiKey
path Parameters
channelUuid
required
string
Example: af1370da-a7f9-11ef-a491-d7c9309cce5d

UUID of a Pinterest channel

boardId
required
string
Example: 572942369493

ID of a Pinterest board

Responses

Response Schema: application/json;charset=utc-8
items
Array of any

array of board sections

Response samples

Content type
application/json;charset=utc-8
{
  • "items": [
    • {
      }
    ]
}

YouTube Draft

Resources for operations on a specific YouTube draft.

Create YouTube Draft

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel UUIDs this publishing is assigned to

required
object
object

Content contains exactly one property of video

Responses

Response Headers
Location
string

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "af1370da-a7f9-11ef-a491-d7c9309cce5d"
    ],
  • "options": {
    • "schedule": {
      },
    • "tags": [ ],
    • "playlistIds": [ ],
    • "privacyStatus": "PRIVATE",
    • "placement": "FEED"
    },
  • "content": {}
}

Edit YouTube Draft

Authorizations:
apiKey
path Parameters
id
required
string
Example: 90fd0acca81011efabfc3ff335174a64

Publishing ID of a valid YouTube draft

Request Body schema: application/json;charset=utf-8
channels
required
Array of any

Channel UUIDs this publishing is assigned to

required
object
object

Content contains exactly one property of video

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "channels": [
    • "af1370da-a7f9-11ef-a491-d7c9309cce5d"
    ],
  • "options": {
    • "schedule": {
      },
    • "tags": [ ],
    • "playlistIds": [ ],
    • "privacyStatus": "PRIVATE",
    • "placement": "FEED"
    },
  • "content": {}
}

Get YouTube Draft

Authorizations:
apiKey
path Parameters
id
required
string
Example: 90fd0acca81011efabfc3ff335174a64

Publishing ID of a valid YouTube draft

Responses

Response Schema: application/json;charset=utf-8
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 video

status
required
string
Enum: "draft" "unapproved" "scheduled" "scheduledError" "published"

Publishing status.

object
object (Notes)
object (Copies)
object (PublishingLabelsMeta)
object (YoutubePublishingMeta)

Response samples

Content type
application/json;charset=utf-8
{
  • "id": "90fd0acca81011efabfc3ff335174a64",
  • "channels": [
    • "youtube_42_UCVGwD-qAF8MPI1-uHfH_8XY"
    ],
  • "options": {
    • "schedule": {
      },
    • "tags": [ ],
    • "playlistIds": [ ],
    • "privacyStatus": "PRIVATE",
    • "placement": "FEED"
    },
  • "content": {},
  • "status": "draft",
  • "created": {
    • "date": "2024-11-21T00:00:00",
    • "by": "265a3698a81711ef9c824fc1caa32f14"
    },
  • "notes": {
    • "create": {
      },
    • "self": {
      }
    },
  • "copies": {
    • "self": {
      }
    },
  • "labels": {
    • "self": {
      },
    • "addLabel": {
      },
    • "removeLabel": {
      }
    },
  • "meta": {
    • "schedule": {
      },
    • "unschedule": {
      },
    • "delete": {
      },
    • "extraStatusInfo": {
      },
    • "self": {
      },
    • "update": {
      },
    • "copy": {
      }
    }
}

Get playlists

Authorizations:
apiKey
path Parameters
channelUuid
required
string
Example: af1370da-a7f9-11ef-a491-d7c9309cce5d

UUID of a YouTube channel

query Parameters
limit
number
Example: limit=25

maximum number of items returned

Responses

Response Schema: application/json;charset=utc-8
items
Array of any

array of playlists

object
object

Response samples

Content type
application/json;charset=utc-8
{
  • "items": [],
  • "previous": {
    • "method": "GET",
    • "href": "/publish/youtube/{channelUuid}'/playlists?previous=token"
    },
  • "next": {
    • "method": "GET",
    • "href": "/publish/youtube/{channelUuid}'/playlists?next=token"
    }
}

Short URL API

Get Short URL domains

Authorizations:
apiKey

Responses

Response Schema: application/json;charset=utf-8
items
Array of any

Response samples

Content type
application/json;charset=utf-8
{
  • "items": [
    • "brnw.ch",
    • "mydomain.com"
    ]
}

Create Short URL

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
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

Responses

Response Schema: application/json;charset=utf-8
targetUrl
string

media-management/ (string) - URL resource to place behind Short URL

shortUrl
string

Newly created Short URL

Request samples

Content type
application/json;charset=utf-8
{}

Response samples

Content type
application/json;charset=utf-8
{}

Campaign API

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.

Create Campaign

Authorizations:
apiKey
query Parameters
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.

header Parameters
timezoneid
string
Example: Europe/Copenhagen

e.g. Europe/Copenhagen

Location
string
Example: /publish/campaigns/{id}

e.g. /publish/campaigns/{id}

Request Body schema: application/json;charset=utf-8
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

Responses

Response Headers
timezoneid
string
Location
string

Request samples

Content type
application/json;charset=utf-8
{
  • "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": [
    • {
      }
    ],
  • "attachments": [
    • {
      }
    ]
}

Response samples

Content type
application/json;charset=utf-8
{
  • "status": 500,
  • "message": "Bad request",
  • "errorMessage": "Message for end-user",
  • "errorCode": "500"
}

Get all Campaigns

Authorizations:
apiKey
query Parameters
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

Responses

Get Campaign by id

Authorizations:
apiKey
path Parameters
campaignId
required
string
Example: abc123

Campaign ID

Responses

Response Schema: application/json;charset=utf-8
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

Response samples

Content type
application/json;charset=utf-8
{
  • "orgId": 42,
  • "id": "",
  • "title": "",
  • "description": "",
  • "color": "",
  • "labels": [
    • ""
    ],
  • "collaborationGroups": [
    • ""
    ],
  • "startDate": "",
  • "endDate": "",
  • "timezoneId": "",
  • "reminders": [
    • {
      }
    ],
  • "attachments": [
    • {
      }
    ],
  • "meta": {
    • "self": {
      },
    • "getStocks": {
      },
    • "update": {
      },
    • "delete": {
      }
    }
}

Update Campaign

Authorizations:
apiKey
path Parameters
campaignId
required
string
Example: abc123

Campaign ID

query Parameters
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.

header Parameters
timezoneid
string
Example: Europe/Copenhagen

e.g. Europe/Copenhagen

Location
string
Example: /publish/campaigns/{id}

e.g. /publish/campaigns/{id}

Request Body schema: application/json
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

Responses

Response Headers
timezoneid
string
Location
string
Response Schema: application/json;charset=utf-8
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

Request samples

Content type
application/json
{
  • "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
    ]
}

Response samples

Content type
application/json;charset=utf-8
{
  • "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": [
    • {
      }
    ],
  • "attachments": [
    • {
      }
    ]
}

Delete Campaign

Authorizations:
apiKey
path Parameters
campaignId
required
string
Example: abc123

Campaign ID

Responses

Get Campaigns by resource ids

Authorizations:
apiKey
query Parameters
ids
string
Example: ids=abc123,def456

Comma separated list of resource ids

Responses

Response Schema: application/json;charset=utf-8
Array
resourceId
string
Array of objects

Response samples

Content type
application/json;charset=utf-8
[
  • {
    • "resourceId": "",
    • "items": [
      ]
    }
]

Add Stock to Campaign

Authorizations:
apiKey
path Parameters
campaignId
required
string
Example: abc123

Campaign ID

stockId
required
string
Example: def456

Stock ID

query Parameters
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.

Responses

Delete attachment from Campaign

Authorizations:
apiKey
path Parameters
campaignId
required
string
Example: abc123

Campaign ID

attachmentId
required
string
Example: def456

Attachment ID

Responses

Search Stocks

Authorizations:
apiKey
query Parameters
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.

Responses

Response Schema: application/json
items
Array of any
object

Response samples

Content type
application/json
{
  • "items": [
    • {
      }
    ],
  • "paging": {
    • "numberOfElements": 10,
    • "totalElements": 1000,
    • "pageSize": 10,
    • "pageNumber": 2,
    • "totalPages": 100,
    • "prev": {
      },
    • "next": {
      }
    }
}

Create an empty Stock

Authorizations:
apiKey
Request Body schema: application/json
title
required
string

Stock title.

embargoDate
string

Suggest the earliest schedule date when copied.

expirationDate
string

Suggest the latest time to copy this stock.

Responses

Response Headers
Location
string
Response Schema: application/json
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

Request samples

Content type
application/json
{
  • "title": "My first Stock",
  • "embargoDate": "2020-12-01T00:00:00Z",
  • "expirationDate": "2021-12-01T00:00:00Z"
}

Response samples

Content type
application/json
{
  • "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": [
    • {
      }
    ],
  • "orgId": 1
}

Create a Stock with Assets

Authorizations:
apiKey
Request Body schema: application/json
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

Responses

Response Headers
Location
string
Response Schema: application/json;charset=utf-8
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

Request samples

Content type
application/json
{
  • "title": "My first Stock",
  • "embargoDate": "2020-12-01T00:00:00Z",
  • "expirationDate": "2021-12-01T00:00:00Z",
  • "assets": [
    • null
    ]
}

Response samples

Content type
application/json;charset=utf-8
{
  • "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": [
    • {
      }
    ],
  • "orgId": 1
}

Archive a Stock

Authorizations:
apiKey
path Parameters
stockid
required
string
Example: a1b2c3d4e5f

Stock Id

Responses

Edit a Stock

Authorizations:
apiKey
path Parameters
stockid
required
string
Example: a1b2c3d4e5f

Stock Id

Request Body schema: application/json
title
required
string

Stock title.

embargoDate
string

Suggest the earliest schedule date when copied.

expirationDate
string

Suggest the latest time to copy this stock.

Responses

Response Schema: application/json
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

Request samples

Content type
application/json
{
  • "title": "My first Stock",
  • "embargoDate": "2020-12-01T00:00:00Z",
  • "expirationDate": "2021-12-01T00:00:00Z"
}

Response samples

Content type
application/json
{
  • "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": [
    • {
      }
    ],
  • "orgId": 1
}

Get a Stock

Authorizations:
apiKey
path Parameters
stockid
required
string
Example: a1b2c3d4e5f

Stock Id

Responses

Response Schema: application/json
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

Response samples

Content type
application/json
{
  • "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": [
    • {
      }
    ],
  • "orgId": 1
}

Delete a Stock

Authorizations:
apiKey
path Parameters
stockid
required
string
Example: a1b2c3d4e5f

Stock Id

Responses

Copy a Stock

Authorizations:
apiKey
path Parameters
stockId
required
string
Example: 7650eec0-ef38-4139-bce1-695e348aa3ce

Stock Id

Request Body schema: application/json
channelUuids
required
Array of any

Channel UUID, supports dashed and dashless UUIDs.

Responses

Response Headers
Location
string

Request samples

Content type
application/json
{
  • "channelUuids": [
    • "be839f380f6645db86281b67c45a8110",
    • "7650eec0-ef38-4139-bce1-695e348aa3ce"
    ]
}

Get Stock labels

Authorizations:
apiKey
path Parameters
stockid
required
string
Example: a1b2c3d4e5f

Stock Id

Responses

Response Schema: application/json
labels
Array of any

Response samples

Content type
application/json
{
  • "labels": [
    • {
      }
    ]
}

Add labels to a Stock

Authorizations:
apiKey
path Parameters
stockid
required
string
Example: a1b2c3d4e5f

Stock Id

Request Body schema: application/json
labelIds
Array of any

Responses

Request samples

Content type
application/json
{
  • "labelIds": [
    • 1,
    • 2,
    • 3
    ]
}

Remove labels from a Stock

Authorizations:
apiKey
path Parameters
stockid
required
string
Example: a1b2c3d4e5f

Stock Id

Request Body schema: application/json
labelIds
Array of any

Responses

Request samples

Content type
application/json
{
  • "labelIds": [
    • 1,
    • 2,
    • 3
    ]
}

Add a new Asset to a Stock

Authorizations:
apiKey
Request Body schema: application/json
required
object (AssetPayloadDto)
stockId
required
string

Responses

Response Headers
Location
string
Response Schema: application/json
id
string
stockId
string
createdAt
string
createdBy
string
modifiedAt
string
modifiedBy
string
orgId
number
required
object (AssetPayloadDto)

Request samples

Content type
application/json
{
  • "payload": {
    • "@type": "image"
    },
  • "stockId": "12345-abcde-12345-abcde"
}

Response samples

Content type
application/json
{
  • "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"
    }
}

Get all Assets by Stock ID

Authorizations:
apiKey
query Parameters
stockid
string
Example: stockid=a1b2c3d4e5f

Stock Id

Responses

Response Schema: application/json
items
Array of any

Response samples

Content type
application/json
{
  • "items": [
    • {
      }
    ]
}

Edit an Asset

Authorizations:
apiKey
path Parameters
assetId
required
string
Example: a1b2c3d4e5f

Asset Id

Request Body schema: application/json
required
object (AssetPayloadDto)

Responses

Response Schema: application/json
id
string
stockId
string
createdAt
string
createdBy
string
modifiedAt
string
modifiedBy
string
orgId
number
required
object (AssetPayloadDto)

Request samples

Content type
application/json
{
  • "payload": {
    • "@type": "image"
    }
}

Response samples

Content type
application/json
{
  • "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"
    }
}

Get an Asset

Authorizations:
apiKey
path Parameters
assetId
required
string
Example: a1b2c3d4e5f

Asset Id

Responses

Response Schema: application/json
id
string
stockId
string
createdAt
string
createdBy
string
modifiedAt
string
modifiedBy
string
orgId
number
required
object (AssetPayloadDto)

Response samples

Content type
application/json
{
  • "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"
    }
}

Delete an Asset

Authorizations:
apiKey
path Parameters
assetId
required
string
Example: a1b2c3d4e5f

Asset Id

Responses

Labels API

Labels API enables Brandwatch users to create, update, get and/or search for labels within their organization.

Create a label

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
name
required
string

Label name (max length: 100 characters)

color
string

The 6-charachters Hex color code

Responses

Response Schema: application/json;charset=utf-8
color
string
created_at
string
id
number
last_used
number
name
string
org_id
number
slug
string
times_used
number

Request samples

Content type
application/json;charset=utf-8
{
  • "name": "My Label",
  • "color": "FF0000"
}

Response samples

Content type
application/json;charset=utf-8
{
  • "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
}

Search labels

Authorizations:
apiKey
query Parameters
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 offset)

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

Responses

Response Schema: application/json;charset=utf-8
total
number
Array of objects

Response samples

Content type
application/json;charset=utf-8
{
  • "total": 167,
  • "labels": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

Get a label

Authorizations:
apiKey
path Parameters
label_id
required
number
Example: 1234

Numeric ID of the label to get its details

Responses

Response Schema: application/json;charset=utf-8
color
string
created_at
string
id
number
last_used
number
name
string
org_id
number
slug
string
times_used
number

Response samples

Content type
application/json;charset=utf-8
{
  • "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
}

Delete a label

Authorizations:
apiKey
path Parameters
label_id
required
number
Example: 1234

Numeric ID of the label to delete

Responses

Response Schema: application/json;charset=utf-8
color
string
created_at
string
id
number
last_used
number
name
string
org_id
number
slug
string
times_used
number

Response samples

Content type
application/json;charset=utf-8
{
  • "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
}

Engage API

Create Messages API

Engage's Create Messages API allows users to reply to content through our platform via this API.

Creating a new message

Authorizations:
apiKey
path Parameters
conversationId
required
string
Example: c7c77559-50b0-401e-aaa4-05189328d3a8 or c7c7755950b0401eaaa405189328d3a8

Provided in Engage Exported File

Request Body schema: application/json;charset=utf-8
parentId
string

The id of the comment to reply to

message
required
string

The message to create

required
object

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "parentId": "c7c77559-50b0-401e-aaa4-05189328d3a8|c7c7755950b0401eaaa405189328d3a8",
  • "message": "any text message",
  • "networkContext": {
    • "when the social network is Facebook": {
      },
    • "when the social network is Instagram": {
      },
    • "when the social network is YouTube": {
      },
    • "when the social network is WhatsApp": {
      },
    • "when the social network is X": {
      },
    • "when the social network is TikTok": {
      },
    • "when the. network is LinkedIn": {
      },
    • "when the social network is GoogleMyBusiness": {
      }
    }
}

Response samples

Content type
application/json;charset=utf-8
{
  • "uuid": "c7c77559-50b0-401e-aaa4-05189328d3a8"
}

Engage Export API

Engage Export API enables Brandwatch users to export the data from Engage.

Create an export

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
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.

Responses

Request samples

Content type
application/json;charset=utf-8
{
  • "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"
    ]
}

Response samples

Content type
application/json;charset=utf-8
{
  • "uuid": "c7c77559-50b0-401e-aaa4-05189328d3a8"
}

Get an export

Authorizations:
apiKey
path Parameters
uuid
required
string
Example: c7c77559-50b0-401e-aaa4-05189328d3a8

Export's uuid that is returned by "Created an export" endpoint.

Responses

Response Schema: application/json
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

Response samples

Content type
application/json
{}

Team Performance Metrics API

Engage Team Performance Metrics API enables Brandwatch users to export team performance metrics data from Engage.

Export metrics

Authorizations:
apiKey
Request Body schema: application/json;charset=utf-8
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.

Responses

Response Schema: application/json;charset=utf-8
object

Request samples

Content type
application/json;charset=utf-8
{
  • "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"
    ]
}

Response samples

Content type
application/json;charset=utf-8
{
  • "data": {
    • "users": [
      ],
    • "summary": {
      },
    • "created_at": "2025-04-01T11:47:59.050425Z"
    }
}

Measure API V2

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.

Get Channel Metrics Metadata Example

Authorizations:
apiKey
query Parameters
networks
string
Example: networks=facebook

... filter by network. Default: all.

Responses

Response Schema: application/json;charset=utf-8
Array of objects

Response samples

Content type
application/json;charset=utf-8
{
  • "data": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

Get CSV with supported metrics

Get CSV with supported channel metrics and Get CSV with supported content metrics share this endpoint; select using the query parameters below.

Authorizations:
apiKey
query Parameters
level
required
string
Enum: "channel" "content"

Responses

Request Channel Insights Example

Authorizations:
apiKey
Request Body schema: application/json
since
required
string
until
required
string
metricIds
required
Array of any
channelIds
required
Array of any

Responses

Response Schema: application/json;charset=utf-8
insightsRequestId
string

Request samples

Content type
application/json
{
  • "since": "2022-07-01",
  • "until": "2022-08-01",
  • "metricIds": [
    • "channel/impressions/day",
    • "channel/fans/day"
    ],
  • "channelIds": [
    • "b31a4b131f7c49d3990e62dc02f4577c",
    • "d31a4b131f7c49d3990e62dc02f4577c"
    ]
}

Response samples

Content type
application/json;charset=utf-8
{
  • "insightsRequestId": "284f5fa2-f304-4f6e-9485-20c7f0521f84"
}

Get Content Metrics Metadata Example

Authorizations:
apiKey
query Parameters
networks
string
Example: networks=TIKTOK

Responses

Response Schema: application/json;charset=utf-8
Array of objects

Response samples

Content type
application/json;charset=utf-8
{
  • "data": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

Request Content Insights Example

Authorizations:
apiKey
Request Body schema: application/json
since
required
string
until
required
string
metricIds
required
Array of any
channels
required
Array of any

Responses

Response Schema: application/json;charset=utf-8
insightsRequestId
string

Request samples

Content type
application/json
{
  • "since": "2022-07-01T00:00:00+01:00",
  • "until": "2022-08-01T00:00:00+01:00",
  • "metricIds": [
    • "content/comments/lifetime",
    • "content/impressions/lifetime"
    ],
  • "channels": [
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json;charset=utf-8
{
  • "insightsRequestId": "284f5fa2-f304-4f6e-9485-20c7f0521f84"
}

Get Insights Example

Authorizations:
apiKey
path Parameters
insightsRequestId
required
string
Example: c8f99aa7-a105-4328-93ed-c2ef1d0cc3f6
query Parameters
page
number
Example: page=1

Responses

Response Schema: application/json;charset=utf-8
One of
status
string
object

Response samples

Content type
application/json;charset=utf-8
Example
{
  • "status": "READY",
  • "data": {
    • "insights": {
      },
    • "paging": { }
    }
}

Benchmark API V1

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...).

Error Code Descriptions

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

Channel List Example

Authorizations:
apiKey

Responses

Response Schema: application/json;charset=utf-8
Array of objects

Response samples

Content type
application/json;charset=utf-8
{
  • "data": [
    • {
      },
    • {
      }
    ]
}

Add Channel Example

Authorizations:
apiKey
query Parameters
url
string
Example: url=https://www.instagram.com/brandwatch

Responses

Delete Channel Example

Authorizations:
apiKey
path Parameters
uuid
required
string
Example: 86e74dc3-db34-4c37-b6e7-fe5b5c6d464f

Responses

Channel Details Example

Authorizations:
apiKey
path Parameters
uuid
required
string
Example: 86e74dc3-db34-4c37-b6e7-fe5b5c6d464f

Responses

Response Schema: application/json;charset=utf-8
object

Response samples

Content type
application/json;charset=utf-8
{
  • "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"
    }
}

Get Custom Engagement Example

Authorizations:
apiKey

Responses

Response Schema: application/json;charset=utf-8
orgId
number
Array of objects
customized
boolean

Response samples

Content type
application/json;charset=utf-8
{
  • "orgId": 1,
  • "metrics": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "customized": true
}

Channel Feed Example

Authorizations:
apiKey
Request Body schema: application/json
since
required
string
until
required
string
channelId
required
string
sortBy
string

Responses

Request samples

Content type
application/json
{
  • "since": "2024-07-01",
  • "until": "2024-08-01",
  • "channelId": "a8d5e3ab-a71a-460b-bf99-5a28e6a1cb93",
  • "sortBy": "engagement"
}

Channel Metrics Example

Authorizations:
apiKey
Request Body schema: application/json
since
required
string
until
required
string
channelId
required
string

Responses

Request samples

Content type
application/json
{
  • "since": "2024-07-01",
  • "until": "2024-08-01",
  • "channelId": "1265268f-4ade-4980-979a-de8811b3424c"
}

Channel Metrics for Followers Example

Authorizations:
apiKey
Request Body schema: application/json
since
required
string
until
required
string
channelId
required
string

Responses

Request samples

Content type
application/json
{
  • "since": "2024-07-01",
  • "until": "2024-08-01",
  • "channelId": "1265268f-4ade-4980-979a-de8811b3424c"
}

Channel Metrics for Posts Example

Authorizations:
apiKey
Request Body schema: application/json
since
required
string
until
required
string
channelId
required
string

Responses

Request samples

Content type
application/json
{
  • "since": "2024-07-01",
  • "until": "2024-08-01",
  • "channelId": "1265268f-4ade-4980-979a-de8811b3424c"
}

Channel Metrics for Engagement Example

Authorizations:
apiKey
Request Body schema: application/json
since
required
string
until
required
string
channelId
required
string

Responses

Request samples

Content type
application/json
{
  • "since": "2024-07-01",
  • "until": "2024-08-01",
  • "channelId": "1265268f-4ade-4980-979a-de8811b3424c"
}

Integrations Data Platform API

Integrations Data Platform API provides access to the exported data sets. Currenly only Measure metrics for channels are supported in a flat data list.

DataSetGroup List Example

Authorizations:
apiKey

Responses

Get DataSetGroup Example

Authorizations:
apiKey
path Parameters
datasetGroupId
required
string
Example: 393ce0e3-36e5-4742-a88a-2196efd6b10f

Responses

Get Channel Metrics Example

Authorizations:
apiKey
query Parameters
page
number
Example: page=0
size
number
Example: size=20

Responses