Welcome to the Fanpage Karma JSON-based RESTful API.

Here you get all the information you need to use our API. This documentation is available at:

GENERAL INFORMATION:

The URLs of our API have the following general structure:
https://www.fanpagekarma.com/api/ {VERSION} / {NETWORK} / {PROFILE_ID} / {TASK} ?token= {TOKEN}

VERSION:

There is only version 1 so far:
/v1

NETWORK:

There are six supported networks. Click on the links for more information about the networks.
/facebook Facebook
/twitter Twitter
/gplus Google+
/instagram Instagram
/pinterest Pinterest
/youtube YouTube

PROFILE_ID:

The profile ID specifies the object of the network. We use the same IDs for the profiles as the networks themselves.

Note: Use Page-Ids, not Page-Names. (For Pinterest the profile ID is the profile's name.)

TASK:

The task specifies what kind of data you want to get for the given profile ID and network.

TOKEN:

To access our service you need a valid token, which you add as a parameter to your requests.

JSON-Object:

Every JSON-object we return contains precisely two elements. A JSON-object called data and a JSON-object called metadata. The data-object contains the data of your request where the metadata-object contains information about your request. A JSON-object may look like:
{ "data" :
{ "{NAME_OF_PROPERTY}" :
{ "title" : "xyz",
"value" : 0.123,
"formatted_value" : "12%"
},
...
},
"metadata" :
{ "version" : "v1",
"network" : "facebook",
"profile_id" : "6815841748",
"profile_name" : "Barack Obama",
"task" : "kpi",
"token" : "abcdefghijklmnopqrstuvwxyz",
"date_from" : "Tue Jan 27 00:00:00 UTC 2015",
"date_until" : "Mon Feb 23 23:59:59 UTC 2015",
"message" : "Optional message."
}
}

FACEBOOK

The general structure of API-URLs to access the network Facebook is:
www.fanpagekarma.com/api/v1/facebook/ {PROFILE_ID} / {TASK} ?token= {TOKEN}

Facebook-Tasks:

Here is a detailed description of all available tasks for the network Facebook:
Task: /kpi
Title: Key Performance Indicators
URL structure: www.fanpagekarma.com/api/v1/facebook/ {PROFILE_ID} /kpi?token= {TOKEN}
Description:

The task /kpi returns the Key Performance Indicators of the Facebook profile for the given {PROFILE_ID}. These are basically all the numbers and details you see in your Dashboard.

Note: It depends on your {TOKEN}'s permissions which Key Performance Indicators will be returned.

Example: www.fanpagekarma.com/api/v1/facebook/6815841748/kpi?token=abcdefghijklmnopqrstuvwxyz
Elements of the data-object:
"{NAME_OF_PROPERTY}" :
{ "title" : "Title of the Key Performance Indicator",
"value" : Value of the Key Performance Indicator,
"formatted_value" : "Rounded value with unit of the Key Performance Indicator"
}
Description of the elements of the data-object:
{NAME_OF_PROPERTY} title
page_engagement Engagement
page_post_interaction Post interaction
page_weighted_engagement Weighted Engagement
page_weighted_post_interaction Weighted Post-Interaction
page_total_engagement_count Total Reactions, Comments, Shares
user_posts_total_engagement_count User posts total Reactions, Comments, Shares
page_posts_likes_count Number of Likes
page_posts_comments_count Number of Comments
page_posts_shares_count Number of Shares
page_posts_reactions Number of Reactions
page_posts_reactions_love Number of Love
page_posts_reactions_wow Number of Wow
page_posts_reactions_haha Number of Haha
page_posts_reactions_sorry Number of Sad
page_posts_reactions_anger Number of Angry
page_posts_reactions_thankful Number of Thankful
page_posts_count Number of posts
page_posts_per_day Posts per day
page_performance_index Page Performance Index
page_ad_value Ad-Value (EUR)
page_picture_posts_count Picture Posts
page_video_posts_count Video-post
page_link_posts_count Link-posts
page_answered_user_posts_count Posts by fans with comment by page
page_user_posts_with_page_reaction_count Posts by fans with reaction of page
facebook_video_total_engagement_count Total Reactions, Comments, Shares of Facebook-Videos
facebook_video_reactions_count Number of Reactions of Facebook-Videos
facebook_video_likes_count Number of Likes of Facebook-Videos
facebook_video_love_count Number of Love of Facebook-Videos
facebook_video_wow_count Number of Wow of Facebook-Videos
facebook_video_haha_count Number of Haha of Facebook-Videos
facebook_video_sorry_count Number of Sad of Facebook-Videos
facebook_video_anger_count Number of Angry of Facebook-Videos
facebook_video_thankful_count Number of Thankful of Facebook-Videos
facebook_video_comments_count Number of Comments of Facebook-Videos
facebook_video_shares_count Number of Shares of Facebook-Videos
facebook_video_total_count Facebook-Videos
page_posts_likes_count_per_post Likes per post
page_posts_comments_count_per_post Comments per post
page_posts_shares_count_per_post Shares per post
page_posts_reactions_per_post Reactions per post
page_posts_reactions_love_per_post Love per post
page_posts_reactions_wow_per_post Wow per post
page_posts_reactions_haha_per_post Haha per post
page_posts_reactions_sorry_per_post Sad per post
page_posts_reactions_anger_per_post Angry per post
page_posts_reactions_thankful_per_post Thankful per post
page_user_posts_count Posts by fans
page_user_posts_comments_count Comments on posts by fans
page_user_posts_per_day User posts per day
page_service_level Service Level
page_response_time Response time
page_picture_clicks_per_post Picture-clicks per picture post
page_picture_clicks_per_day Picture-clicks of picture posts per day
page_picture_clicks_count Picture-clicks of picture posts
page_picture_clicks_divided_by_reach_per_day Picture-clicks of picture posts per person reached
page_link_video_clicks_per_post Picture, video and link-clicks per post
page_link_video_clicks_per_day Picture, video and link-clicks per day
page_link_video_clicks_count Picture, video and link-clicks
page_link_video_clicks_divided_by_reach_per_day Picture, video and link-clicks per reached person
page_link_clicks_per_post Link-clicks per link-post
page_link_clicks_per_day Link-clicks of link-posts per day
page_link_clicks_count Link-clicks of link-posts
page_link_clicks_divided_by_reach_per_day Link-clicks of link-posts per reached person (CTR)
page_video_clicks_per_post Video-clicks per Video-post
page_video_clicks_count Video-clicks of Video-posts
page_video_clicks_divided_by_reach_per_day Video-clicks of Video-posts per reached person
page_video_clicks_per_day Video-clicks of Video-posts per day
page_negative_feedback_per_post Negative Feedback per post
page_negative_feedback_per_day Negative Feedback per day
page_negative_feedback_count Negative Feedback
page_negative_feedback_divided_by_reach_per_day Negative Feedback per reached person
page_posts_impressions Sum of total impressions of single posts
page_posts_impressions_unique Sum of reach of single posts
page_posts_impressions_paid_unique Sum of reach (paid) of single posts
page_posts_impressions_viral_unique Sum of reach (viral) of single posts
page_posts_impressions_organic_unique Sum of reach (organic) of single posts
page_posts_impressions_unique_per_post Average reach of single posts
page_posts_impressions_divided_by_fans_per_post Post impressions per post per fan
page_posts_impressions_unique_divided_by_fans_per_post Post reach per post per fan
page_posts_impressions_organic_unique_divided_by_fans_per_post Post reach (organic) per post per fan
page_posts_impressions_paid_unique_divided_by_fans_per_post Post reach (paid) per post per fan
page_posts_impressions_viral_unique_divided_by_fans_per_post Post reach (viral) per post per fan
post_impressions_fan Post impressions to fans
post_impressions_fan_unique Post reach to fans
post_impressions_fan_paid Post impressions to fans (paid)
post_impressions_fan_paid_unique Post reach to fans (paid)
post_engaged_fan Fans engaged with posts
post_fan_reach Post reach of fans
post_impressions_fan_per_day Post impressions to fans per day
post_impressions_fan_unique_per_day Post reach to fans per day
post_impressions_fan_paid_per_day Post impressions to fans (paid) per day
post_impressions_fan_paid_unique_per_day Post reach to fans (paid) per day
post_engaged_fan_per_day Fans engaged with posts per day
post_fan_reach_per_day Post reach of fans per day
post_impressions_fan_per_post Post impressions to fans per post
post_impressions_fan_unique_per_post Post reach to fans per post
post_impressions_fan_paid_per_post Post impressions to fans (paid) per post
post_impressions_fan_paid_unique_per_post Post reach to fans (paid) per post
post_engaged_fan_per_post Fans engaged with posts per post
post_fan_reach_per_post Post reach of fans per post
page_interactions_divided_by_reach_per_post Interaction per reached person per post
page_weighted_interactions_divided_by_reach_per_post Interaction (weighted) per reached person per post
page_interactions_and_link_clicks_divided_by_reach_per_post Likes, comments, shares and link clicks per reached person per post
page_interactions_divided_by_reach_per_day Interaction per reached person per day
page_weighted_interactions_divided_by_reach_per_day Interaction (weighted) per reached person per day
page_interactions_and_link_clicks_divided_by_reach_per_day Likes, comments, shares and link clicks per reached person per day
page_interactions_and_link_clicks_divided_by_fans_per_day Likes, comments, shares and link clicks per fan per day
page_interactions_and_link_clicks_divided_by_fans_per_post Likes, comments, shares and link clicks per fan per post
facebook_video_views_organic Organic views of Facebook-Videos
facebook_video_views_organic_unique Unique organic views of Facebook-Videos
facebook_video_views_paid Paid views of Facebook-Videos
facebook_video_views_paid_unique Unique paid views of Facebook-Videos
facebook_video_views_total Total views of Facebook-Videos
facebook_video_views_total_unique Unique views of Facebook-Videos
facebook_video_views_complete_organic Complete organic views of Facebook-Videos
facebook_video_views_complete_organic_unique Complete unique organic views of Facebook-Videos
facebook_video_views_complete_paid Complete paid views of Facebook-Videos
facebook_video_views_complete_paid_unique Complete unique paid views of Facebook-Videos
facebook_video_views_complete_total Complete views of Facebook-Videos
facebook_video_views_complete_total_unique Complete unique views of Facebook-Videos
facebook_video_bounce_rate Bounce rate of Facebook-Videos
facebook_video_average_length_view Average length viewed of Facebook-Videos (in sec)
facebook_video_length Total length of Facebook-Videos (in sec)
facebook_video_views_autoplayed Autoplayed views of Facebook-Videos
facebook_video_views_sound_on Sound on views of Facebook-Videos
facebook_video_view_time View time of Facebook-Video (in sec)
facebook_video_view_organic View time organic of Facebook-Video (in sec)
facebook_video_views_10s_unique 10s unique views of Facebook-Videos
facebook_video_views_10s_autoplayed 10s autoplayed views of Facebook-Videos
facebook_video_views_10s_clicked_to_play 10s clicked to play views of Facebook-Videos
facebook_video_views_10s_organic 10s organic views of Facebook-Videos
facebook_video_views_10s_paid 10s paid views of Facebook-Videos
facebook_video_views_10s_sound_on 10s sound on views of Facebook-Videos
page_fans Number of fans
page_fans_growth_absolute Growth (absolute)
page_fans_weekly_growth_rate Average Weekly Growth
page_fans_growth_percent Daily Growth (in %)
page_fans_growth_percent_since_first_date Percentage increase since starting point
page_fans_growth_absolute_per_day Growth (absolute) per day
page_views Page Visits
page_views_per_day Page views per day
page_engaged_users_unique People Engaged
page_engaged_users_divided_by_impressions_unique_per_day Persons with interaction per reached person per day
page_engaged_users_per_day Persons with interaction per day
page_impressions Total impressions
page_impressions_unique Total reach
page_impressions_organic_unique Total reach (organic)
page_impressions_paid_unique Total reach (paid)
page_impressions_viral_unique Total reach (viral)
page_impressions_per_day Total impressions per day
page_impressions_paid_unique_per_day Total reach (paid) per day
page_impressions_organic_unique_per_day Total reach (organic) per day
page_impressions_unique_per_day Total reach per day
page_impressions_viral_unique_per_day Total reach (viral) per day
page_impressions_divided_by_fans_per_day Total impressions per fan per day
page_impressions_unique_divided_by_fans_per_day Total reach per fan per day
page_impressions_paid_unique_divided_by_fans_per_day Total reach (paid) per fan per day
page_impressions_organic_unique_divided_by_fans_per_day Total reach (organic) per fan per day
page_impressions_viral_unique_divided_by_fans_per_day Total reach (viral) per fan per day
page_posts_impressions_daily Post impressions
page_posts_impressions_daily_unique Post reach
page_posts_impressions_organic_daily_unique Post reach (organic)
page_posts_impressions_daily_paid_unique Post reach (paid)
page_posts_impressions_viral_daily_unique Post reach (viral)
page_posts_impressions_per_day Post impressions per day
page_posts_impressions_unique_per_day Post reach per day
page_posts_impressions_organic_unique_per_day Post reach (organic) per day
page_posts_impressions_paid_unique_per_day Post reach (paid) per day
page_posts_impressions_viral_unique_per_day Post reach (viral) per day
page_posts_impressions_divided_by_fans_per_day Post impressions per fan per day
page_posts_impressions_unique_divided_by_fans_per_day Post reach per fan per day
page_posts_impressions_organic_unique_divided_by_fans_per_day Post reach (organic) per fan per day
page_posts_impressions_paid_unique_divided_by_fans_per_day Post reach (paid) per fan per day
page_posts_impressions_viral_unique_divided_by_fans_per_day Post reach (viral) per fan per day
page_video_views Total video views in period
page_video_views_paid Paid video views in period
page_video_views_unique Unique video views in period
page_video_views_autoplayed Autoplayed video views in period
page_video_complete_views_30s Total video views of at least 30 sec in period
page_video_complete_views_30s_unique Unique video views of at least 30 sec in period
page_video_complete_views_30s_autoplayed Autoplayed video views of at least 30 sec in period

TWITTER

The general structure of API-URLs to access the network Twitter is:
www.fanpagekarma.com/api/v1/twitter/ {PROFILE_ID} / {TASK} ?token= {TOKEN}

Twitter-Tasks:

Here is a detailed description of all available tasks for the network Twitter:
Task: /kpi
Title: Key Performance Indicators
URL structure: www.fanpagekarma.com/api/v1/twitter/ {PROFILE_ID} /kpi?token= {TOKEN}
Description: The task /kpi returns the Key Performance Indicators of the Twitter profile for the given {PROFILE_ID}. These are essentially all the numbers and details you see in your Dashboard.
Example: www.fanpagekarma.com/api/v1/twitter/813286/kpi?token=abcdefghijklmnopqrstuvwxyz
Elements of the data-object:
"{NAME_OF_PROPERTY}" :
{ "title" : "Title of the Key Performance Indicator",
"value" : Value of the Key Performance Indicator,
"formatted_value" : "Rounded value with unit of the Key Performance Indicator"
}
Description of the elements of the data-object:
{NAME_OF_PROPERTY} title
profile_followers Follower
profile_followers_growth_absolute Daily Growth (absolute)
profile_followers_weekly_growth_rate Average Weekly Growth
profile_followers_growth_percent Growth rate
profile_followers_growth_percent_since_first_date Percentage increase since starting point
profile_tweets Tweets
profile_retweets Retweets
profile_favorites Number of likes
profile_retweets_and_favorited Retweets & likes
profile_retweets_per_post Retweets per tweet
profile_favorites_per_post Number of likes per tweet
profile_conversations_ratio Conversations
profile_retweeted_count Retweeted
profile_tweets_per_day Tweets/day
profile_engagement Engagement
profile_tweet_interaction Tweet Interaction
profile_performance_index Profile Performance Index

GOOGLE+

The general structure of API-URLs to access the network Google+ is:
www.fanpagekarma.com/api/v1/gplus/ {PROFILE_ID} / {TASK} ?token= {TOKEN}

Google+-Tasks:

Here is a detailed description of all available tasks for the network Google+:
Task: /kpi
Title: Key Performance Indicators
URL structure: www.fanpagekarma.com/api/v1/gplus/ {PROFILE_ID} /kpi?token= {TOKEN}
Description: The task /kpi returns the Key Performance Indicators of the Google+ profile for the given {PROFILE_ID}. These are essentially all the numbers and details you see in your Dashboard.
Example: www.fanpagekarma.com/api/v1/gplus/110031535020051778989/kpi?token=abcdefghijklmnopqrstuvwxyz
Elements of the data-object:
"{NAME_OF_PROPERTY}" :
{ "title" : "Title of the Key Performance Indicator",
"value" : Value of the Key Performance Indicator,
"formatted_value" : "Rounded value with unit of the Key Performance Indicator"
}
Description of the elements of the data-object:
{NAME_OF_PROPERTY} title
profile_followers Follower
profile_followers_weekly_growth_rate Follower Growth (weekly, in %)
profile_followers_growth_absolute Follower Growth (absolute)
profile_followers_growth_percent Follower Growth (in %)
profile_followers_growth_since_first_date Follower Growth since starting point (in %)
profile_plus_one Page +1
profile_plus_one_growth_absolute Page +1 Growth (absolute)
profile_plus_one_growth_percent Page +1 Growth (in %)
profile_plus_one_growth_percent_since_first_date Page +1 Growth since starting point (in %)
profile_engagement Engagement
profile_profile_activity_interaction Post Interaction
profile_activities_total_engagement Total +1, comments and shares on posts
profile_activities_total_plus_one Total +1 on posts
profile_activities_total_comments_count Total comments
profile_activities_total_shares_count Total shares
profile_activities_count Number of posts
profile_activities_plus_one_per_post +1 per post
profile_activities_comments_count_per_post Comments per post
profile_activities_shares_count_per_post Shares per post
profile_activities_per_day Posts per day
profile_performance_index Page Performance Index

INSTAGRAM

The general structure of API-URLs to access the network Instagram is:
www.fanpagekarma.com/api/v1/instagram/ {PROFILE_ID} / {TASK} ?token= {TOKEN}

Instagram-Tasks:

Here is a detailed description of all available tasks for the network Instagram:
Task: /kpi
Title: Key Performance Indicators
URL structure: www.fanpagekarma.com/api/v1/instagram/ {PROFILE_ID} /kpi?token= {TOKEN}
Description: The task /kpi returns the Key Performance Indicators of the Instagram profile for the given {PROFILE_ID}. These are essentially all the numbers and details you see in your Dashboard.
Example: www.fanpagekarma.com/api/v1/instagram/10206720/kpi?token=abcdefghijklmnopqrstuvwxyz
Elements of the data-object:
"{NAME_OF_PROPERTY}" :
{ "title" : "Title of the Key Performance Indicator",
"value" : Value of the Key Performance Indicator,
"formatted_value" : "Rounded value with unit of the Key Performance Indicator"
}
Description of the elements of the data-object:
{NAME_OF_PROPERTY} title
profile_followers Follower
profile_followings Following
profile_media_count Number of Posts
profile_likes_count Likes
profile_comments_count Comments
profile_comments_likes_count Comments and Likes
profile_likes_count_per_post Likes per post
profile_comments_count_per_post Comments per post
profile_followers_weekly_growth_rate Follower Growth (weekly, in %)
profile_followers_growth_absolute Daily Growth (absolute)
profile_followers_growth_percent Growth rate
profile_followers_growth_since_first_date Percentage increase since starting point
profile_followers_followings_ratio Followers-Following-Ratio
profile_engagement Engagement
profile_media_interaction Post Interaction
profile_media_per_day Posts per day
profile_performance_index Profile Performance Index

PINTEREST

The general structure of API-URLs to access the network Pinterest is:
www.fanpagekarma.com/api/v1/instagram/ {PROFILE_NAME} / {TASK} ?token= {TOKEN}

Pinterest-Tasks:

Here is a detailed description of all available tasks for the network Instagram:
Task: /kpi
Title: Key Performance Indicators
URL structure: www.fanpagekarma.com/api/v1/instagram/ {PROFILE_NAME} /kpi?token= {TOKEN}
Description: The task /kpi returns the Key Performance Indicators of the Pinterest profile for the given {PROFILE_NAME}. These are essentially all the numbers and details you see in your Dashboard.
Example: www.fanpagekarma.com/api/v1/pinterest/barackobama/kpi?token=abcdefghijklmnopqrstuvwxyz
Elements of the data-object:
"{NAME_OF_PROPERTY}" :
{ "title" : "Title of the Key Performance Indicator",
"value" : Value of the Key Performance Indicator,
"formatted_value" : "Rounded value with unit of the Key Performance Indicator"
}
Description of the elements of the data-object:
{NAME_OF_PROPERTY} title
pinner_follower_count Follower
pinner_followings_count Following
pinner_board_count Boards
pinner_update_count Number of Pins
pinner_done_created_count Has tried
pinner_pins_likes_count Likes
pinner_pins_repins_count Repins
pinner_pins_saves_total_count Saves total
pinner_pins_saves_own_count Saves of own Pins
pinner_pins_comments_count Comments
pinner_pins_comments_repins_done_count Comments, Repins and tried it
pinner_pins_comments_likes_repins_count Comments, Likes and Repins
pinner_pins_done_count Tried it
pinner_pins_comments_saves_own_count Comments and saves of own Pins
pinner_pins_comments_saves_own_done_count Comments, saves of own Pins and tried it
pinner_pins_rating_count Rating
pinner_pins_likes_count_per_post Likes per Pin
pinner_pins_repins_count_per_post Repins per Pin
pinner_pins_comments_count_per_post Comments per Pin
pinner_pins_saves_total_count_per_post Saves total per Pin
pinner_pins_saves_own_count_per_post Saves of own Pins per Pin
pinner_pins_didit_count_per_post Tried it per Pin
pinner_pins_reaction_count Reactions per post
pinner_pins_original_repin_ratio Original-Repin-Ratio
profile_followers_weekly_growth_rate Follower Growth (weekly, in %)
profile_followers_growth_absolute Daily Growth (absolute)
profile_followers_growth_percent Growth rate
profile_followers_growth_since_first_date Percentage increase since starting point
profile_followers_followings_ratio Followers-Following-Ratio
pinner_engagement Engagement
pinner_updates_interaction Post Interaction
pinner_update_count_per_day Pins per day
pinner_performance_index Profile Performance Index

YOUTUBE

The general structure of API-URLs to access the network YouTube is:
www.fanpagekarma.com/api/v1/youtube/ {PROFILE_ID} / {TASK} ?token= {TOKEN}

YouTube-Tasks:

Here is a detailed description of all available tasks for the network YouTube:
Task: /kpi
Title: Key Performance Indicators
URL structure: www.fanpagekarma.com/api/v1/youtube/ {PROFILE_ID} /kpi?token= {TOKEN}
Description: The task /kpi returns the Key Performance Indicators of the YouTube profile for the given {PROFILE_ID}. These are essentially all the numbers and details you see in your Dashboard.
Example: www.fanpagekarma.com/api/v1/youtube/UCdn86UYrf54lXfVli9CB6Aw/kpi?token=abcdefghijklmnopqrstuvwxyz
Elements of the data-object:
"{NAME_OF_PROPERTY}" :
{ "title" : "Title of the Key Performance Indicator",
"value" : Value of the Key Performance Indicator,
"formatted_value" : "Rounded value with unit of the Key Performance Indicator"
}
Description of the elements of the data-object:
{NAME_OF_PROPERTY} title
channel_subscribers_count Total number of subscribers
channel_videos_count Number of videos
channel_video_view_count Number of total Video Views
channel_likes_count Likes
channel_dislikes_count Dislikes
channel_likes_dislikes_ratio Likes / Dislikes
channel_comments_count Comments
channel_likes_count_per_post Likes per video
channel_dislikes_count_per_post Dislikes per video
channel_comments_count_per_post Comments per video
channel_views_per_video Views per Video
channel_views_count Total number of channel views
channel_views_absolute_change Channel Views Growth (absolute)
channel_total_videos_count Total number of videos
channel_subscribers_absolute_change Subscriber Growth (absolute)
channel_subscribers_growth Subscriber Growth (in %)
Feedback? Questions?