Facebook Developers
DocsToolsSupportNewsApps
Log In
  • Social Plugins
  • Facebook Login
  • Open Graph
  • Facebook APIs
  • Games
  • Payments
  • App Center
  • Promote Your App
  • iOS
  • Android
  • JavaScript
  • PHP
  • More SDKs
  • Getting Started
    • Apps on Facebook Overview
    • Canvas Tutorial
    • Games on Facebook Tutorial
    • 1 - Authenticate
    • 2 - Personalize
    • 3 - Invites and Requests
    • 4 - Bragging and News Feed
    • 5 - Publish Open Graph
  • Best Practices
    • Integrating with Canvas
  • How Tos
    • Fluid Canvas
    • Feed Gaming
    • Flash wmode
  • Reference
    • fb_source Parameter

fb_source Parameter

Documentation › fb_source Parameter

This document lists the complete list of values for the fb_source parameter that is returned with the url when the user visits your app from some location on www.facebook.com like bookmarks, feed or timeline. Developers can use this parameter to better understand where their traffic is coming from so that they can better optimize their Facebook integration.

We also surface this data in your app's insights. You can find this data by navigating to the 'Users' section of insights as shown below.

If you scroll to the bottom of the 'Users' section of insights you will see a subsection under 'Referrals' which contains a list of the fb_source parameters designating your sources of traffic on Facebook.com during the designated time period.

List of Parameter Values

Canvas bookmarks

This list refers to the set of fb_source parameters returned when a user clicks on the bookmarks on the canvas page.

NameDescription of Where SurfacedMore Info
canvasbookmarkThe canvasbookmark reference can be found when your app is visited from a bookmark located on a canvas page (i.e. from apps.facebook.com/*).More Info
canvasbookmark_moreThe canvasbookmark_more reference can be found when a user hovers over the card icon bookmark on a canvas page, and selects your app from the dropdown that is rendered.More Info
canvasbookmark_recommendedThe canvasbookmark_recommended reference can be found when a user is brought to your app via the recomendations sectionMore Info

Homepage bookmarks

This list refers to the set of fb_source parameters returned when a user clicks on the bookmarks on the user's homepage.

NameDescription of Where SurfacedMore Info
bookmark_appsThis reference can be found when your app is visited from a bookmark on the user's homepage under the 'apps' section. We recently fixed a bug that corrected values set to bookmarks_apps, properly setting them to bookmark_apps. Note: Some remaining data from this bug is still visible in insights.More Info
bookmark_favoritesThis reference can be found when your app is visited from a bookmark on the user's homepage under the 'favorites' section.More Info
bookmark_seeallThis reference can be found when the user clicks the 'more' link found in the 'apps' section of their bookmarks (which takes the user to the bookamrk details page), and then then visits your app from a bookmark found on that page.More Info

App Center

This list refers to the set of fb_source parameters returned when a user installs apps from the App Center.

NameDescription of Where SurfacedMore Info
appcenterWhen a user installs an app from the App Center homepage, category pages or an App Detail page, we set the fb_source value to appcenter.More Info
appcenter_requestWhen a user clicks on a request from within App Center, we set the fb_source value to appcenter_request.More Info
dashboard_toplistThe dashboard_toplist value can be found when a user is brought to your app through the list of top apps in the old app dashboard.More Info

News feed

This list refers to the set of fb_source parameters returned when a user clicks on a News feed story on the Homepage.

NameDescription of Where SurfacedMore Info
feed_highscoreThe feed_highscore value can be found in a highscore story for games that is rendered in the newsfeed.More Info
feed_musicThe feed_music value of fb_source designates that the story clicked by the user was a music related story.More Info
feed_opengraphThe feed_opengraph value of fb_source covers all other open graph instances beyond the common actions such as scored, achieved, read, watched, listened and will be included in your stories when publishing custom actions.More Info
feed_passingIf your app is using the scores API, we can generate passing stories when one of your users passes their friend. This feed_passing value for fb_source designates traffic coming these stories.More Info
feed_playingFacebook will automatically generate 'is playing' stories for a user who visits your app when social discovery is enabled and your app is categorized as a game. These stories contain the feed_playing fb_source to designate this traffic.More Info
feed_videoThe feed_video value can be found from any video story rendered in newsfeed.More Info

Ticker

This list refers to the set of fb_source parameters returned when a user clicks on a story in the Ticker.

NameDescription of Where SurfacedMore Info
tickerIf a user is brought to your app by any ticker story, we add the fb_source value of ticker to the URL.More Info

Timeline

This list refers to the set of fb_source parameters returned when a user clicks on a story in the user's Timeline.

NameDescription of Where SurfacedMore Info
timeline_ogWhen a user is brought to your app via a timeline Open Graph story, we add the timeline_og value to fb_source.More Info
timeline_newsWhen a user is brought to your app via a news timeline story, we add the timeline_news value to fb_source.More Info
timeline_passingWhen a user is brought to your app via a scores passing timeline story, we add the timeline_passing value to fb_source.More Info
timeline_recentWhen a user is brought to your app via a link in the recent activity section on timeline, then we add the timeline_recent value to fb_source.More Info

Misc.

This list refers to the set of fb_source parameters returned when a user clicks on some other miscellaneous places on the site like notifications, hovercards etc.

NameDescription of Where SurfacedMore Info
searchThe search bar at the top of Facebook.com can be used to find users, pages and apps. If a user searches for your app and then clicks through on a result, we will add on the search fb_source parameter.More Info
remindersAt the top of the right hand column on the News Feed, we will surface reminders for commonly used applications. These appear near birthday reminders, pokes, and other notifications. Clicks from here will have the reminders fb_source parameter appended.More Info
hovercardWe render hovercards for many links found around the site. If user reached your app through one of these hovercards, we will add on the hovercard fb_source parameter.More Info
notificationWhen a user is brought to your app via a notification, we add on the notification fb_source value.More Info
egoThe can be found when a user is brought to your app through the list of suggested apps in the ego unit found in the apps dashboard area.More Info
other_multilineThe can be found when a user is brought to your app through an open graph multi-line story. Currently this fb_source param can be found in stories on timeline, ticker and newsfeed.More Info

Details

This section provides more details and screenshots to help developers better understand where the clicks are coming from.

canvasbookmark

This reference can be found when your app is visited from a bookmark located on a canvas page (i.e. from apps.facebook.com/*).

canvasbookmark_more

This reference can be found when a user hovers over the card icon bookmark on a canvas page, and selects your app from the dropdown that is rendered.

canvasbookmark_recommended

The canvasbookmark_recommended reference can be found when a user is brought to your app via the recomendations section

bookmark_apps

This reference can be found when your app is visited from a bookmark on the user's homepage under the 'apps' section. We recently fixed a bug that corrected values set to bookmarks_apps, properly setting them to bookmark_apps. Note: Some remaining data from this bug is still visible in insights.

bookmark_favorites

This reference can be found when your app is visited from a bookmark on the user's homepage under the 'favorites' section.

bookmark_seeall

This reference can be found when the user clicks the 'more' link found in the 'apps' section of their bookmarks (which takes the user to https://www.facebook.com/bookmarks/apps), and then then visits your app from a bookmark found on that page.

Step 1

Step 2

dashboard_toplist

The dashboard_toplist value can be found when a user is brought to your app through the list of top apps in the app dashboard.

ego

The can be found when a user is brought to your app through the list of suggested apps in the ego unit found on the side of the app dashboard.

other_multiline

The can be found when a user is brought to your app through an open graph multi-line story. Currently this fb_source param can be found in stories on timeline, ticker and newsfeed.

feed_achievement

The feed_achievement value can be found when a user clicks on a achievement story by your app from within the newsfeed.

feed_highscore

This can be found in a highscore story for games that is rendered in the newsfeed.

feed_music

The feed_music value of fb_source designates that the story clicked by the user was a music related story.

feed_opengraph

The feed_opengraph value of fb_source covers all other open graph instances beyond the common actions such as scored, achieved, read, watched, listened and will be included in your stories when publishing custom actions.

feed_passing

If your app is using the scores API, we can generate passing stories when one of your users passes their friend. This feed_passing value for fb_source designates traffic coming these stories.

feed_playing

Facebook will automatically generate 'is playing' stories for a user who visits your app when social discovery is enabled and your app is categorized as a game. These stories contain the feed_playing fb_source to designate this traffic.

feed_video

The feed_video value can be found from any video story rendered in newsfeed.

search

When a user finds your app by entering a search query in the search bar and then clicks on a result, we will add the search fb_source parameter.

Search

reminders

In News Feed, on the top of the right hand navigation column, we will surface reminders from frequently used applications. Clicks through from these reminders will contain the reminders fb_source parameter.

Reminders

hovercard

We render hovercards for many links found around the site. If user reached your app through one of these hovercards, we will add on the hovercard fb_source parameter.

notification

When a user is brought to your app via a notification, we add on the notification fb_source value in the two places shown below.

appcenter

When a user clicks to visit an app on either the App Center homepage, category page or an App Detail page, the appcenter fb_source is appended. For example, in the image below, the Play Game button will have this fb_source.

App Center Requests

appcenter_request

When a user clicks on a request from within App Center, we set the fb_source value to appcenter_request.

App Center Requests

ticker

If a user is brought to your app by a story from ticker that is not covered by another ticker_* value, we add the fb_source value of ticker to the URL.

timeline_og

When a user is brought to your app via a timeline open graph story, we add the timeline_og value to fb_source. Note this only appears when using custom actions, all others should be covered explicitly.

timeline_news

When a user is brought to your app via a timeline news story, we add the timeline_news value to fb_source.

timeline_passing

When a user is brought to your app via a timeline scores passing story, we add the timeline_passing value to fb_source.

timeline_recent

When a user is brought to your app via a timeline achievement story, we add the timeline_achievement value to fb_source.

Updated about 2 months ago
Facebook © 2013 · English (US)
AboutAdvertisingCareersPlatform PoliciesPrivacy Policy