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} &period= {PERIOD}

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
/instagram Instagram
/pinterest Pinterest
/youtube YouTube
/linkedin LinkedIn
/tiktok TikTok

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.

PERIOD:

You can add the desired period as a parameter to your requests. This is optionally. If you do not specify the period, then it will be set to the last 28 days. Accepted format is 'YYYY-MM-DD_YYYY-MM-DD', e.g. '2023-01-01_2023-01-31'. The maximal value for 'date_until' is today (with respect to UTC). The minimal value for 'date_from' is January 1st of the previous year. Both dates are inclusive.

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 looks like:
{
"data" : {...},
"metadata" : {
"version" : "v1",
"network" : "facebook",
"profile_id" : "6815841748",
"profile_name" : "Barack Obama",
"task" : "kpi",
"date_from" : "Tue Jan 27 00:00:00 UTC 2023",
"date_until" : "Mon Feb 23 23:59:59 UTC 2023",
"message" : "Optional message."
}
}
The data-object for the Task kpi looks like:
{
"{NAME_OF_PROPERTY}" : {
"title" : "xyz",
"value" : 0.123,
"formatted_value" : "12%"
},
"{NAME_OF_PROPERTY}" : {
"title" : "abc",
"value" : 23124.0,
"formatted_value" : "23k"
},
...
}
The data-object for the Task posts looks like:
{
"posts" : [
{
"id" : "12345_67890",
"date" : "Tue Jan 10 23:31:57 UTC 2023",
"message" : "Hello there!",
"link" : "https://www.facebook.com/12345/posts/67890",
"image" : "https://scontent-ber1-1.xx.fbcdn.net/v/...",
"type" : "PHOTO",
"kpi" : Same structure as data-object for the Task kpi,
},
...
]
}

FACEBOOK

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

Facebook-Tasks:

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

The task /kpi returns the metrics 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 metrics will be returned.

Example: www.fanpagekarma.com/api/v1/facebook/6815841748/kpi?token=abcdefghijklmnopqrstuvwxyz
Structure 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 description
page_posts_count

Number of posts

Number of posts published in selected time period.
page_posts_per_day

Posts per day

Average number of posts per day published in the selected period.
page_posts_likes_count

Number of Likes

Number of likes on posts published in the selected period.
page_posts_comments_count

Number of Comments (total)
(identical to top metric: 'Number of comments')

Number of comments on posts including comments on these comments published in the selected period.
page_posts_comments_count_first_level

Number of Comments (primary)

Number of comments on posts excluding comments on these comments published in the selected period.
page_posts_comments_count_second_level

Number of Comments (secondary)

Number of sub-comments on comments posts published in the selected period.
page_posts_shares_count

Number of Shares

Number of shares of posts published in the selected period.
page_total_engagement_count

Total Reactions, Comments, Shares
(identical to top metric: 'Number of Reactions, Comments & Shares')

Number of reactions (like, love, haha, thankful, wow, sad, angry), comments and shares on posts published in the selected period.
page_posts_likes_count_per_post

Likes per post

Average number of "like" reactions on posts published in the selected period.
page_posts_comments_count_per_post

Comments per post

Average number of comments on posts published in the selected period.
page_posts_shares_count_per_post

Shares per post

Average number of shares of posts published in the selected period.
page_posts_reactions

Number of Reactions

Number of reactions (like, love, haha, thankful, wow, sad, angry) on posts published in the selected period.
page_posts_reactions_love

Number of Love

Number of "love" reactions on posts published in the selected period.
page_posts_reactions_wow

Number of Wow

Number of "wow" reactions on posts published in the selected period.
page_posts_reactions_haha

Number of Haha

Number of "haha" reactions on posts published in the selected period.
page_posts_reactions_sorry

Number of Sad

Number of "sad" reactions on posts published in the selected period.
page_posts_reactions_anger

Number of Angry

Number of "angry" reactions on posts published in the selected period.
page_posts_reactions_thankful

Number of Thankful

Number of "thankful" reactions on posts published in the selected period.
page_posts_reactions_care

Number of Care

Number of "care" reactions on posts published in the selected period.
page_posts_reactions_per_post

Reactions per post

Average number of reactions on posts published in the selected period.
page_posts_reactions_love_per_post

Love per post

Average number of "love" reactions on posts published in the selected period.
page_posts_reactions_wow_per_post

Wow per post

Average number of "wow" reactions on posts published in the selected period.
page_posts_reactions_haha_per_post

Haha per post

Average number of "haha" reactions on posts published in the selected period.
page_posts_reactions_sorry_per_post

Sad per post

Average number of "sad" reactions on posts published in the selected period.
page_posts_reactions_anger_per_post

Angry per post

Average number of "angry" reactions on posts published in the selected period.
page_posts_reactions_thankful_per_post

Thankful per post

Average number of "thankful" reactions on posts published in the selected period.
page_posts_reactions_care_per_post

Care per post

Average number of "care" reactions on posts published in the selected period.
page_negative_feedback_per_day

Negative Feedback per day

Average number of times people took a negative action on one of your posts published in the selected period (e.g. hid it), divided by the number of days in the selected period.
page_negative_feedback_per_post

Negative Feedback per post

Average number of times people took a negative action on one of your posts published in the selected period (e.g. hid it), divided by the number of posts in the selected period.
page_negative_feedback_count

Negative Feedback

Number of times people took a negative action on one of your posts published in the selected period (e.g. hid it).
page_posts_impressions

Sum of total impressions of single posts
(identical to top metric: 'Impressions of posts')

Number of times your posts published in the selected period entered a person's screen through paid, organic and viral distribution. Posts include statuses, photos, links and videos.
page_post_impressions_paid

Sum of paid impressions of single posts
(identical to top metric: 'Paid impressions of posts')

Number of times your posts published in the selected period entered a person's screen through paid distribution. Posts include statuses, photos, links and videos.
page_post_impressions_organic

Sum of organic impressions of single posts
(identical to top metric: 'Organic impressions of posts')

Number of times your posts published in the selected period entered a person's screen through organic distribution. Posts include statuses, photos, links and videos.
page_post_impressions_viral

Sum of viral impressions of single posts

Number of times your posts published in the selected period entered a person's screen through viral distribution. Posts include statuses, photos, links and videos.
page_posts_impressions_unique

Sum of reach of single posts
(identical to top metric: 'Summed up reach of posts')

Number of people who had any of your posts published in the selected period enter their screen through paid, organic and viral distribution.
page_posts_impressions_organic_unique

Sum of reach (organic) of single posts
(identical to top metric: 'Summed up organic reach of posts')

Number of people who had any of your posts published in the selected period enter their screen through unpaid distribution.
page_posts_impressions_paid_unique

Sum of reach (paid) of single posts
(identical to top metric: 'Summed up paid reach of posts')

Number of people who had any of your posts published in the selected period enter their screen through paid distribution such as an ad.
page_posts_impressions_viral_unique

Sum of reach (viral) of single posts

Number of people who had any of your posts published in the selected period enter their screen with social information attached.
page_posts_impressions_unique_per_post

Average reach of single posts

Average number of people who had any of your posts published in the selected period enter their screen, divided by the number of posts in the selected period. Posts include statuses, photos, links and videos.
page_interactions_divided_by_reach_per_post

Interaction per reached person per post
(identical to top metric: 'Interactions per reach per post')

Average number of interactions per post in relation to the number of users who have seen these posts.
page_interactions_and_link_clicks_divided_by_reach_per_post

Likes, comments, shares and link clicks per reached person per post

Average number of "like" reactions, comments, shares and link clicks per reached person on your posts published in the selected period of people who have visited your Page, divided by the number of posts in the selected period.
post_impressions_fan

Post impressions to fans

Number of post impressions in the selected period of posts by fans.
post_impressions_fan_unique

Post reach to fans

Number of fans in the selected period who had any of your posts enter their screen.
post_impressions_fan_paid

Post impressions to fans (paid)

Number of post impressions in the selected period of posts by people who like your Page in an ad or sponsored story.
post_impressions_fan_paid_unique

Post reach to fans (paid)

Number of fans in the selected period who had any of your posts enter their screen through an ad or Sponsored Story.
post_engaged_fan

Fans engaged with posts

Fans who engaged with at least one of your posts published in the selected period.
post_fan_reach

Post reach of fans

Number of fans in the selected period who had any of your posts enter their screen.
post_impressions_fan_per_day

Post impressions to fans per day

Average number of post impressions in the selected period by fans, divided by the number of days in the selected period.
post_impressions_fan_unique_per_day

Post reach to fans per day

Average number of fans in the selected period who had any of your posts enter their screen, divided by the number of days in the selected period.
post_impressions_fan_paid_per_day

Post impressions to fans (paid) per day

Average number of post impressions in the selected period by people who like your Page in an ad or sponsored story, divided by the number of days in the selected period.
post_impressions_fan_paid_unique_per_day

Post reach to fans (paid) per day

Average number of people in the selected period who had any of your posts enter their screen through an ad or Sponsored Story, divided by the number of days in the selected period.
post_engaged_fan_per_day

Fans engaged with posts per day

Average number of fans with interactions with posts published in the selected period, divided by the number of days in the selected period.
post_fan_reach_per_day

Post reach of fans per day

Average number of fans in the selected period who had any of your posts enter their screen, divided by the number of days in the selected period.
post_impressions_fan_per_post

Post impressions to fans per post

Average number of post impressions in the selected period by fans, divided by the number of posts in the selected period.
post_impressions_fan_unique_per_post

Post reach to fans per post

Average number of fans in the selected period who had any of your posts enter their screen, divided by the number of posts in the selected period.
post_impressions_fan_paid_per_post

Post impressions to fans (paid) per post

Average number of post impressions in the selected period by people who like your Page in an ad or sponsored story, divided by the number of posts in the selected period.
post_impressions_fan_paid_unique_per_post

Post reach to fans (paid) per post

Average number of people in the selected period who had any of your posts enter their screen through an ad or Sponsored Story, divided by the number of posts in the selected period.
post_engaged_fan_per_post

Fans engaged with posts per post

Average number of fans with interactions with posts published in the selected period, divided by the number of posts in the selected period.
post_fan_reach_per_post

Post reach of fans per post

Average number of fans in the selected period who had any of your posts enter their screen, divided by the number of posts in the selected period.
page_video_posts_count

Video-posts

Number of Facebook videos (posts in video format) published in the selected period.
page_video_clicks_per_post

Video clicks per video post

Average number of video clicks on your posts published in the selected period of people who have visited your Page, divided by the number of video posts in the selected period.
page_video_clicks_per_day

Video clicks of video posts per day

Average number of video clicks of your video posts published in the selected period of people who have visited your Page, divided by the number of days in the selected period.
page_video_clicks_count

Video clicks of video posts

Number of video clicks of your video posts published in the selected period of people who have visited your Page.
page_picture_posts_count

Picture Posts

Number of posts in picture format published in the selected period.
page_picture_clicks_per_day

Picture clicks of picture posts per day

Average number of picture clicks of your picture posts published in the selected period of people who have visited your Page, divided by the number of days in the selected period.
page_picture_clicks_per_post

Picture clicks per picture post

Average number of picture, video and link clicks on your posts published in the selected period of people who have visited your Page, divided by the number of picture posts in the selected period.
page_picture_clicks_count

Picture clicks of picture posts

Number of picture clicks of your picture posts published in the selected period of people who have visited your Page.
page_link_posts_count

Link-posts

Number of posts in URL format published in the selected period.
page_link_clicks_per_day

Link clicks of link posts per day

Average number of link clicks of your link posts published in the selected period of people who have visited your Page, divided by the number of days in the selected period.
page_link_clicks_per_post

Link clicks per link post

Average number of link clicks on your posts published in the selected period of people who have visited your Page, divided by the number of link posts in the selected period.
page_link_clicks_divided_by_reach_per_day

Link clicks per link post per reached person

Average number of link clicks per link post on your posts published in the selected period of people who have visited your Page, divided by the number of reached persons in the selected period.
page_link_clicks_count

Link clicks of link posts

Number of link clicks of your link posts published in the selected period of people who have visited your Page.
page_link_video_clicks_per_day

Picture, video and link clicks per day

Average number of picture, video and link clicks on your posts published in the selected period of people who have visited your Page, divided by the number of days in the selected period.
page_link_video_clicks_per_post

Picture, video and link clicks per post

Average number of picture, video and link clicks on your posts published in the selected period of people who have visited your Page, divided by the number of posts in the selected period.
page_link_video_clicks_count

Picture, video and link clicks

Number of picture, video and link clicks on your posts published in the selected period of people who have visited your Page.
page_user_posts_count

Posts by fans

Number of user posts published in the selected period.
page_user_posts_per_day

User posts per day

Average number of user posts per day in the selected period.
user_posts_total_engagement_count

User posts total Reactions, Comments, Shares

Number of interactions on user posts published in the selected period.
page_user_posts_comments_count

Comments on posts by fans

Number of comments on user posts published in the selected period.
page_user_posts_with_page_reaction_count

Posts by fans with reaction of page

Number of user posts published in the selected period and the Page reacted (like, love, haha, wow, sad, angry) to.
page_service_level

Service Level

Number of responses of the Page on user posts published in the selected period on the Page-wall. Reactions include Likes, comments and deletes. Interactions of the Page on posts published by the Page are not counted.
page_response_time

Response time

Describes how long a Page needs to respond to user posts. For this value, we only take into account when a Page makes a comment on a user post. This is mainly because Facebook does not provide time values for likes and shares. We first calculate the Response Time for each user post and then take the median of all posts for the selected period. The median is the value, that is exactly in the middle of all values, when you rank them.
page_answered_user_posts_count

Posts by fans with comment by page

Number of user posts published in selected period and which the Page responded to.
facebook_video_total_count

Facebook-Videos

Number of your Facebook videos (excluding Reels) published in the selected period.
facebook_video_total_engagement_count

Total Reactions, Comments, Shares of Facebook-Videos

Number of reactions, comments and shares of your Facebook videos (excluding Reels) published in the selected period (excluding Reels).
facebook_video_reactions_count

Number of Reactions of Facebook-Videos

Number of reactions on your Facebook videos (excluding Reels) published in the selected period (excluding Reels).
facebook_video_likes_count

Number of Likes of Facebook-Videos

Number of "like" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_love_count

Number of Love of Facebook-Videos

Number of "love" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_wow_count

Number of Wow of Facebook-Videos

Number of "wow" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_haha_count

Number of Haha of Facebook-Videos

Number of "haha" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_sorry_count

Number of Sad of Facebook-Videos

Number of "sorry" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_anger_count

Number of Angry of Facebook-Videos

Number of "angry" reactions on Facebook videos (excluding Reels) published in the selected period.
facebook_video_thankful_count

Number of Thankful of Facebook-Videos

Number of "thankful" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_comments_count

Number of Comments of Facebook-Videos

Number of comments on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_shares_count

Number of Shares of Facebook-Videos

Number of shares of your Facebook videos (excluding Reels) published in the selected period.
facebook_video_views_organic

Organic views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_organic_unique

Unique organic views of Facebook-Videos

Number of people who viewed your Facebook videos (excluding Reels) published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, by organic reach.
facebook_video_views_paid

Paid views of Facebook-Videos

Number of times your promoted Facebook videos (excluding Reels) published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_video_views_paid_unique

Unique paid views of Facebook-Videos

Number of people who viewed your promoted Facebook videos (excluding Reels) published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds.
facebook_video_views_total

Total views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_total_unique

Unique views of Facebook-Videos

Number of people who viewed your Facebook videos (excluding Reels) published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds.
facebook_video_views_complete_organic

Complete organic views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played up to 95%, or more, of their length, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_complete_organic_unique

Complete unique organic views of Facebook-Videos

Number of people who viewed your Facebook videos (excluding Reels) published in the selected period up to 95%, or more, of their length, by organic reach.
facebook_video_views_complete_paid

Complete paid views of Facebook-Videos

Number of times your promoted Facebook videos (excluding Reels) published in the selected period played up to 95%, or more, of their length. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_video_views_complete_paid_unique

Complete unique paid views of Facebook-Videos

Number of people who viewed your promoted Facebook videos (excluding Reels) published in the selected period up to 95%, or more, of their length.
facebook_video_views_complete_total

Complete views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played up to 95%, or more, of their length, by organic as well as paid impression. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_complete_total_unique

Complete unique views of Facebook-Videos

Number of people who viewed your Facebook videos (excluding Reels) published in the selected period up to 95%, or more, of their length, by organic as well as paid reach.
facebook_video_bounce_rate

Bounce rate of Facebook videos

Percentage of impressions of Facebook videos (excluding Reels) published in the selected period that were viewed below 95% of their length in relation to total impressions of videos viewed at least 3 seconds or almost completely if they are shorter than 3 seconds.
facebook_video_average_length_view

Average length viewed of Facebook-Videos (in sec)

Average time in seconds people viewed your Facebook videos (excluding Reels) published in the selected period. Only available for videos created after August 25th 2016.
facebook_video_length

Total length of Facebook-Videos (in sec)

Length in seconds of your Facebook videos (excluding Reels) published in the selected period.
facebook_video_views_autoplayed

Autoplayed views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period automatically played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_sound_on

Sound on views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played with sound on for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_view_time

View time of Facebook-Video (in sec)

Total time in seconds your Facebook videos (excluding Reels) published in the selected period played, including videos played for less than 3 seconds and replays.
facebook_video_view_organic

View time organic of Facebook-Video (in sec)

Total time in seconds your Facebook videos (excluding Reels) published in the selected period played by organic reach.
facebook_video_views_10s_unique

10s unique views of Facebook-Videos

Number of people who viewed your Facebook videos (excluding Reels) published in the selected period for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds.
facebook_video_views_10s_autoplayed

10s autoplayed views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played automatically for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_10s_clicked_to_play

10s clicked to play views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds, after people clicked play. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_10s_organic

10s organic views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_10s_paid

10s paid views of Facebook-Videos

Number of times your promoted Facebook videos (excluding Reels) published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_video_views_10s_sound_on

10s sound on views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played with sound on for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_10s

10s Total views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_total_count

Facebook Reels

Number of your Facebook Reels published in the selected period.
facebook_reel_total_engagement_count

Total Reactions, Comments, Shares of Facebook Reels

Number of reactions, comments and shares of your Facebook Reels published in the selected period.
facebook_reel_reactions_count

Number of Reactions of Facebook Reels

Number of reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_reel_views_organic

Organic views of Facebook Reels

Number of times your Facebook Reels published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_organic_unique

Unique organic views of Facebook Reels

Number of people who viewed your Facebook Reels published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, by organic reach.
facebook_reel_views_paid

Paid views of Facebook Reels

Number of times your promoted Facebook Reels published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_reel_views_paid_unique

Unique paid views of Facebook Reels

Number of people who viewed your promoted Facebook Reels published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds.
facebook_reel_views_total

Total views of Facebook Reels

Number of times your Facebook Reels published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_total_unique

Unique views of Facebook Reels

Number of people who viewed your Facebook Reels videos published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds.
facebook_reel_views_complete_organic

Complete organic views of Facebook Reels

Number of times your Facebook Reels published in the selected period played up to 95%, or more, of their length, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_complete_organic_unique

Complete unique organic views of Facebook Reels

Number of people who viewed your Facebook Reels published in the selected period up to 95%, or more, of their length, by organic reach.
facebook_reel_views_complete_paid

Complete paid views of Facebook Reels

Number of times your promoted Facebook Reels published in the selected period played up to 95%, or more, of their length. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_reel_views_complete_paid_unique

Complete unique paid views of Facebook Reels

Number of people who viewed your promoted Facebook Reels published in the selected period up to 95%, or more, of their length.
facebook_reel_views_complete_total

Complete views of Facebook Reels

Number of times your Facebook Reels published in the selected period played up to 95%, or more, of their length, by organic as well as paid impression. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_complete_total_unique

Complete unique views of Facebook Reels

Number of people who viewed your Facebook Reels published in the selected period up to 95%, or more, of their length, by organic as well as paid reach.
facebook_reel_bounce_rate

Bounce rate of Facebook Reels

Percentage of impressions of Facebook Reels published in the selected period that were viewed below 95% of their length in relation to total impressions of videos viewed at least 3 seconds or almost completely if they are shorter than 3 seconds.
facebook_reel_average_length_view

Average length viewed of Facebook Reels (in sec)

Average time in seconds people viewed your Facebook videos published in the selected period. Only available for videos created after August 25th 2016.
facebook_reel_length

Total length of Facebook Reels (in sec)

Length in seconds of your Facebook Reels published in the selected period.
facebook_reel_views_autoplayed

Autoplayed views of Facebook Reels

Number of times your Facebook Reels published in the selected period automatically played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_sound_on

Sound on views of Facebook Reels

Number of times your Facebook Reels published in the selected period played with sound on for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_view_time

View time of Facebook Reel (in sec)

Total time in seconds your Facebook Reels published in the selected period played, including videos played for less than 3 seconds and replays.
facebook_reel_view_organic

View time organic of Facebook Reel (in sec)

Total time in seconds your Facebook Reels published in the selected period played by organic reach.
facebook_reel_views_10s_unique

10s unique views of Facebook Reels

Number of people who viewed your Facebook Reels published in the selected period for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds.
facebook_reel_views_10s_autoplayed

10s autoplayed views of Facebook Reels

Number of times your Facebook Reels published in the selected period played automatically for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_10s_clicked_to_play

10s clicked to play views of Facebook Reels

Number of times your Facebook Reels published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds, after people clicked play. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_10s_organic

10s organic views of Facebook Reels

Number of times your Facebook Reels published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_10s_paid

10s paid views of Facebook Reels

Number of times your promoted Facebook Reels published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_reel_views_10s_sound_on

10s sound on views of Facebook Reels

Number of times your Facebook Reels published in the selected period played with sound on for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_10s

10s Total views of Facebook Reels

Number of times your Facebook Reels published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
page_weighted_post_interaction

Weighted Post-Interaction

See Post-Interaction, shares are weighted 3x, comments are 2x and likes are just count as usual.
page_weighted_engagement

Weighted Engagement

See Engagement, shares are weighted 3x, comments 2x and likes are just count as usual.
page_post_interaction

Post interaction
(identical to top metric: 'Post interaction rate')

Post-Interaction is the average number of interactions on a profile's posts per follower per post. Post-Interaction shows how successful the individual posts of a profile are on average in encouraging users to interact. By dividing by the number of followers, Post-Interaction becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values of all posts. Finally, you divide the number of posts in the period.<br> <br>An example of the calculation: <br>A profile makes 2 posts in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>The Post-Interaction (2 posts) results in: <br> (50/100 + 75/150) / 2 = 50%<br> In comparison, Engagement for this week (7 days) is: <br>(50/100 + 75/150) / 7 = 14.2%<br> <br>Engagement is closely related to post-interaction. For Engagement, the number of interactions is also divided by the number of followers, but then the average is calculated per day and not - as for Post-Interaction - per post. Engagement is therefore usually higher when a profile posts more often. Engagement shows how successfully a profile in total motivates users to interact.
page_engagement

Engagement

Engagement is the average number of interactions on a profile's posts per follower per day. Engagement shows how successfully a profile encourages users to interact. By dividing by the number of followers, the Engagement becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values ​​of all posts. Finally, you divide this sum by the number of days in the period.<br> <br>An example of the calculation: <br>A profile posts 2 times in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>Engagement for this week (7 days) is calculated as follows: <br>(50/100 + 75/150) / 7 = 14.2%<br>In comparison, the post interaction (2 posts) results in: <br>(50/100 + 75/150) / 2 = 50%<br> <br>Post-interaction is closely related to Engagement. For Post-Interaction, the number of interactions is also divided by the number of followers, but then divided by the number of posts and not - as with Engagement - per day. Engagement is higher if a profile posts more often. The post interaction shows how successful the posts are on average.
page_interactions_and_link_clicks_divided_by_fans_per_post

Likes, comments, shares and link clicks per fan per post

Average number of "like" reactions, comments, shares and link clicks per fan on your posts published in the selected period of people who have visited your Page, divided by the number of posts in the selected period.
page_posts_impressions_divided_by_fans_per_post

Post impressions per post per fan

Average number of times in the selected period per post your posts entered a person's screen, divided by the daily number of fans in the selected period.
page_posts_impressions_unique_divided_by_fans_per_post

Post reach per post per fan

Average number of people in the selected period who had any of your posts enter their screen, divided by the daily number of fans in the selected period.
page_posts_impressions_organic_unique_divided_by_fans_per_post

Post reach (organic) per post per fan

Average number of people in the selected period who had any of your posts enter their screen through unpaid distribution, divided by the daily number of fans in the selected period.
page_posts_impressions_paid_unique_divided_by_fans_per_post

Post reach (paid) per post per fan

Average number of people in the selected period per post who had any of your posts enter their screen through paid distribution such as an ad, divided by the daily number of fans in the selected period.
page_posts_impressions_viral_unique_divided_by_fans_per_post

Post reach (viral) per post per fan

Average number of people in the selected period per fan who had any of your posts enter their screen with social information attached, divided by the number of days in the selected period.
page_fans

Fans

Number of users on the last day of the selected period who like the Page are called fans. For the "New Pages Experience" this corresponds to the follower count.
page_fans_weekly_growth_rate

Follower Growth Average Weekly (in %)

Difference between the number of fans on the first and the last day of the selected period as an average weekly value.
page_fans_growth_percent

Follower Growth (in %)

Difference between the number of fans in percent on the first and the last day of the selected period. Reflects the difference from the previous day in the history graph.
page_fans_growth_absolute

Follower Growth (absolute)

Difference between the number of fans on the first and the last day of the selected period.
page_fans_growth_absolute_per_day

Follower Growth per day (absolute)

Difference between the number of fans on the first and the last day of the selected period as an average value per day.
page_fans_growth_percent_since_first_date

Follower Growth since starting point (in %)

Percentage growth of fans between the first and last day of the selected period. Reflects the difference from the first day of the selected period for each day in the history graph.
page_follower

Follower

Number of users on the last day of the selected period who follow the Pages posts.
page_engaged_users_unique

People Engaged

Number of people who clicked anywhere on your Page in the selected period.
page_engaged_users_per_day

Persons with interaction per day

Number of people who clicked anywhere on your Page in the selected period, divided by the number of days in the selected period.
page_views

Page Visits
(identical to top metric: 'Profile Views')

Number of times in the selected period a Page has been viewed by logged in and logged out people.
page_views_per_day

Page views per day

Average number of times in the selected period a Page has been viewed by logged in and logged out people, divided by the number of days in the selected period.
page_impressions_per_day

Total impressions (total) per day

Average number of times in the selected period any content of your Page or about your Page entered a person's screen, divided by the number of days in the selected period.
page_impressions

Total impressions (total)
(identical to top metric: 'Impressions')

Number of times any content from your Fanpage or about your Fanpage entered a person's screen.
page_impressions_unique_per_day

Average daily Reach (total)

Average number of people in the selected period who had any content of your Page or about your Page enter their screen, divided by the number of days in the selected period.
page_impressions_unique

Daily Reach (total)

Number of people in the selected period who had any content of your Page or about your Page enter their screen. - This is an unique KPI, same events are counted only once per visitor, with Fanpage Karma at most once per day. This gives you a good impression of the daily activities. In the network, the period can refer to other periods and is then not comparable.
page_impressions_organic_unique

Daily Reach (organic)

Number of people in the selected period who had any content of your Page or about your Page enter their screen through unpaid distribution.
page_impressions_organic_unique_per_day

Average daily Reach (organic)

Average number of people in the selected period who had any content of your Page or about your Page enter their screen through unpaid distribution, divided by the number of days in the selected period.
page_impressions_paid_unique

Daily Reach (paid)

Number of people in the selected period who had any content of your Page or about your Page enter their screen through paid distribution such as an ad.
page_impressions_paid_unique_per_day

Average daily Reach (paid)

Average number of people in the selected period who had any content of your Page or about your Page enter their screen through paid distribution such as an ad, divided by the number of days in the selected period.
page_impressions_viral_unique

Daily Reach (viral)

Number of people in the selected period who had any content of your Page or about your Page enter their screen with social information attached. As a form of organic distribution, social information displays when a person's friend interacted with your Page, post or story.
page_impressions_viral_unique_per_day

Average daily Reach (viral)

Average number of people in the selected period who had any content of your Page or about your Page enter their screen with social information attached, divided by the number of days in the selected period.
page_posts_impressions_daily

Post impressions

Number of times in the selected period your posts entered a person's screen.
page_posts_impressions_per_day

Post impressions per day

Average number of times in the selected period your posts entered a person's screen, divided by the number of days in the selected period.
page_posts_impressions_daily_unique

Post reach

Number of people in the selected period who had any of your posts enter their screen.
page_posts_impressions_unique_per_day

Post reach per day

Average number of people in the selected period who had any of your posts enter their screen, divided by the number of days in the selected period.
page_posts_impressions_organic_daily_unique

Post reach (organic)

Number of people in the selected period who had any of your posts enter their screen through unpaid distribution.
page_posts_impressions_organic_unique_per_day

Post reach (organic) per day

Average number of people in the selected period who had any of your posts enter their screen through unpaid distribution, divided by the number of days in the selected period.
page_posts_impressions_daily_paid_unique

Post reach (paid)

Number of people in the selected period who had any of your posts enter their screen through paid distribution such as an ad.
page_posts_impressions_paid_unique_per_day

Post reach (paid) per day

Average number of people in the selected period who had any of your posts enter their screen through paid distribution such as an ad, divided by the number of days in the selected period.
page_posts_impressions_viral_daily_unique

Post reach (viral)

Number of people in the selected period who had any of your posts enter their screen with social information attached. As a form of organic distribution, social information displays when a person's friend interacted with your Page or post. This includes when someone's friend likes or follows your Page, engages with a post, shares a photo of your Page, and checks into your Page.
page_posts_impressions_viral_unique_per_day

Post reach (viral) per day

Average number of people in the selected period who had any of your posts enter their screen with social information attached, divided by the number of days in the selected period.
page_video_views

Total video views in period

Number of times in the selected period your Page’s videos played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
page_video_views_paid

Paid video views in period

Number of times in the selected period your Page’s promoted videos played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
page_video_views_unique

Unique video views in period

Number of people in the selected period who viewed your Page’s videos for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
page_video_views_autoplayed

Autoplayed video views in period

Number of times in the selected period your Page’s videos automatically played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
page_video_complete_views_30s

Total video views of at least 30 sec in period

Number of times in the selected period your Page’s videos played for at least 30 seconds, or for nearly their total length if they're shorter than 30 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
page_video_complete_views_30s_unique

Unique video views of at least 30 sec in period

Number of people in the selected period who viewed your Page’s videos for at least 30 seconds, or for nearly their total length if they're shorter than 30 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
page_video_complete_views_30s_autoplayed

Autoplayed video views of at least 30 sec in period

Number of times in the selected period your Page’s automatically played videos played for at least 30 seconds, or for nearly their total length if they're shorter than 30 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
page_impressions_divided_by_fans_per_day

Total impressions (total) per fan per day

Number of times any content from your Fanpage or about your Fanpage entered a person's screen, divided by the daily number of fans in the selected period per day.
page_impressions_unique_divided_by_fans_per_day

Average daily Reach per fan (total)

Average number of people in the selected period per fan who had any content of your Page or about your Page enter their screen, divided by the number of days in the selected period.
page_impressions_organic_unique_divided_by_fans_per_day

Average daily Reach (organic) per fan

Average number of people in the selected period per fan who had any content of your Page or about your Page enter their screen through unpaid distribution, divided by the number of days in the selected period.
page_impressions_paid_unique_divided_by_fans_per_day

Average daily Reach (paid) per fan

Average number of people in the selected period per fan who saw any content of or through your page via paid distribution, divided by the number of days in the selected period.
page_impressions_viral_unique_divided_by_fans_per_day

Average daily Reach (viral) per fan

Average number of people in the selected period per fan who had any content of your Page or about your Page enter their screen with social information attached, divided by the number of days in the selected period.
page_posts_impressions_divided_by_fans_per_day

Post impressions per fan per day

Average number of times in the selected period per fan your post entered a person's screen, divided by the number of days in the selected period.
page_posts_impressions_unique_divided_by_fans_per_day

Post reach per fan per day

Average number of people in the selected period who had any of your posts enter their screen, divided by the number of days in the selected period.
page_posts_impressions_organic_unique_divided_by_fans_per_day

Post reach (organic) per fan per day

Average number of people in the selected period per fan who had any of your posts enter their screen through unpaid distribution, divided by the number of days in the selected period.
page_posts_impressions_paid_unique_divided_by_fans_per_day

Post reach (paid) per fan per day

Average number of people in the selected period per fan who had any of your posts enter their screen through paid distribution such as an ad, divided by the number of days in the selected period.
page_posts_impressions_viral_unique_divided_by_fans_per_day

Post reach (viral) per fan per day

Number of people who had any of your Fanpage posts enter their screen with social information attached, divided by the daily number of fans per day.
page_performance_index

Page Performance Index

Root product between the comparison values of the engagement value and the average weekly growth of a Page. We first determine a value between 0 and 100 percent for both engagement and growth, which serves as a benchmark against the values of all other Pages in our index. A value is set to 100% if the Page is among the top 10% for the respective value - i.e. this Page has a better value than at least 90% of all Pages listed in our database. Then, engagement and growth (in each case the comparison values) are multiplied and the root is taken from this value.
profile_performance_score

Performance Score

The Performance Score is calculated as the average of seven essential key figures by comparing them to millions of profiles in the Fanpage Karma database. To make the values comparable, they are normalized to the number of followers. In order to achieve a Performance Score of 100%, a profile must rank among the top 10% of each metric.
page_ad_value

Ad-Value (USD)

A value that is determined from the estimated reach of the posts and an average price for online advertising (CPM_cost per impression), depending on the selected period. It indicates how much money one would have to spend on classic online advertising to reach as many people as with Facebook posts. An average CPM of €12.00 is applied and this is multiplied by the estimated reach. Note: For your own page you can set the CPM for different types of posts yourself. The advertising value is therefore not proportionally dependent on the number of fans but on the engagement.
demographic_page_fans_gender_age_average

Average age of page fans
(identical to top metric: 'Average age of fans')

The average age of fans of the Page.
demographic_page_fans_gender_age_average_male

Average age of male page fans
(identical to top metric: 'Average age of male fans')

The average age of male fans of the Page.
demographic_page_fans_gender_age_average_female

Average age of female page fans
(identical to top metric: 'Average age of female fans')

The average age of female fans of the Page.
demographic_page_fans_gender_age_share_male

Share of male page fans
(identical to top metric: 'Percentage of male fans')

Share of Fans, who are male.
demographic_page_fans_gender_age_share_female

Share of female page fans
(identical to top metric: 'Percentage of female fans')

Share of Fans, who are female.
demographic_page_impressions_by_age_gender_unique_average

Average age of people reached

The average age of people who saw any content by your Page or about your Page.
demographic_page_impressions_by_age_gender_unique_average_male

Average age of male people reached

The average age of male people who saw any content by your Page or about your Page.
demographic_page_impressions_by_age_gender_unique_average_female

Average age of female people reached

The average age of female people who saw any content by your Page or about your Page.
demographic_page_impressions_by_age_gender_unique_share_male

Share of male people reached

Share of people who saw any content by your Page or about your Page, who are male
demographic_page_impressions_by_age_gender_unique_share_female

Share of female people reached

Share of people who saw any content by your Page or about your Page, who are female
demographic_page_content_activity_by_age_gender_unique_average

Average age of people engaged

The average age of people talking about the Page.
demographic_page_content_activity_by_age_gender_unique_average_male

Average age of male people engaged

The average age of male people talking about the Page.
demographic_page_content_activity_by_age_gender_unique_average_female

Average age of female people engaged

The average age of female people talking about the Page.
demographic_page_content_activity_by_age_gender_unique_share_male

Share of male people engaged

Share of people talking about the Page, who are male.
demographic_page_content_activity_by_age_gender_unique_share_female

Share of female people engaged

Share of people talking about the Page, who are female.
page_engaged_users_divided_by_impressions_unique_per_day

Persons with interaction per reached person per day

Average number of people per reach person who clicked anywhere on your Page in the selected period, divided by the number of days in the selected period.
Task: /posts
Title: Posts and their metrics
URL structure: www.fanpagekarma.com/api/v1/facebook/ {PROFILE_ID} /posts?token= {TOKEN} &period= {PERIOD}
Description:

The task /posts returns the posts and their metrics 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 metrics will be returned.

Example: www.fanpagekarma.com/api/v1/facebook/6815841748/posts?token=abcdefghijklmnopqrstuvwxyz
Structure of the data-object:
{
"posts" : [
{
"id" : "identifier of the post",
"date" : "date of the post",
"message" : "message text of the post",
"link" : "link to the post",
"image" : "image url of the post",
"type" : "type of the post",
"kpi" : Same structure as data-object for the Task kpi,
},
...
]
}
Description of the elements of the kpi-object:
{NAME_OF_PROPERTY} title description
page_posts_likes_count

Number of Likes

Average number of "like" reactions on posts published in the selected period.
page_posts_comments_count

Number of comments

<p>Number of comments on posts, videos, tweets, pins, etc. <br><br><b>Benefit</b><br> Comments give a better indication of whether a post actually appeals to users, since creating a comment takes significantly more effort than a simple like. Unfortunately, most of the comments on Instagram are not made by real people but by bots. <br><br><b>Calculation</b><br> All comments added together. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. </p>
page_posts_comments_count_first_level

Number of Comments (primary)

Number of comments on posts excluding comments on these comments published in the selected period.
page_posts_comments_count_second_level

Number of Comments (secondary)

Number of sub-comments on comments posts published in the selected period.
page_posts_shares_count

Number of Shares

Number of shares of posts published in the selected period.
page_total_engagement_count

Number of Reactions, Comments & Shares

<p>This number is the sum of public accessible interactions (likes, hearts, reactions, comments, pins, shares etc.) of all posts in the selected period. <br><br><b>Benefit</b><br> This metric shows you how actively people have interacted with a profile's posts. More interactions lead to higher visibility of the content and is the most important driver for organic reach. <br><br><b>Calculation</b><br> Sum of likes, hearts, reactions, comments, and shares of all posts in the selected period. In order to make this metric comparable to competitor profiles, only public accessible interactions are taken into account. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. <br>On Instagram only likes and comments are publicy available. <br>Clicks on links do not count towards interactions. </p>
page_posts_reactions

Number of Reactions

Number of reactions (like, love, haha, thankful, wow, sad, angry) on posts published in the selected period.
page_posts_reactions_love

Number of Love

Number of "love" reactions on posts published in the selected period.
page_posts_reactions_wow

Number of Wow

Number of "wow" reactions on posts published in the selected period.
page_posts_reactions_haha

Number of Haha

Number of "haha" reactions on posts published in the selected period.
page_posts_reactions_sorry

Number of Sad

Number of "sad" reactions on posts published in the selected period.
page_posts_reactions_anger

Number of Angry

Number of "angry" reactions on posts published in the selected period.
page_posts_reactions_thankful

Number of Thankful

Number of "thankful" reactions on posts published in the selected period.
page_posts_reactions_care

Number of Care

Number of "care" reactions on posts published in the selected period.
page_negative_feedback_count

Negative Feedback

Number of times people took a negative action on one of your posts published in the selected period (e.g. hid it).
page_posts_impressions

Impressions of posts

<p>Sum of total impressions of all posts posted during the selected period.<br><br><b>Benefit</b><br> Use this number to find out how many times all posts have been viewed in total. <br><br><b>Calculation</b><br> The total impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
page_post_impressions_paid

Paid impressions of posts

<p>Sum of paid impressions of all posts posted during the selected period. <br><br><b>Benefit</b><br> Use this number to find out how many times all paid posts have been viewed. <br><br><b>Calculation</b><br> The paid impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
page_post_impressions_organic

Organic impressions of posts

<p>Sum of organic impressions of all posts posted during the selected period. <br><br><b>Benefit</b><br> Use this number to find out how many times all posts have been viewed organically. <br><br><b>Calculation</b><br> The organic impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
page_post_impressions_viral

Sum of viral impressions of single posts

Number of times your posts published in the selected period entered a person's screen through viral distribution. Posts include statuses, photos, links and videos.
page_posts_impressions_unique

Summed up reach of posts

<p>Sum of the total reach of all posts that were posted in the selected period. <br><br><b>Benefit</b><br> Be careful when relying on this number to figure out how many people saw posts. The sum of the reach of posts is likely to be higher than the daily reach due to double counting. <br><br><b>Calculation</b><br> The paid reach is added up for all posts in the specified period. It doesn't matter when the view happened. It counts when the post was posted. <br><br><b>Note</b> <br>Adding up reach values can result in people being counted twice if they have viewed several posts. It is better to use the metrics reach per day or reach per post. You can also better use these metrics for comparison with other profiles. If you want a high overall total, then use impressions of the posts. </p>
page_posts_impressions_organic_unique

Summed up organic reach of posts

<p>Sum of the organic reach of all posts that were posted in the selected period. <br><br><b>Benefit</b><br> Be careful when relying on this number to figure out how many people saw posts organically. The sum of the reach of posts can be higher than the daily reach due to double counting. <br><br><b>Calculation</b><br> The organic reach is added up for all posts in the specified period. It doesn't matter when the view happened. It counts when the post was posted. <br><br><b>Note</b> <br>Adding up reach values can result in people being counted twice if they have viewed several posts. It is better to use the metrics reach per day or reach per post if you don’t absolutely need the organic reach. </p>
page_posts_impressions_paid_unique

Summed up paid reach of posts

<p>Sum of the paid reach of all posts that were posted in the selected period. <br><br><b>Benefit</b><br> Be careful when relying on this number to figure out how many people saw posts because of ads or boosts. This is because the sum of the reach of posts can be higher than the daily reach due to double counting. <br><br><b>Calculation</b><br> The paid reach is added up for all posts in the specified period. It doesn't matter when the view happened. It counts when the post was posted. <br><br><b>Note</b> <br>Adding up reach values can result in people being counted twice if they have viewed several posts. It is better to use the metrics reach per day or reach per post if you don’t absolutely need the paid reach. </p>
page_posts_impressions_viral_unique

Sum of reach (viral) of single posts

Number of people who had any of your posts published in the selected period enter their screen with social information attached.
post_impressions_fan

Post impressions to fans

Number of post impressions in the selected period of posts by fans.
post_impressions_fan_unique

Post reach to fans

Number of fans in the selected period who had any of your posts enter their screen.
post_impressions_fan_paid

Post impressions to fans (paid)

Number of post impressions in the selected period of posts by people who like your Page in an ad or sponsored story.
post_impressions_fan_paid_unique

Post reach to fans (paid)

Number of fans in the selected period who had any of your posts enter their screen through an ad or Sponsored Story.
post_engaged_fan

Fans engaged with posts

Fans who engaged with at least one of your posts published in the selected period.
post_fan_reach

Post reach of fans

Number of fans in the selected period who had any of your posts enter their screen.
page_video_posts_count

Video-posts

Number of Facebook videos (posts in video format) published in the selected period.
page_video_clicks_count

Video clicks of video posts

Number of video clicks of your video posts published in the selected period of people who have visited your Page.
page_picture_posts_count

Picture Posts

Number of posts in picture format published in the selected period.
page_picture_clicks_count

Picture clicks of picture posts

Number of picture clicks of your picture posts published in the selected period of people who have visited your Page.
page_link_posts_count

Link-posts

Number of posts in URL format published in the selected period.
page_link_clicks_count

Link clicks of link posts

Number of link clicks of your link posts published in the selected period of people who have visited your Page.
page_link_video_clicks_count

Picture, video and link clicks

Number of picture, video and link clicks on your posts published in the selected period of people who have visited your Page.
facebook_video_total_count

Facebook-Videos

Number of your Facebook videos (excluding Reels) published in the selected period.
facebook_video_total_engagement_count

Total Reactions, Comments, Shares of Facebook-Videos

Number of reactions, comments and shares of your Facebook videos (excluding Reels) published in the selected period (excluding Reels).
facebook_video_reactions_count

Number of Reactions of Facebook-Videos

Number of reactions on your Facebook videos (excluding Reels) published in the selected period (excluding Reels).
facebook_video_likes_count

Number of Likes of Facebook-Videos

Number of "like" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_love_count

Number of Love of Facebook-Videos

Number of "love" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_wow_count

Number of Wow of Facebook-Videos

Number of "wow" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_haha_count

Number of Haha of Facebook-Videos

Number of "haha" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_sorry_count

Number of Sad of Facebook-Videos

Number of "sorry" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_anger_count

Number of Angry of Facebook-Videos

Number of "angry" reactions on Facebook videos (excluding Reels) published in the selected period.
facebook_video_thankful_count

Number of Thankful of Facebook-Videos

Number of "thankful" reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_comments_count

Number of Comments of Facebook-Videos

Number of comments on your Facebook videos (excluding Reels) published in the selected period.
facebook_video_shares_count

Number of Shares of Facebook-Videos

Number of shares of your Facebook videos (excluding Reels) published in the selected period.
facebook_video_views_organic

Organic views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_organic_unique

Unique organic views of Facebook-Videos

Number of people who viewed your Facebook videos (excluding Reels) published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, by organic reach.
facebook_video_views_paid

Paid views of Facebook-Videos

Number of times your promoted Facebook videos (excluding Reels) published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_video_views_paid_unique

Unique paid views of Facebook-Videos

Number of people who viewed your promoted Facebook videos (excluding Reels) published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds.
facebook_video_views_total

Total views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_total_unique

Unique views of Facebook-Videos

Number of people who viewed your Facebook videos (excluding Reels) published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds.
facebook_video_views_complete_organic

Complete organic views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played up to 95%, or more, of their length, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_complete_organic_unique

Complete unique organic views of Facebook-Videos

Number of people who viewed your Facebook videos (excluding Reels) published in the selected period up to 95%, or more, of their length, by organic reach.
facebook_video_views_complete_paid

Complete paid views of Facebook-Videos

Number of times your promoted Facebook videos (excluding Reels) published in the selected period played up to 95%, or more, of their length. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_video_views_complete_paid_unique

Complete unique paid views of Facebook-Videos

Number of people who viewed your promoted Facebook videos (excluding Reels) published in the selected period up to 95%, or more, of their length.
facebook_video_views_complete_total

Complete views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played up to 95%, or more, of their length, by organic as well as paid impression. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_complete_total_unique

Complete unique views of Facebook-Videos

Number of people who viewed your Facebook videos (excluding Reels) published in the selected period up to 95%, or more, of their length, by organic as well as paid reach.
facebook_video_length

Total length of Facebook-Videos (in sec)

Length in seconds of your Facebook videos (excluding Reels) published in the selected period.
facebook_video_views_autoplayed

Autoplayed views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period automatically played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_sound_on

Sound on views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played with sound on for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_view_time

View time of Facebook-Video (in sec)

Total time in seconds your Facebook videos (excluding Reels) published in the selected period played, including videos played for less than 3 seconds and replays.
facebook_video_view_organic

View time organic of Facebook-Video (in sec)

Total time in seconds your Facebook videos (excluding Reels) published in the selected period played by organic reach.
facebook_video_views_10s_unique

10s unique views of Facebook-Videos

Number of people who viewed your Facebook videos (excluding Reels) published in the selected period for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds.
facebook_video_views_10s_autoplayed

10s autoplayed views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played automatically for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_10s_clicked_to_play

10s clicked to play views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds, after people clicked play. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_10s_organic

10s organic views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_10s_paid

10s paid views of Facebook-Videos

Number of times your promoted Facebook videos (excluding Reels) published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_video_views_10s_sound_on

10s sound on views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played with sound on for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_video_views_10s

10s Total views of Facebook-Videos

Number of times your Facebook videos (excluding Reels) published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_total_count

Facebook Reels

Number of your Facebook Reels published in the selected period.
facebook_reel_total_engagement_count

Total Reactions, Comments, Shares of Facebook Reels

Number of reactions, comments and shares of your Facebook Reels published in the selected period.
facebook_reel_reactions_count

Number of Reactions of Facebook Reels

Number of reactions on your Facebook videos (excluding Reels) published in the selected period.
facebook_reel_views_organic

Organic views of Facebook Reels

Number of times your Facebook Reels published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_organic_unique

Unique organic views of Facebook Reels

Number of people who viewed your Facebook Reels published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds, by organic reach.
facebook_reel_views_paid

Paid views of Facebook Reels

Number of times your promoted Facebook Reels published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_reel_views_paid_unique

Unique paid views of Facebook Reels

Number of people who viewed your promoted Facebook Reels published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds.
facebook_reel_views_total

Total views of Facebook Reels

Number of times your Facebook Reels published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_total_unique

Unique views of Facebook Reels

Number of people who viewed your Facebook Reels videos published in the selected period for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds.
facebook_reel_views_complete_organic

Complete organic views of Facebook Reels

Number of times your Facebook Reels published in the selected period played up to 95%, or more, of their length, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_complete_organic_unique

Complete unique organic views of Facebook Reels

Number of people who viewed your Facebook Reels published in the selected period up to 95%, or more, of their length, by organic reach.
facebook_reel_views_complete_paid

Complete paid views of Facebook Reels

Number of times your promoted Facebook Reels published in the selected period played up to 95%, or more, of their length. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_reel_views_complete_paid_unique

Complete unique paid views of Facebook Reels

Number of people who viewed your promoted Facebook Reels published in the selected period up to 95%, or more, of their length.
facebook_reel_views_complete_total

Complete views of Facebook Reels

Number of times your Facebook Reels published in the selected period played up to 95%, or more, of their length, by organic as well as paid impression. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_complete_total_unique

Complete unique views of Facebook Reels

Number of people who viewed your Facebook Reels published in the selected period up to 95%, or more, of their length, by organic as well as paid reach.
facebook_reel_length

Total length of Facebook Reels (in sec)

Length in seconds of your Facebook Reels published in the selected period.
facebook_reel_views_autoplayed

Autoplayed views of Facebook Reels

Number of times your Facebook Reels published in the selected period automatically played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_sound_on

Sound on views of Facebook Reels

Number of times your Facebook Reels published in the selected period played with sound on for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_view_time

View time of Facebook Reel (in sec)

Total time in seconds your Facebook Reels published in the selected period played, including videos played for less than 3 seconds and replays.
facebook_reel_view_organic

View time organic of Facebook Reel (in sec)

Total time in seconds your Facebook Reels published in the selected period played by organic reach.
facebook_reel_views_10s_unique

10s unique views of Facebook Reels

Number of people who viewed your Facebook Reels published in the selected period for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds.
facebook_reel_views_10s_autoplayed

10s autoplayed views of Facebook Reels

Number of times your Facebook Reels published in the selected period played automatically for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_10s_clicked_to_play

10s clicked to play views of Facebook Reels

Number of times your Facebook Reels published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds, after people clicked play. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_10s_organic

10s organic views of Facebook Reels

Number of times your Facebook Reels published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds, by organic reach. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_10s_paid

10s paid views of Facebook Reels

Number of times your promoted Facebook Reels published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. For each impression of a video, we'll count video views separately and exclude any time spent replaying the video.
facebook_reel_views_10s_sound_on

10s sound on views of Facebook Reels

Number of times your Facebook Reels published in the selected period played with sound on for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
facebook_reel_views_10s

10s Total views of Facebook Reels

Number of times your Facebook Reels published in the selected period played for at least 10 seconds, or for nearly their total length if they're shorter than 10 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video.
page_ad_value

Ad-Value (USD)

A value that is determined from the estimated reach of the posts and an average price for online advertising (CPM_cost per impression), depending on the selected period. It indicates how much money one would have to spend on classic online advertising to reach as many people as with Facebook posts. An average CPM of €12.00 is applied and this is multiplied by the estimated reach. Note: For your own page you can set the CPM for different types of posts yourself. The advertising value is therefore not proportionally dependent on the number of fans but on the engagement.

TWITTER

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

Twitter-Tasks:

Here is a detailed description of all available tasks for the network Twitter:
Task: /kpi
Title: Key Performance Indicators / Profile metrics
URL structure: www.fanpagekarma.com/api/v1/twitter/ {PROFILE_ID} /kpi?token= {TOKEN} &period= {PERIOD}
Description: The task /kpi returns the metrics of the Twitter profile for the given {PROFILE_ID}. These are essentially all the numbers and details you see in your Dashboard.

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

Example: www.fanpagekarma.com/api/v1/twitter/813286/kpi?token=abcdefghijklmnopqrstuvwxyz
Structure 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 description
profile_followers

Follower
(identical to top metric: 'Fans')

Number of users on the last day of the selected period who follow the profile are called followers.
profile_followers_weekly_growth_rate

Follower Growth Average Weekly (in %)

Difference between the number of followers on the first and the last day of the selected period as an average weekly value.
profile_followers_growth_absolute

Follower Growth (absolute)

Difference between the number of followers on the first and the last day of the selected period.
profile_followers_growth_percent

Follower Growth (in %)

Percentage number of the difference between the number of followers of the first and last day of the selected period, divided by the number of followers of the first day in the selected period. Reflects the difference from the previous day in the history graph.
profile_followers_growth_absolute_per_day

Follower Growth per day (absolute)

Difference between the number of followers on the first and the last day of the selected period as an average value per day.
profile_followers_growth_percent_since_first_date

Follower Growth since starting point (in %)

Percentage growth of followers between the first and last day of the selected period. Reflects the difference from the first day of the selected period for each day in the history graph.
profile_followings

Followings

Number of profiles followed by the profile from the last day of the selected period.
profile_overall_tweets

Overall Tweets

Overall number of Tweets (including Retweets) by this profile which currently exists on Twitter.
profile_listed

Listed

Number of lists that include this user.
tweets

Tweets
(identical to top metric: 'Number of posts')

Number of tweets (including retweets) published in selected time period.
tweets_per_day

Tweets/day
(identical to top metric: 'Posts per day')

Average number of Tweets per day published in the selected period.
tweets_excluding_retweets

Tweets excluding retweets

Number of tweets excluding retweets published in the selected period. This includes quote tweets and replies/mentions.
tweets_excluding_retweets_per_day

Tweets/day excluding retweets

Average number of tweets per day excluding retweets published in the selected period. This includes quote tweets and replies/mentions.
tweets_retweets

Retweets

Number of Retweets (without comments) of Tweets published in the selected period.
tweets_retweets_per_post

Retweets per tweet

Average number of Retweets published by the profile in the selected period, divided by the number of tweets in the selected period.
tweets_likes

Number of likes
(identical to top metric: 'Number of Likes')

Number of Likes on Tweets published in the selected period.
tweets_likes_per_post

Number of likes per tweet

Average number of Likes per day on tweets published in the selected period.
tweets_replies

Replies
(identical to top metric: 'Number of comments')

Number of Replies on Tweets published in the selected period.
tweets_quotes

Quotes

Number of times Tweets published in the selected period have been retweeted with a comment (also known as Quote).
tweets_impressions

Impressions
(identical to top metric: 'Impressions of posts')

Number of times Tweets published in the selected period has been viewed.
tweets_urlLinkClicks

URL Link Clicks

Number of times a user clicks on a URL link or URL preview card on Tweets published in the selected period.
tweets_userProfileClicks

User Profil Clicks

Number of times a user clicks display name, user name or profile picture on Tweets published in the selected period.
tweets_impressions_organic

Impressions (organic)
(identical to top metric: 'Organic impressions of posts')

Number of times Tweets published in the selected period have been viewed organically.
tweets_urlLinkClicks_organic

URL Link Clicks (organic)

Number of times a user clicks on a URL link or URL preview card on Tweets published in the selected period while beeing shown organically.
tweets_userProfileClicks_organic

User Profil Clicks (organic)

Number of times a user clicks display name, user name or profile picture on Tweets published in the selected period while beeing shown organically.
tweets_retweets_organic

Retweets (organic)

Number of times Tweets published in the selected period have been Retweeted while beeing shown organically.
tweets_replies_organic

Replies (organic)

Number of replies Tweets published in the selected period have received while beeing shown organically.
tweets_favorites_organic

Likes (organic)

Number of likes received on Tweets published in the selected period while beeing shown organically.
tweets_impressions_paid

Impressions (paid)
(identical to top metric: 'Paid impressions of posts')

Number of times Tweets published in the selected period have been viewed while being promoted.
tweets_urlLinkClicks_paid

URL Link Clicks (paid)

Number of times a user clicks on a URL link or URL preview card on Tweets published in the selected period while being promoted.
tweets_userProfileClicks_paid

User Profil Clicks (paid)

Number of times a user clicks display name, user name or profile picture on Tweets published in the selected period while being promoted.
tweets_retweets_paid

Retweets (paid)

Number of times Tweets published in the selected period have been Retweeted while being promoted.
tweets_replies_paid

Replies (paid)

Number of Replies to Tweets published in the selected period while being promoted.
tweets_favorites_paid

Likes (paid)

Number of Likes received on Tweets published in the selected period while being promoted.
profile_performance_index

Profile Performance Index
(identical to top metric: 'Page Performance Index')

Root product between the comparison values of the engagement value and the average weekly growth of a profile.
tweets_engagement

Engagement

Engagement is the average number of interactions on a profile's posts per follower per day. Engagement shows how successfully a profile encourages users to interact. By dividing by the number of followers, the Engagement becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values ​​of all posts. Finally, you divide this sum by the number of days in the period.<br> <br>An example of the calculation: <br>A profile posts 2 times in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>Engagement for this week (7 days) is calculated as follows: <br>(50/100 + 75/150) / 7 = 14.2%<br>In comparison, the post interaction (2 posts) results in: <br>(50/100 + 75/150) / 2 = 50%<br> <br>Post-interaction is closely related to Engagement. For Post-Interaction, the number of interactions is also divided by the number of followers, but then divided by the number of posts and not - as with Engagement - per day. Engagement is higher if a profile posts more often. The post interaction shows how successful the posts are on average.
tweets_interaction

Tweet Interaction
(identical to top metric: 'Post interaction rate')

Post-Interaction is the average number of interactions on a profile's posts per follower per post. Post-Interaction shows how successful the individual posts of a profile are on average in encouraging users to interact. By dividing by the number of followers, Post-Interaction becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values of all posts. Finally, you divide the number of posts in the period.<br> <br>An example of the calculation: <br>A profile makes 2 posts in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>The Post-Interaction (2 posts) results in: <br> (50/100 + 75/150) / 2 = 50%<br> In comparison, Engagement for this week (7 days) is: <br>(50/100 + 75/150) / 7 = 14.2%<br> <br>Engagement is closely related to post-interaction. For Engagement, the number of interactions is also divided by the number of followers, but then the average is calculated per day and not - as for Post-Interaction - per post. Engagement is therefore usually higher when a profile posts more often. Engagement shows how successfully a profile in total motivates users to interact.
tweets_retweeted_count

Retweeted/day

Number of Retweets published by the profile in the selected period, divided by the number of days in the selected period.
tweets_conversations_ratio

Conversations

Determined by the ratio of @-reply tweets to all tweets published in the selected period interacting with other Twitter profiles.
tweets_retweets_quotes_replies_and_likes

Retweets & likes
(identical to top metric: 'Number of Reactions, Comments & Shares')

Number of Retweets, Quotes, Replies and Likes on Tweets published in the selected period.
Task: /posts
Title: Posts and their metrics
URL structure: www.fanpagekarma.com/api/v1/twitter/ {PROFILE_ID} /posts?token= {TOKEN} &period= {PERIOD}
Description:

The task /posts returns the posts and their metrics of the Twitter 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 metrics will be returned.

Example: www.fanpagekarma.com/api/v1/twitter/813286/posts?token=abcdefghijklmnopqrstuvwxyz
Structure of the data-object:
{
"posts" : [
{
"id" : "identifier of the post",
"date" : "date of the post",
"message" : "message text of the post",
"link" : "link to the post",
"image" : "image url of the post",
"type" : "type of the post",
"kpi" : Same structure as data-object for the Task kpi,
},
...
]
}
Description of the elements of the kpi-object:
{NAME_OF_PROPERTY} title description
tweets_excluding_retweets

Tweets excluding retweets

Number of tweets excluding retweets published in the selected period. This includes quote tweets and replies/mentions.
tweets_retweets

Retweets

Number of Retweets (without comments) of Tweets published in the selected period.
page_posts_likes_count

Number of Likes

Average number of "like" reactions on posts published in the selected period.
page_posts_comments_count

Number of comments

<p>Number of comments on posts, videos, tweets, pins, etc. <br><br><b>Benefit</b><br> Comments give a better indication of whether a post actually appeals to users, since creating a comment takes significantly more effort than a simple like. Unfortunately, most of the comments on Instagram are not made by real people but by bots. <br><br><b>Calculation</b><br> All comments added together. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. </p>
tweets_quotes

Quotes

Number of times Tweets published in the selected period have been retweeted with a comment (also known as Quote).
page_posts_impressions

Impressions of posts

<p>Sum of total impressions of all posts posted during the selected period.<br><br><b>Benefit</b><br> Use this number to find out how many times all posts have been viewed in total. <br><br><b>Calculation</b><br> The total impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
tweets_urlLinkClicks

URL Link Clicks

Number of times a user clicks on a URL link or URL preview card on Tweets published in the selected period.
tweets_userProfileClicks

User Profil Clicks

Number of times a user clicks display name, user name or profile picture on Tweets published in the selected period.
page_post_impressions_organic

Organic impressions of posts

<p>Sum of organic impressions of all posts posted during the selected period. <br><br><b>Benefit</b><br> Use this number to find out how many times all posts have been viewed organically. <br><br><b>Calculation</b><br> The organic impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
tweets_urlLinkClicks_organic

URL Link Clicks (organic)

Number of times a user clicks on a URL link or URL preview card on Tweets published in the selected period while beeing shown organically.
tweets_userProfileClicks_organic

User Profil Clicks (organic)

Number of times a user clicks display name, user name or profile picture on Tweets published in the selected period while beeing shown organically.
tweets_retweets_organic

Retweets (organic)

Number of times Tweets published in the selected period have been Retweeted while beeing shown organically.
tweets_replies_organic

Replies (organic)

Number of replies Tweets published in the selected period have received while beeing shown organically.
tweets_favorites_organic

Likes (organic)

Number of likes received on Tweets published in the selected period while beeing shown organically.
page_post_impressions_paid

Paid impressions of posts

<p>Sum of paid impressions of all posts posted during the selected period. <br><br><b>Benefit</b><br> Use this number to find out how many times all paid posts have been viewed. <br><br><b>Calculation</b><br> The paid impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
tweets_urlLinkClicks_paid

URL Link Clicks (paid)

Number of times a user clicks on a URL link or URL preview card on Tweets published in the selected period while being promoted.
tweets_userProfileClicks_paid

User Profil Clicks (paid)

Number of times a user clicks display name, user name or profile picture on Tweets published in the selected period while being promoted.
tweets_retweets_paid

Retweets (paid)

Number of times Tweets published in the selected period have been Retweeted while being promoted.
tweets_replies_paid

Replies (paid)

Number of Replies to Tweets published in the selected period while being promoted.
tweets_favorites_paid

Likes (paid)

Number of Likes received on Tweets published in the selected period while being promoted.
page_total_engagement_count

Number of Reactions, Comments & Shares

<p>This number is the sum of public accessible interactions (likes, hearts, reactions, comments, pins, shares etc.) of all posts in the selected period. <br><br><b>Benefit</b><br> This metric shows you how actively people have interacted with a profile's posts. More interactions lead to higher visibility of the content and is the most important driver for organic reach. <br><br><b>Calculation</b><br> Sum of likes, hearts, reactions, comments, and shares of all posts in the selected period. In order to make this metric comparable to competitor profiles, only public accessible interactions are taken into account. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. <br>On Instagram only likes and comments are publicy available. <br>Clicks on links do not count towards interactions. </p>

INSTAGRAM

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

Instagram-Tasks:

Here is a detailed description of all available tasks for the network Instagram:
Task: /kpi
Title: Key Performance Indicators / Profile metrics
URL structure: www.fanpagekarma.com/api/v1/instagram/ {PROFILE_ID} /kpi?token= {TOKEN} &period= {PERIOD}
Description: The task /kpi returns the metrics of the Instagram profile for the given {PROFILE_ID}. These are essentially all the numbers and details you see in your Dashboard.

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

Example: www.fanpagekarma.com/api/v1/instagram/10206720/kpi?token=abcdefghijklmnopqrstuvwxyz
Structure 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 description
profile_followers

Follower
(identical to top metric: 'Fans')

Number of users on the last day of the selected period who follow the profile are called followers.
profile_followers_gain

New Follower

Accretion of new people who started to follow the profile in the selected period.
profile_followings

Following

Number of profiles followed by the profile from the last day of the selected period.
profile_followers_weekly_growth_rate

Follower Growth Average Weekly (in %)

Difference between the number of followers on the first and the last day of the selected period as an average weekly value.
profile_followers_growth_absolute

Follower Growth (absolute)

Difference between the number of followers on the first and the last day of the selected period.
profile_followers_growth_percent

Follower Growth (in %)

Percentage number of the difference between the number of followers of the first and last day of the selected period, divided by the number of followers of the first day in the selected period. Reflects the difference from the previous day in the history graph.
profile_followers_growth_absolute_per_day

Follower Growth per day (absolute)

Difference between the number of followers on the first and the last day of the selected period as an average value per day.
profile_followers_growth_since_first_date

Follower Growth since starting point (in %)

Percentage growth of followers between the first and last day of the selected period. Reflects the difference from the first day of the selected period for each day in the history graph.
profile_impressions

Impressions

Number of times in the selected period any media of your profile including ad activity entered a person's screen. This includes posts, stories and promotions.
profile_reach

Daily Reach
(identical to top metric: 'Daily Reach (total)')

Number of people in the selected period who had any media of your profile including ad activity enter their screen. This includes posts, stories and promotions. - This is an unique KPI, same events are counted only once per visitor, with Fanpage Karma at most once per day. This gives you a good impression of the daily activities. In the network, the period can refer to other periods and is then not comparable.
profile_profile_views

Profile views
(identical to top metric: 'Profile Views')

Number of profile views in the selected period.
profile_website_clicks

Website clicks

Number of clicks in the selected period on the "Website" button.
profile_text_message_clicks

Text message clicks

Number of clicks in the selected period on the "Message" button.
profile_phone_call_clicks

Phone call clicks

Number of clicks in the selected period on the "Call" button.
profile_get_directions_clicks

Get directions click

Number of clicks in the selected period on the "Directions" button.
profile_email_contacts

Email contacts

Number of clicks in the selected period on the "Email" button.
profile_reach_ad

Daily Reach (Ad)

Number of people in the selected period who had a ad media of your profile enter their screen.
profile_reach_story

Daily Reach (Story)

Number of people in the selected period who had a story media of your profile enter their screen.
profile_reach_post

Daily Reach (Post)

Number of people in the selected period who had a post media of your profile enter their screen.
profile_reach_reel

Daily Reach (Reel)

Number of people in the selected period who had a reel media of your profile enter their screen.
profile_reach_carousel

Daily Reach (Carousel)

Number of people in the selected period who had a carousel media of your profile enter their screen.
profile_reach_igtv

Daily Reach (IGTV)

Number of people in the selected period who had a IGTV media of your profile enter their screen.
profile_reach_live

Daily Reach (Live)

Number of people in the selected period who had a Live media of your profile enter their screen.
profile_reach_ar_effect

Daily Reach (AR Effect)

Number of people in the selected period who had a AR effect of your profile enter their screen.
profile_reach_follower

Daily Reach (Follower)

Number of follower in the selected period who had any media of your profile including ad activity enter their screen.
profile_reach_non_follower

Daily Reach (Non-Follower)

Number of non-follower in the selected period who had any media of your profile including ad activity enter their screen.
profile_reach_unknown

Daily Reach (unknown follower)

Number of people with unknown follower state in the selected period who had any media of your profile including ad activity enter their screen.
profile_reach_ad_follower

Daily Reach (Ad, Follower)

Number of follower in the selected period who had a ad media of your profile enter their screen.
profile_reach_ad_non_follower

Daily Reach (Ad, Non-Follower)

Number of non-follower in the selected period who had a ad media of your profile enter their screen.
profile_reach_ad_unknown

Daily Reach (Ad, unknown)

Number of people with unknown follower state in the selected period who had a ad media of your profile enter their screen.
profile_reach_story_follower

Daily Reach (Story, Follower)

Number of follower in the selected period who had a story media of your profile enter their screen.
profile_reach_story_non_follower

Daily Reach (Story, Non-Follower)

Number of non-follower in the selected period who had a story media of your profile enter their screen.
profile_reach_story_unknown

Daily Reach (Story, unknown)

Number of people with unknown follower state in the selected period who had a story media of your profile enter their screen.
profile_reach_post_follower

Daily Reach (Post, Follower)

Number of follower in the selected period who had a post media of your profile enter their screen.
profile_reach_post_non_follower

Daily Reach (Post, Non-Follower)

Number of non-follower in the selected period who had a post media of your profile enter their screen.
profile_reach_post_unknown

Daily Reach (Post, unknown)

Number of people with unknown follower state in the selected period who had a post media of your profile enter their screen.
profile_reach_reel_follower

Daily Reach (Reel, Follower)

Number of follower in the selected period who had a reel media of your profile enter their screen.
profile_reach_reel_non_follower

Daily Reach (Reel, Non-Follower)

Number of non-follower in the selected period who had a reel media of your profile enter their screen.
profile_reach_reel_unknown

Daily Reach (Reel, unknown)

Number of people with unknown follower state in the selected period who had a reel media of your profile enter their screen.
profile_reach_carousel_follower

Daily Reach (Carousel, Follower)

Number of follower in the selected period who had a carousel media of your profile enter their screen.
profile_reach_carousel_non_follower

Daily Reach (Carousel, Non-Follower)

Number of non-follower in the selected period who had a carousel media of your profile enter their screen.
profile_reach_carousel_unknown

Daily Reach (Carousel, Unknown)

Number of people with unknown follower state in the selected period who had a carousel media of your profile enter their screen.
profile_reach_igtv_follower

Daily Reach (IGTV, Follower)

Number of follower in the selected period who had a IGTV media of your profile enter their screen.
profile_reach_igtv_non_follower

Daily Reach (IGTV, Non-Follower)

Number of non-follower in the selected period who had a IGTV media of your profile enter their screen.
profile_reach_igtv_unknown

Daily Reach (IGTV, unknown)

Number of people with unknown follower state in the selected period who had a IGTV media of your profile enter their screen.
profile_reach_live_follower

Daily Reach (Live, Follower)

Number of follower in the selected period who had a Live media of your profile enter their screen.
profile_reach_live_non_follower

Daily Reach (Live, Non-Follower)

Number of non-follower in the selected period who had a Live media of your profile enter their screen.
profile_reach_live_unknown

Daily Reach (Live, Unknown)

Number of people with unknown follower state in the selected period who had a Live media of your profile enter their screen.
profile_reach_ar_effect_follower

Daily Reach (AR Effect, Follower)

Number of follower in the selected period who had a AR effect of your profile enter their screen.
profile_reach_ar_effect_non_follower

Daily Reach (AR Effect, Non-Follower)

Number of non-follower in the selected period who had a AR effect of your profile enter their screen.
profile_reach_ar_effect_unknown

Daily Reach (AR Effect, Unknown)

Number of people with unknown follower state in the selected period who had a AR effect of your profile enter their screen.
profile_total_interactions

Total interactions

The total number of post interactions, story interactions, reels interactions, video interactions and live video interactions, including any interactions on boosted content.
profile_total_interactions_ad

Total interactions (Ad)

The total number of interactions on ads. Interactions can include actions such as likes, saves, comments, shares or replies.
profile_total_interactions_story

Total interactions (Story)

The total number of interactions on stories. Interactions can include actions such as likes, saves, comments, shares or replies.
profile_total_interactions_post

Total interactions (Post)

The total number of interactions on posts. Interactions can include actions such as likes, saves, comments, shares or replies.
profile_total_interactions_reel

Total interactions (Reel)

The total number of interactions on reels. Interactions can include actions such as likes, saves, comments, shares or replies.
profile_total_interactions_carousel

Total interactions (Carousel)

The total number of interactions on carousels. Interactions can include actions such as likes, saves, comments, shares or replies.
profile_total_interactions_igtv

Total interactions (IGTV)

The total number of interactions on IGTV posts. Interactions can include actions such as likes, saves, comments, shares or replies.
profile_total_interactions_live

Total interactions (Live)

The total number of interactions on live videos. Interactions can include actions such as likes, saves, comments, shares or replies.
profile_total_interactions_ar_effect

Total interactions (AR effect)

The total number of interactions on AR effects. Interactions can include actions such as likes, saves, comments, shares or replies.
profile_demographic_audience_gender_age_average

Average age of followers
(identical to top metric: 'Average age of fans')

The average age of followers of the profile for whom demographic data exists.
profile_demographic_audience_gender_age_average_male

Average age of male followers
(identical to top metric: 'Average age of male fans')

The average age of male followers of the profile for whom demographic data exists.
profile_demographic_audience_gender_age_average_female

Average age of female followers
(identical to top metric: 'Average age of female fans')

The average age of female followers of the profile for whom demographic data exists.
profile_demographic_audience_gender_age_share_male

Share of male followers
(identical to top metric: 'Percentage of male fans')

Share of Follower, who are male.
profile_demographic_audience_gender_age_share_female

Share of female followers
(identical to top metric: 'Percentage of female fans')

Share of Follower, who are female.
profile_followers_followings_ratio

Followers-Following-Ratio

Ratio between people who follow the profile to people who the profile follows of the last day of the selected period.
profile_performance_index

Profile Performance Index
(identical to top metric: 'Page Performance Index')

Root product between the comparison values of the engagement value and the average weekly growth of a profile.
profile_performance_score

IN_PERFORMANCE_SCORE
(identical to top metric: 'Performance Score')

The Performance Score is calculated as the average of seven essential key figures by comparing them to millions of profiles in the Fanpage Karma database. To make the values comparable, they are normalized to the number of followers. In order to achieve a Performance Score of 100%, a profile must rank among the top 10% of each metric.
profile_media_count

Number of Posts
(identical to top metric: 'Number of posts')

Number of posts published in selected time period.
profile_media_per_day

Posts per day

Average number of posts per day published in the selected period.
profile_media_count_pictures

Number of Picture-Posts

Number of picture-posts published in selected time period.
profile_media_count_videos

Number of Video-Posts

Number of video-posts published in selected time period.
profile_media_count_carousel

Number of Carousel-Posts

Number of carousel-posts published in selected time period.
profile_media_igtv_count

Number of IGTV Posts

Number of IGTV posts published in selected time period.
profile_media_igtv_ratio

IGTV-Post/Post ratio

Ratio between igtv posts and posts published in the selected period.
profile_likes_count

Likes (organic)
(identical to top metric: 'Number of Likes')

Number of organic likes on posts published in the selected period.
profile_likes_count_total

Likes (total)

Number of organic and paid likes on posts published in the selected period.
profile_likes_count_paid

Likes (paid)

Number of paid likes on posts published in the selected period.
profile_comments_count

Comments (organic)
(identical to top metric: 'Number of comments')

Number of organic comments on posts published in the selected period.
profile_comments_count_total

Comments (total)

Number of organic and paid comments on posts published in the selected period.
profile_comments_count_paid

Comments (paid)

Number of paid comments on posts published in the selected period.<br/>This metric includes comments that were not created during a paid placement if they are responses to comments from paid placements. For this reason, this metric may differ from the number of comments in the reporting of ad accounts.
profile_comments_likes_count

Comments and Likes (organic)
(identical to top metric: 'Number of Reactions, Comments & Shares')

Number of organic likes and organic comments on posts published in the selected period.
profile_comments_likes_count_total

Comments and Likes (total)

Number of organic and paid likes & organic and paid comments on posts published in the selected period.
profile_comments_likes_count_paid

Comments and Likes (paid)

Number of paid likes and paid comments on posts published in the selected period.<br/>This metric includes comments that were not created during a paid placement if they are responses to comments from paid placements. For this reason, this metric may differ from the number of comments in the reporting of ad accounts.
profile_likes_count_per_post

Likes per post (organic)

Average number of organic likes on posts published in the selected period, divided by the number of posts in the selected period.
profile_likes_count_per_post_total

Likes per post (total)

Average number of organic and paid likes on posts published in the selected period, divided by the number of posts in the selected period.
profile_likes_count_per_post_paid

Likes per post (paid)

Average number of paid likes on posts published in the selected period, divided by the number of posts in the selected period.
profile_comments_count_per_post

Comments per post (organic)

Average number of organic comments on posts published in the selected period, divided by the number of posts in the selected period.
profile_comments_count_per_post_total

Comments per post (total)

Average number of organic and paid comments on posts published in the selected period, divided by the number of posts in the selected period.
profile_comments_count_per_post_paid

Comments per post (paid)

Average number of paid comments on posts published in the selected period, divided by the number of posts in the selected period.<br/>This metric includes comments that were not created during a paid placement if they are responses to comments from paid placements. For this reason, this metric may differ from the number of comments in the reporting of ad accounts.
profile_engagement

Engagement

Engagement is the average number of interactions on a profile's posts per follower per day. Engagement shows how successfully a profile encourages users to interact. By dividing by the number of followers, the Engagement becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values ​​of all posts. Finally, you divide this sum by the number of days in the period.<br> <br>An example of the calculation: <br>A profile posts 2 times in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>Engagement for this week (7 days) is calculated as follows: <br>(50/100 + 75/150) / 7 = 14.2%<br>In comparison, the post interaction (2 posts) results in: <br>(50/100 + 75/150) / 2 = 50%<br> <br>Post-interaction is closely related to Engagement. For Post-Interaction, the number of interactions is also divided by the number of followers, but then divided by the number of posts and not - as with Engagement - per day. Engagement is higher if a profile posts more often. The post interaction shows how successful the posts are on average.
profile_engagement_total

Engagement (total)

Engagement is the average number of interactions on a profile's posts per follower per day. Engagement shows how successfully a profile encourages users to interact. By dividing by the number of followers, the Engagement becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values ​​of all posts. Finally, you divide this sum by the number of days in the period.<br> <br>An example of the calculation: <br>A profile posts 2 times in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>Engagement for this week (7 days) is calculated as follows: <br>(50/100 + 75/150) / 7 = 14.2%<br>In comparison, the post interaction (2 posts) results in: <br>(50/100 + 75/150) / 2 = 50%<br> <br>Post-interaction is closely related to Engagement. For Post-Interaction, the number of interactions is also divided by the number of followers, but then divided by the number of posts and not - as with Engagement - per day. Engagement is higher if a profile posts more often. The post interaction shows how successful the posts are on average.
profile_engagement_paid

Engagement (paid)

Average number of paid likes and comments per day on posts of a day in relation to the number of followers of the same day in the selected period.
profile_media_interaction

Post Interaction
(identical to top metric: 'Post interaction rate')

Post-Interaction is the average number of interactions on a profile's posts per follower per post. Post-Interaction shows how successful the individual posts of a profile are on average in encouraging users to interact. By dividing by the number of followers, Post-Interaction becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values of all posts. Finally, you divide the number of posts in the period.<br> <br>An example of the calculation: <br>A profile makes 2 posts in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>The Post-Interaction (2 posts) results in: <br> (50/100 + 75/150) / 2 = 50%<br> In comparison, Engagement for this week (7 days) is: <br>(50/100 + 75/150) / 7 = 14.2%<br> <br>Engagement is closely related to post-interaction. For Engagement, the number of interactions is also divided by the number of followers, but then the average is calculated per day and not - as for Post-Interaction - per post. Engagement is therefore usually higher when a profile posts more often. Engagement shows how successfully a profile in total motivates users to interact.
profile_media_interaction_total

Post Interaction (total)

Average number of organic and paid likes and comments per follower on posts published in the selected period, divided by the number of posts in the selected period.
profile_media_interaction_paid

Post Interaction (paid)

Average number of paid likes and comments per follower on posts published in the selected period, divided by the number of posts in the selected period.
profile_post_impressions

Post/Reel impressions (organic)
(identical to top metric: 'Organic impressions of posts')

Number of times a Post published in the selected period entered a person's screen or a Reel played for at least 1ms (excluding replays) through organic distribution.
profile_post_reach

Post/Reel reach (organic)
(identical to top metric: 'Summed up organic reach of posts')

Number of people who had any of your Posts or Reels published in the selected period enter their screen through organic distribution.
profile_post_engagement

Post/Reel likes, comments + saves (organic)

Number of organic likes, organic comments and organic saves on posts/reels published in the selected period. <br/>This metric corresponds to the old Insights "Engagement" metric, which does not take Shares into account. We recommend using the new Insights metric "Post/Reel total interaction (organic)" instead.
profile_post_saved

Post/Reel saved (organic)

Number of organic saves on posts published in the selected period.
profile_post_video_views

Post video views / Reel plays (organic)

Number of times through organic distribution your videos/reels published in the selected period played. For reels, this is defined as video sessions with 1 ms or more of playback and excludes replays.
profile_post_plays

Reels initial plays (organic)

Number of times your Reels published in the selected period started to play after an impression is already counted while beeing shown organically. This is defined as video sessions with 1 ms or more of playback and excludes replays.
profile_post_replays

Reels replays (organic)

The number of times your reel starts to play again after an initial play of your reel. This is defined as replays of 1ms or more in the same reel session.
profile_post_aggregated_all_plays

Reels total plays (organic)

The number of times your reel starts to play or replay after an impression is already counted. This is defined as plays of 1ms or more. Replays are counted after the initial play in the same reel session.
profile_post_reels_view_total_time

Reels view total time (organic)

Reels View Total Time
profile_post_reels_avg_watch_time

Reels average watch time (organic)

Reels Average Watch Time
profile_post_shares

Reel shares (organic)

Number of times your Reels published in the selected period were shared while beeing shown organically.
profile_post_total_interactions

Post/Reel total interaction (organic)

Number of likes, comments, saves and shares, minus the number of unlikes, unsaves, and deleted comments on your Reels published in the selected period while beeing shown organically.
profile_post_interactions_divided_by_reach_per_post

Interaction per reached person per post
(identical to top metric: 'Interactions per reach per post')

Average number of interactions per post in relation to the number of users who have seen these posts.
profile_post_impressions_paid

Post impressions (paid)
(identical to top metric: 'Paid impressions of posts')

Number of times your posts published in the selected period entered a person's screen through paid distribution. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here.
profile_post_reach_paid

Post reach (paid)
(identical to top metric: 'Summed up paid reach of posts')

Number of people who had any of your posts published in the selected period enter their screen through paid distribution. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here.
profile_post_engagement_paid

Post likes, comments + saves (paid)

Number of paid likes, paid comments and paid saves on posts published in the selected period. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here. <br/>This metric corresponds to the old Insights "Engagement" metric, which does not take Shares into account. We recommend using the new Insights metric "Post/Reel total interaction (paid)" instead.
profile_post_saved_paid

Post saved (paid)

Number of paid saves on posts published in the selected period. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here.
profile_post_video_views_paid

Post video views (paid)

Number of times through paid distribution your videos published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels used in Ads, therefore the paid value for Reels is not included here.
profile_post_impressions_total

Post/Reel impressions (total)
(identical to top metric: 'Impressions of posts')

Number of times your posts published in the selected period entered a person's screen through organic and paid distribution or a Reel played for at least 1ms (excluding replays) through organic distribution. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here.
profile_post_reach_total

Post/Reel reach (total)
(identical to top metric: 'Summed up reach of posts')

Number of people who had any of your Posts or Reels published in the selected period enter their screen through organic and paid distribution. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here.
profile_post_engagement_total

Post/Reel likes, comments + saves (total)

Number of organic and paid likes, organic and paid comments & organic and paid saves on posts published in the selected period. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here. <br/>This metric corresponds to the old Insights "Engagement" metric, which does not take Shares into account. We recommend using the new Insights metric "Post/Reel total interaction (total)" instead.
profile_post_saved_total

Post/Reel saved (total)

Number of organic and paid saves on posts published in the selected period. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here.
profile_post_video_views_total

Post video views / Reel plays (total)

Number of times through organic and paid distribution your videos published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video. For reels, this is defined as video sessions with 1 ms or more of playback and excludes replays. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels used in Ads, therefore the paid value for Reels is not included here.
profile_post_follows

Number of new followers based on the post

Number of times Instagram users started following you in the selected time period after viewing a post of yours.
profile_post_profile_visits

Profile visits based on the post

Number of times Instagram users viewed your profile in the selected time period after viewing a post of yours.
profile_post_profile_activity_total

Post profile activity (Total)

The total number of actions on your profile after users have interacted with a post.
profile_post_profile_activity_bio_link

Post profile activity (bio link clicked)

The total number of clicks on the bio link in your profile after users have interacted with a post.
profile_post_profile_activity_call

Post profile activity (call)

The total number of calls from your profile after users have interacted with a post.
profile_post_profile_activity_direction

Post profile activity (direction)

The total number of card views on your profile after users have interacted with a post.
profile_post_profile_activity_email

Post profile activity (email)

The total number of emails from your profile after users have interacted with a post.
profile_post_profile_activity_text

Post profile activity (text)

The total number of text messages on your profile after users have interacted with a post.
profile_post_profile_activity_other

Post profile activity (other)

The total number of other interactions with your profile after users have interacted with a post.
profile_story_count

Number of Stories

Number of stories published in the selected period.
profile_story_impressions

Story impressions

Number of times stories published in the selected period entered a person's screen.
profile_story_reach

Story reach

Number of people who had stories published in the selected period enter their screen.
profile_story_replies

Story replies

Number of replies on stories published in the selected period.
profile_story_taps_forward

Story taps forward

Number of skips of stories published in the selected period.
profile_story_taps_back

Story taps back

Number of go backs of stories published in the selected period.
profile_story_exits

Story exits

Number of times stories published in the selected period entered a person's screen and got closed.
profile_story_navigation_swipe_forward

Story swipe forward

That's how many times your stories published in the selected time period were swiped forward.
profile_story_navigation_swipe_back

Story swipe back

That's how many times your stories published in the selected time period were swiped back.
profile_story_navigation_swipe_up

Story swipe up

That's how many times your stories published in the selected time period were swiped up.
profile_story_navigation_swipe_down

Story swipe down

That's how many times your stories published in the selected time period were swiped down.
profile_story_navigation_automatic_forward

Story automatic forward

That's how many times your stories published in the selected time period were automatically skipped.
profile_story_follows

Number of new followers based on the story

Number of times Instagram users started following you in the selected time period after viewing a Story of yours.
profile_story_total_interactions

Story total interaction

Number of likes, saves, comments, and shares excluding unlikes, unsaves, and deleted comments on stories published in the selected time period.
profile_story_profile_visits

Profile visits based on the story

Number of times Instagram users viewed your profile in the selected time period after viewing a Story of yours.
profile_story_shares

Story shares

Number of shares on stories published in the selected time period.
profile_story_profile_activity_total

Story profile activity (total)

The total number of actions on your profile after users have interacted with a story.
profile_story_profile_activity_bio_link

Story profile activity (bio link clicked)

The total number of clicks on the bio link in your profile after users have interacted with a story.
profile_story_profile_activity_call

Story profile activity (call)

The total number of calls from your profile after users have interacted with a story.
profile_story_profile_activity_direction

Story profile activity (direction)

The total number of card views across your profile after users have interacted with a story.
profile_story_profile_activity_email

Story profile activity (email)

The total number of emails from your profile after users have interacted with a story.
profile_story_profile_activity_text

Story profile activity (text)

The total number of text messages on your profile after users have interacted with a story.
profile_story_profile_activity_other

Story profile activity (other)

The total number of other interactions with your profile after users have interacted with a story.
Task: /posts
Title: Posts and their metrics
URL structure: www.fanpagekarma.com/api/v1/instagram/ {PROFILE_ID} /posts?token= {TOKEN} &period= {PERIOD}
Description:

The task /posts returns the posts and their metrics of the Instagram 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 metrics will be returned.

Example: www.fanpagekarma.com/api/v1/instagram/10206720/posts?token=abcdefghijklmnopqrstuvwxyz
Structure of the data-object:
{
"posts" : [
{
"id" : "identifier of the post",
"date" : "date of the post",
"message" : "message text of the post",
"link" : "link to the post",
"image" : "image url of the post",
"type" : "type of the post",
"kpi" : Same structure as data-object for the Task kpi,
},
...
]
}
Description of the elements of the kpi-object:
{NAME_OF_PROPERTY} title description
profile_media_count_pictures

Number of Picture-Posts

Number of picture-posts published in selected time period.
profile_media_count_videos

Number of Video-Posts

Number of video-posts published in selected time period.
profile_media_count_carousel

Number of Carousel-Posts

Number of carousel-posts published in selected time period.
profile_media_igtv_count

Number of IGTV Posts

Number of IGTV posts published in selected time period.
page_posts_likes_count

Number of Likes

Average number of "like" reactions on posts published in the selected period.
profile_likes_count_total

Likes (total)

Number of organic and paid likes on posts published in the selected period.
profile_likes_count_paid

Likes (paid)

Number of paid likes on posts published in the selected period.
page_posts_comments_count

Number of comments

<p>Number of comments on posts, videos, tweets, pins, etc. <br><br><b>Benefit</b><br> Comments give a better indication of whether a post actually appeals to users, since creating a comment takes significantly more effort than a simple like. Unfortunately, most of the comments on Instagram are not made by real people but by bots. <br><br><b>Calculation</b><br> All comments added together. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. </p>
profile_comments_count_total

Comments (total)

Number of organic and paid comments on posts published in the selected period.
profile_comments_count_paid

Comments (paid)

Number of paid comments on posts published in the selected period.<br/>This metric includes comments that were not created during a paid placement if they are responses to comments from paid placements. For this reason, this metric may differ from the number of comments in the reporting of ad accounts.
page_total_engagement_count

Number of Reactions, Comments & Shares

<p>This number is the sum of public accessible interactions (likes, hearts, reactions, comments, pins, shares etc.) of all posts in the selected period. <br><br><b>Benefit</b><br> This metric shows you how actively people have interacted with a profile's posts. More interactions lead to higher visibility of the content and is the most important driver for organic reach. <br><br><b>Calculation</b><br> Sum of likes, hearts, reactions, comments, and shares of all posts in the selected period. In order to make this metric comparable to competitor profiles, only public accessible interactions are taken into account. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. <br>On Instagram only likes and comments are publicy available. <br>Clicks on links do not count towards interactions. </p>
profile_comments_likes_count_total

Comments and Likes (total)

Number of organic and paid likes & organic and paid comments on posts published in the selected period.
profile_comments_likes_count_paid

Comments and Likes (paid)

Number of paid likes and paid comments on posts published in the selected period.<br/>This metric includes comments that were not created during a paid placement if they are responses to comments from paid placements. For this reason, this metric may differ from the number of comments in the reporting of ad accounts.
page_post_impressions_organic

Organic impressions of posts

<p>Sum of organic impressions of all posts posted during the selected period. <br><br><b>Benefit</b><br> Use this number to find out how many times all posts have been viewed organically. <br><br><b>Calculation</b><br> The organic impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
page_posts_impressions_organic_unique

Summed up organic reach of posts

<p>Sum of the organic reach of all posts that were posted in the selected period. <br><br><b>Benefit</b><br> Be careful when relying on this number to figure out how many people saw posts organically. The sum of the reach of posts can be higher than the daily reach due to double counting. <br><br><b>Calculation</b><br> The organic reach is added up for all posts in the specified period. It doesn't matter when the view happened. It counts when the post was posted. <br><br><b>Note</b> <br>Adding up reach values can result in people being counted twice if they have viewed several posts. It is better to use the metrics reach per day or reach per post if you don’t absolutely need the organic reach. </p>
profile_post_engagement

Post/Reel likes, comments + saves (organic)

Number of organic likes, organic comments and organic saves on posts/reels published in the selected period. <br/>This metric corresponds to the old Insights "Engagement" metric, which does not take Shares into account. We recommend using the new Insights metric "Post/Reel total interaction (organic)" instead.
profile_post_saved

Post/Reel saved (organic)

Number of organic saves on posts published in the selected period.
profile_post_video_views

Post video views / Reel plays (organic)

Number of times through organic distribution your videos/reels published in the selected period played. For reels, this is defined as video sessions with 1 ms or more of playback and excludes replays.
profile_post_plays

Reels initial plays (organic)

Number of times your Reels published in the selected period started to play after an impression is already counted while beeing shown organically. This is defined as video sessions with 1 ms or more of playback and excludes replays.
profile_post_replays

Reels replays (organic)

The number of times your reel starts to play again after an initial play of your reel. This is defined as replays of 1ms or more in the same reel session.
profile_post_aggregated_all_plays

Reels total plays (organic)

The number of times your reel starts to play or replay after an impression is already counted. This is defined as plays of 1ms or more. Replays are counted after the initial play in the same reel session.
profile_post_reels_view_total_time

Reels view total time (organic)

Reels View Total Time
profile_post_shares

Reel shares (organic)

Number of times your Reels published in the selected period were shared while beeing shown organically.
profile_post_total_interactions

Post/Reel total interaction (organic)

Number of likes, comments, saves and shares, minus the number of unlikes, unsaves, and deleted comments on your Reels published in the selected period while beeing shown organically.
page_post_impressions_paid

Paid impressions of posts

<p>Sum of paid impressions of all posts posted during the selected period. <br><br><b>Benefit</b><br> Use this number to find out how many times all paid posts have been viewed. <br><br><b>Calculation</b><br> The paid impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
page_posts_impressions_paid_unique

Summed up paid reach of posts

<p>Sum of the paid reach of all posts that were posted in the selected period. <br><br><b>Benefit</b><br> Be careful when relying on this number to figure out how many people saw posts because of ads or boosts. This is because the sum of the reach of posts can be higher than the daily reach due to double counting. <br><br><b>Calculation</b><br> The paid reach is added up for all posts in the specified period. It doesn't matter when the view happened. It counts when the post was posted. <br><br><b>Note</b> <br>Adding up reach values can result in people being counted twice if they have viewed several posts. It is better to use the metrics reach per day or reach per post if you don’t absolutely need the paid reach. </p>
profile_post_engagement_paid

Post likes, comments + saves (paid)

Number of paid likes, paid comments and paid saves on posts published in the selected period. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here. <br/>This metric corresponds to the old Insights "Engagement" metric, which does not take Shares into account. We recommend using the new Insights metric "Post/Reel total interaction (paid)" instead.
profile_post_saved_paid

Post saved (paid)

Number of paid saves on posts published in the selected period. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here.
profile_post_video_views_paid

Post video views (paid)

Number of times through paid distribution your videos published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels used in Ads, therefore the paid value for Reels is not included here.
page_posts_impressions

Impressions of posts

<p>Sum of total impressions of all posts posted during the selected period.<br><br><b>Benefit</b><br> Use this number to find out how many times all posts have been viewed in total. <br><br><b>Calculation</b><br> The total impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
page_posts_impressions_unique

Summed up reach of posts

<p>Sum of the total reach of all posts that were posted in the selected period. <br><br><b>Benefit</b><br> Be careful when relying on this number to figure out how many people saw posts. The sum of the reach of posts is likely to be higher than the daily reach due to double counting. <br><br><b>Calculation</b><br> The paid reach is added up for all posts in the specified period. It doesn't matter when the view happened. It counts when the post was posted. <br><br><b>Note</b> <br>Adding up reach values can result in people being counted twice if they have viewed several posts. It is better to use the metrics reach per day or reach per post. You can also better use these metrics for comparison with other profiles. If you want a high overall total, then use impressions of the posts. </p>
profile_post_engagement_total

Post/Reel likes, comments + saves (total)

Number of organic and paid likes, organic and paid comments & organic and paid saves on posts published in the selected period. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here. <br/>This metric corresponds to the old Insights "Engagement" metric, which does not take Shares into account. We recommend using the new Insights metric "Post/Reel total interaction (total)" instead.
profile_post_saved_total

Post/Reel saved (total)

Number of organic and paid saves on posts published in the selected period. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels or organic Carousels used in Ads, therefore the paid value for Reels and Carousels is not included here.
profile_post_video_views_total

Post video views / Reel plays (total)

Number of times through organic and paid distribution your videos published in the selected period played for at least 3 seconds, or for nearly their total length if they're shorter than 3 seconds. During a single instance of a video playing, we'll exclude any time spent replaying the video. For reels, this is defined as video sessions with 1 ms or more of playback and excludes replays. At the moment, Instagram does not allow to fetch paid insights metrics for organic Reels used in Ads, therefore the paid value for Reels is not included here.
Task: /stories
Title: Stories and their metrics
URL structure: www.fanpagekarma.com/api/v1/instagram/ {PROFILE_ID} /stories?token= {TOKEN} &period= {PERIOD}
Description:

The task /stories returns the stories and their metrics of the Instagram 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 metrics will be returned.

Example: www.fanpagekarma.com/api/v1/instagram/10206720/stories?token=abcdefghijklmnopqrstuvwxyz
Structure of the data-object:
{
"posts" : [
{
"id" : "identifier of the story",
"date" : "date of the story",
"link" : "link to the story",
"image" : "image url of the story",
"type" : "type of the story",
"kpi" : Same structure as data-object for the Task kpi,
},
...
]
}
Description of the elements of the kpi-object:
{NAME_OF_PROPERTY} title description
profile_post_follows

Number of new followers based on the post

Number of times Instagram users started following you in the selected time period after viewing a post of yours.
profile_post_profile_visits

Profile visits based on the post

Number of times Instagram users viewed your profile in the selected time period after viewing a post of yours.
profile_post_profile_activity_total

Post profile activity (Total)

The total number of actions on your profile after users have interacted with a post.
profile_post_profile_activity_bio_link

Post profile activity (bio link clicked)

The total number of clicks on the bio link in your profile after users have interacted with a post.
profile_post_profile_activity_call

Post profile activity (call)

The total number of calls from your profile after users have interacted with a post.
profile_post_profile_activity_direction

Post profile activity (direction)

The total number of card views on your profile after users have interacted with a post.
profile_post_profile_activity_email

Post profile activity (email)

The total number of emails from your profile after users have interacted with a post.
profile_post_profile_activity_text

Post profile activity (text)

The total number of text messages on your profile after users have interacted with a post.
profile_post_profile_activity_other

Post profile activity (other)

The total number of other interactions with your profile after users have interacted with a post.
profile_story_impressions

Story impressions

Number of times stories published in the selected period entered a person's screen.
profile_story_reach

Story reach

Number of people who had stories published in the selected period enter their screen.
profile_story_replies

Story replies

Number of replies on stories published in the selected period.
profile_story_taps_forward

Story taps forward

Number of skips of stories published in the selected period.
profile_story_taps_back

Story taps back

Number of go backs of stories published in the selected period.
profile_story_exits

Story exits

Number of times stories published in the selected period entered a person's screen and got closed.
profile_story_navigation_swipe_forward

Story swipe forward

That's how many times your stories published in the selected time period were swiped forward.
profile_story_navigation_swipe_back

Story swipe back

That's how many times your stories published in the selected time period were swiped back.
profile_story_navigation_swipe_up

Story swipe up

That's how many times your stories published in the selected time period were swiped up.
profile_story_navigation_swipe_down

Story swipe down

That's how many times your stories published in the selected time period were swiped down.
profile_story_navigation_automatic_forward

Story automatic forward

That's how many times your stories published in the selected time period were automatically skipped.
profile_story_follows

Number of new followers based on the story

Number of times Instagram users started following you in the selected time period after viewing a Story of yours.
profile_story_total_interactions

Story total interaction

Number of likes, saves, comments, and shares excluding unlikes, unsaves, and deleted comments on stories published in the selected time period.
profile_story_profile_visits

Profile visits based on the story

Number of times Instagram users viewed your profile in the selected time period after viewing a Story of yours.
profile_story_shares

Story shares

Number of shares on stories published in the selected time period.
profile_story_profile_activity_total

Story profile activity (total)

The total number of actions on your profile after users have interacted with a story.
profile_story_profile_activity_bio_link

Story profile activity (bio link clicked)

The total number of clicks on the bio link in your profile after users have interacted with a story.
profile_story_profile_activity_call

Story profile activity (call)

The total number of calls from your profile after users have interacted with a story.
profile_story_profile_activity_direction

Story profile activity (direction)

The total number of card views across your profile after users have interacted with a story.
profile_story_profile_activity_email

Story profile activity (email)

The total number of emails from your profile after users have interacted with a story.
profile_story_profile_activity_text

Story profile activity (text)

The total number of text messages on your profile after users have interacted with a story.
profile_story_profile_activity_other

Story profile activity (other)

The total number of other interactions with your profile after users have interacted with a story.

PINTEREST

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

Pinterest-Tasks:

Here is a detailed description of all available tasks for the network Pinterest:
Task: /kpi
Title: Key Performance Indicators / Profile metrics
URL structure: www.fanpagekarma.com/api/v1/pinterest/ {PROFILE_NAME} /kpi?token= {TOKEN} &period= {PERIOD}
Description: The task /kpi returns the metrics of the Pinterest profile for the given {PROFILE_NAME}. These are essentially all the numbers and details you see in your Dashboard.

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

Example: www.fanpagekarma.com/api/v1/pinterest/barackobama/kpi?token=abcdefghijklmnopqrstuvwxyz
Structure 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 description
pinner_follower_count

Follower
(identical to top metric: 'Fans')

Number of users on the last day of the selected period who follow the profile are called followers.
pinner_followings_count

Following

Number of profiles followed by the profile of the last day of the selected period.
pinner_board_count

Boards

Number of boards on the last day of the selected period.
pinner_update_count

Number of Pins
(identical to top metric: 'Number of posts')

Number of pins published in selected time period.
pinner_done_created_count

Has tried

Number of Has Tried by the profile on other pins published by other profiles during the selected time period.
pinner_pins_likes_count

Likes
(identical to top metric: 'Number of Likes')

Number of likes on pins published in the selected period.
pinner_pins_repins_count

Repins

Number of times people saved pins published in the selected period to one of their boards.
pinner_pins_saves_total_count

Saves total

Number of saves on the own pins and repins published in the selected period.
pinner_pins_saves_own_count

Saves of own Pins

Number of saves on the own pins published in the selected period.
pinner_pins_comments_count

Comments
(identical to top metric: 'Number of comments')

Number of comments on pins published in the selected period.
pinner_pins_comments_likes_repins_count

Comments, Likes and Repins
(identical to top metric: 'Number of Reactions, Comments & Shares')

Number of likes, comments and repins on pins published in the selected period.
pinner_pins_done_count

Tried it

Number of Tried it on pins published in the selected period.
pinner_pins_comments_saves_own_count

Comments and saves of own Pins

Number of comments and saves of own pins published in the selected period.
pinner_pins_comments_saves_own_done_count

Comments, saves of own Pins and tried it

Number of comments, saves and Tried it of own pins published in the selected period.
pinner_pins_reaction_count

Reactions per post

Average number of reactions (like, haha, thanks, good idea, wow) on pins published in the selected period, divided by the number of pins in the selected period.
pinner_pins_original_repin_ratio

Original-Repin-Ratio

Ratio between original pins and repins of profile of the last day of the selected period.
pinner_pins_comments_repins_done_count

Comments, Repins and tried it

Number of comments, saves and Tried it of own pins published in the selected period.
pinner_pins_rating_count

Rating

Average rating rate on pins published in the selected period and which have been rated by users.
pinner_pins_likes_count_per_post

Likes per Pin

Average number of likes on pins published in the selected period, divided by the number of pins in the selected period.
pinner_pins_repins_count_per_post

Repins per Pin

Average number of repins in the selected period, divided by the number of pins in the selected period.
pinner_pins_comments_count_per_post

Comments per Pin

Average number of comments on pins published in the selected period, divided by the number of pins in the selected period.
pinner_pins_saves_total_count_per_post

Saves total per Pin

Average number of saves on the own pins and repins published in the selected period.
pinner_pins_saves_own_count_per_post

Saves of own Pins per Pin

Average number of saves on the own pins published in the selected period.
pinner_pins_didit_count_per_post

Tried it per Pin

Average number of Tried it on pins published in the selected period.
profile_followers_weekly_growth_rate

Follower Growth Average Weekly (in %)

Difference between the number of followers on the first and the last day of the selected period as an average weekly value.
profile_followers_growth_absolute

Follower Growth (absolute)

Difference between the number of followers on the first and the last day of the selected period.
profile_followers_growth_percent

Follower Growth (in %)

Percentage number of the difference between the number of followers of the first and last day of the selected period, divided by the number of followers of the first day in the selected period. Reflects the difference from the previous day in the history graph.
profile_followers_growth_absolute_per_day

Follower Growth per day (absolute)

Difference between the number of followers on the first and the last day of the selected period as an average value per day.
profile_followers_growth_since_first_date

Follower Growth since starting point (in %)

Percentage growth of followers between the first and last day of the selected period. Reflects the difference from the first day of the selected period for each day in the history graph.
profile_followers_followings_ratio

Followers-Following-Ratio

Ratio between people who follow the profile to people who the profile follows of the last day of the selected period.
pinner_engagement

Engagement

Engagement is defined as the average number of interactions on a profile's posts per follower per day.
pinner_updates_interaction

Post Interaction
(identical to top metric: 'Post interaction rate')

Post-Interaction is the average number of interactions on a profile's posts per follower per post. Post-Interaction shows how successful the individual posts of a profile are on average in encouraging users to interact. By dividing by the number of followers, Post-Interaction becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values of all posts. Finally, you divide the number of posts in the period.<br> <br>An example of the calculation: <br>A profile makes 2 posts in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>The Post-Interaction (2 posts) results in: <br> (50/100 + 75/150) / 2 = 50%<br> In comparison, Engagement for this week (7 days) is: <br>(50/100 + 75/150) / 7 = 14.2%<br> <br>Engagement is closely related to post-interaction. For Engagement, the number of interactions is also divided by the number of followers, but then the average is calculated per day and not - as for Post-Interaction - per post. Engagement is therefore usually higher when a profile posts more often. Engagement shows how successfully a profile in total motivates users to interact.
pinner_performance_index

Profile Performance Index
(identical to top metric: 'Page Performance Index')

Root product between the comparison values of the engagement value and the average weekly growth of a profile.
pinner_update_count_per_day

Pins per day
(identical to top metric: 'Posts per day')

Average number of pins per day published in the selected period.
Task: /posts
Title: Posts and their metrics
URL structure: www.fanpagekarma.com/api/v1/pinterest/ {PROFILE_ID} /posts?token= {TOKEN} &period= {PERIOD}
Description:

The task /posts returns the posts and their metrics of the Pinterest 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 metrics will be returned.

Example: www.fanpagekarma.com/api/v1/pinterest/barackobama/posts?token=abcdefghijklmnopqrstuvwxyz
Structure of the data-object:
{
"posts" : [
{
"id" : "identifier of the post",
"date" : "date of the post",
"message" : "message text of the post",
"link" : "link to the post",
"image" : "image url of the post",
"type" : "type of the post",
"kpi" : Same structure as data-object for the Task kpi,
},
...
]
}
Description of the elements of the kpi-object:
{NAME_OF_PROPERTY} title description
page_posts_likes_count

Number of Likes

Average number of "like" reactions on posts published in the selected period.
pinner_pins_repins_count

Repins

Number of times people saved pins published in the selected period to one of their boards.
pinner_pins_saves_total_count

Saves total

Number of saves on the own pins and repins published in the selected period.
pinner_pins_saves_own_count

Saves of own Pins

Number of saves on the own pins published in the selected period.
page_posts_comments_count

Number of comments

<p>Number of comments on posts, videos, tweets, pins, etc. <br><br><b>Benefit</b><br> Comments give a better indication of whether a post actually appeals to users, since creating a comment takes significantly more effort than a simple like. Unfortunately, most of the comments on Instagram are not made by real people but by bots. <br><br><b>Calculation</b><br> All comments added together. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. </p>
page_total_engagement_count

Number of Reactions, Comments & Shares

<p>This number is the sum of public accessible interactions (likes, hearts, reactions, comments, pins, shares etc.) of all posts in the selected period. <br><br><b>Benefit</b><br> This metric shows you how actively people have interacted with a profile's posts. More interactions lead to higher visibility of the content and is the most important driver for organic reach. <br><br><b>Calculation</b><br> Sum of likes, hearts, reactions, comments, and shares of all posts in the selected period. In order to make this metric comparable to competitor profiles, only public accessible interactions are taken into account. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. <br>On Instagram only likes and comments are publicy available. <br>Clicks on links do not count towards interactions. </p>
pinner_pins_done_count

Tried it

Number of Tried it on pins published in the selected period.
pinner_pins_comments_saves_own_count

Comments and saves of own Pins

Number of comments and saves of own pins published in the selected period.
pinner_pins_comments_saves_own_done_count

Comments, saves of own Pins and tried it

Number of comments, saves and Tried it of own pins published in the selected period.
pinner_pins_comments_repins_done_count

Comments, Repins and tried it

Number of comments, saves and Tried it of own pins published in the selected period.

YOUTUBE

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

YouTube-Tasks:

Here is a detailed description of all available tasks for the network YouTube:
Task: /kpi
Title: Key Performance Indicators / Profile metrics
URL structure: www.fanpagekarma.com/api/v1/youtube/ {PROFILE_ID} /kpi?token= {TOKEN} &period= {PERIOD}
Description: The task /kpi returns the metrics of the YouTube profile for the given {PROFILE_ID}. These are essentially all the numbers and details you see in your Dashboard.

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

Example: www.fanpagekarma.com/api/v1/youtube/UCdn86UYrf54lXfVli9CB6Aw/kpi?token=abcdefghijklmnopqrstuvwxyz
Structure 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 description
channel_subscribers_count

Total number of subscribers
(identical to top metric: 'Fans')

Number of users on the last day of the selected period who subscribe to the channel are called subscribers.
channel_subscribers_weekly_growth_rate

Follower Growth Average Weekly (in %)

Difference between the number of subscribers on the first and the last day of the selected period as an average weekly value.
channel_subscribers_growth

Follower Growth (in %)

Percentage number of the difference between the number of subscribers of the first and last day in relation to the number of subscribers of the first day of the selected period. Reflects the difference from the previous day in the history graph.
channel_subscribers_absolute_change

Follower Growth (absolute)

Difference between the number of subscribers on the first and the last day of the selected period.
channel_subscribers_growth_absolute_per_day

Follower Growth per day (absolute)

Difference between the number of subscribers on the first and the last day of the selected period as an average value per day.
channel_subscribers_growth_percent_since_first_date

Follower Growth since starting point (in %)

Percentage growth of subscribers between the first and last day of the selected period. Reflects the difference from the first day of the selected period for each day in the history graph.
channel_views_count

Total number of channel views

Number of times your channel was viewed in total.
channel_views_absolute_change

Channel Views Growth (absolute)

Difference in number of channel views between the first and last day of the selected period.
youtube_channel_average_view_duration

Average view duration (in sec)

The average length, in seconds, of video playbacks across the YouTube channel per day.
youtube_channel_estimated_minutes_watched

Estimated minutes watched

The number of minutes that users watched videos for the specified channel per day.
youtube_channel_shares_per_day

Total number shares per day

This is the total number of times per day that YouTube channel videos were shared by users.
youtube_channel_likes_per_day

Total number likes per day

This is the total number of positive ratings given per day for all videos on your YouTube channel.
youtube_channel_dislikes_per_day

Total number dislikes per day

This is the total number of negative ratings given per day for all videos on your YouTube channel.
youtube_channel_views_per_day

Total number views per day

The total number of views per day for all videos on your YouTube channel.
youtube_channel_comments_per_day

Total number comments per day

This is the total number of comments made across all videos on a YouTube channel in one day.
youtube_channel_likes_dislikes_ratio_per_day

Average Likes / Dislikes ratio

Ratio between likes and dislikes on whole YouTube channel per day.
youtube_channel_daily_engagement

Daily engagement rate

This metric helps you understand how much your subscribers are interacting with your YouTube channel. All likes/dislikes, shares, and comments for all videos in a day are taken into account and put in relation to the number of subscribers.
youtube_channel_daily_view_engagement

Daily engagement rate views

This metric shows how often viewers interact with your videos. All likes/dislikes, shares, and comments for all videos in a day are taken into account and compared to all views in the same day.<br><br>If you publish videos frequently, this metric is highly recommended.
channel_likes_count

Total Likes
(identical to top metric: 'Number of Likes')

Number of likes on Videos and Shorts published in the selected period.
channel_likes_count_per_post

Average Likes

Average number of likes on Videos and Shorts published in the selected period, divided by the number of Videos and Shorts in the selected period.
channel_dislikes_count

Total Dislikes

Number of dislikes on Videos and Shorts published in the selected period.
channel_dislikes_count_per_post

Average Dislikes

Average number of dislikes on Videos and Shorts published in the selected period, divided by the number of Videos and Shorts in the selected period.
channel_comments_count

Total Comments
(identical to top metric: 'Number of comments')

Number of comments on Videos and Shorts published in the selected period.
channel_comments_count_per_post

Average Comments

Average number of comments on Videos and Shorts published in the selected period, divided by the number of Videos and Shorts in the selected period.
channel_likes_dislikes_comments_count

YT_LIKES_DISLIKES_COMMENTS
(identical to top metric: 'Number of Reactions, Comments & Shares')

Number of likes, dislikes and comments on Videos and Shorts published in the selected period.
channel_video_interaction

YT_VIDEO_INTERACTION
(identical to top metric: 'Post interaction rate')

Post-Interaction is the average number of interactions on a profile's posts per follower per post. Post-Interaction shows how successful the individual posts of a profile are on average in encouraging users to interact. By dividing by the number of followers, Post-Interaction becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values of all posts. Finally, you divide the number of posts in the period.<br> <br>An example of the calculation: <br>A profile makes 2 posts in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>The Post-Interaction (2 posts) results in: <br> (50/100 + 75/150) / 2 = 50%<br> In comparison, Engagement for this week (7 days) is: <br>(50/100 + 75/150) / 7 = 14.2%<br> <br>Engagement is closely related to post-interaction. For Engagement, the number of interactions is also divided by the number of followers, but then the average is calculated per day and not - as for Post-Interaction - per post. Engagement is therefore usually higher when a profile posts more often. Engagement shows how successfully a profile in total motivates users to interact.
channel_video_view_count

Number of total Video Views
(identical to top metric: 'Impressions of posts')

Number of views of Videos and Shorts published in the selected period.
channel_views_per_video

Views per Video

Average number of times your Videos and Shorts published in the selected period were viewed.
channel_likes_dislikes_ratio

Likes / Dislikes ratio

Ratio between likes and dislikes on Videos and Shorts published in the selected period.
channel_total_videos_count

Total number of videos

Total number of public videos on account.
channel_videos_count

Number of videos
(identical to top metric: 'Number of posts')

Number of Videos and Shorts published in selected time period.
channel_shorts_likes_count

Shorts: Total Likes

Number of likes on Shorts published in the selected period.
channel_shorts_likes_count_per_post

Shorts: Average Likes

Average number of likes on Shorts published in the selected period, divided by the number of Shorts in the selected period.
channel_shorts_dislikes_count

Shorts: Total Dislikes

Number of dislikes on Shorts published in the selected period.
channel_shorts_dislikes_count_per_post

Shorts: Average Dislikes

Average number of dislikes on Shorts published in the selected period, divided by the number of Shorts in the selected period.
channel_shorts_comments_count

Shorts: Total Comments

Number of comments on Shorts published in the selected period.
channel_shorts_comments_count_per_post

Shorts: Average Comments

Average number of comments on Shorts published in the selected period, divided by the number of Shorts in the selected period.
channel_shorts_likes_dislikes_comments_count

Shorts: Total Reactions, Comments, Shares

Number of likes, dislikes and comments on Shorts published in the selected period.
channel_shorts_video_interaction

Shorts: Interactions per impression

Average number of "likes", "dislikes" and "comments" per Shorts for the Shorts of one day in relation to the number of followers on the same day in the selected period.
channel_shorts_video_view_count

Shorts: Number of total Video Views

Number of views of Shorts published in the selected period.
channel_shorts_views_per_video

Shorts: Average views

Average number of times your Shorts published in the selected period were viewed.
channel_shorts_likes_dislikes_ratio

Shorts: Likes / Dislikes ratio

Ratio between likes and dislikes on Shorts published in the selected period.
channel_shorts_videos_count

Shorts: Number of videos

Number of Shorts published in selected time period.
channel_videos_likes_count

Videos: Total Likes

Number of likes on Videos published in the selected period.
channel_videos_likes_count_per_post

Videos: Average Likes

Average number of likes on Videos published in the selected period, divided by the number of Videos in the selected period.
channel_videos_dislikes_count

Videos: Total Dislikes

Number of dislikes on Videos published in the selected period.
channel_videos_dislikes_count_per_post

Videos: Average Dislikes

Average number of dislikes on Videos published in the selected period, divided by the number of Videos in the selected period.
channel_videos_comments_count

Videos: Total Comments

Number of comments on Videos published in the selected period.
channel_videos_comments_count_per_post

Videos: Average Comments

Average number of comments on Videos published in the selected period, divided by the number of Videos in the selected period.
channel_videos_likes_dislikes_comments_count

Videos: Total Reactions, Comments, Shares

Number of likes, dislikes and comments on Videos published in the selected period.
channel_videos_video_interaction

Videos: Interactions per impression

Average number of "likes", "dislikes" and "comments" per Video for the Videos of one day in relation to the number of followers on the same day in the selected period.
channel_videos_video_view_count

Videos: Number of total Video Views

Number of views of Videos published in the selected period.
channel_videos_views_per_video

Videos: Average views

Average number of times your Videos published in the selected period were viewed.
channel_videos_likes_dislikes_ratio

Videos: Likes / Dislikes ratio

Ratio between likes and dislikes on Videos published in the selected period.
channel_videos_videos_count

Videos: Number of videos

Number of Videos published in selected time period.
Task: /posts
Title: Posts and their metrics
URL structure: www.fanpagekarma.com/api/v1/youtube/ {PROFILE_ID} /posts?token= {TOKEN} &period= {PERIOD}
Description:

The task /posts returns the posts and their metrics of the YouTube 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 metrics will be returned.

Example: www.fanpagekarma.com/api/v1/youtube/UCdn86UYrf54lXfVli9CB6Aw/posts?token=abcdefghijklmnopqrstuvwxyz
Structure of the data-object:
{
"posts" : [
{
"id" : "identifier of the post",
"date" : "date of the post",
"message" : "message text of the post",
"link" : "link to the post",
"image" : "image url of the post",
"type" : "type of the post",
"kpi" : Same structure as data-object for the Task kpi,
},
...
]
}
Description of the elements of the kpi-object:
{NAME_OF_PROPERTY} title description
page_posts_likes_count

Number of Likes

Average number of "like" reactions on posts published in the selected period.
channel_dislikes_count

Total Dislikes

Number of dislikes on Videos and Shorts published in the selected period.
page_posts_comments_count

Number of comments

<p>Number of comments on posts, videos, tweets, pins, etc. <br><br><b>Benefit</b><br> Comments give a better indication of whether a post actually appeals to users, since creating a comment takes significantly more effort than a simple like. Unfortunately, most of the comments on Instagram are not made by real people but by bots. <br><br><b>Calculation</b><br> All comments added together. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. </p>
page_total_engagement_count

Number of Reactions, Comments & Shares

<p>This number is the sum of public accessible interactions (likes, hearts, reactions, comments, pins, shares etc.) of all posts in the selected period. <br><br><b>Benefit</b><br> This metric shows you how actively people have interacted with a profile's posts. More interactions lead to higher visibility of the content and is the most important driver for organic reach. <br><br><b>Calculation</b><br> Sum of likes, hearts, reactions, comments, and shares of all posts in the selected period. In order to make this metric comparable to competitor profiles, only public accessible interactions are taken into account. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. <br>On Instagram only likes and comments are publicy available. <br>Clicks on links do not count towards interactions. </p>
page_posts_impressions

Impressions of posts

<p>Sum of total impressions of all posts posted during the selected period.<br><br><b>Benefit</b><br> Use this number to find out how many times all posts have been viewed in total. <br><br><b>Calculation</b><br> The total impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
channel_shorts_likes_count

Shorts: Total Likes

Number of likes on Shorts published in the selected period.
channel_shorts_dislikes_count

Shorts: Total Dislikes

Number of dislikes on Shorts published in the selected period.
channel_shorts_comments_count

Shorts: Total Comments

Number of comments on Shorts published in the selected period.
channel_shorts_likes_dislikes_comments_count

Shorts: Total Reactions, Comments, Shares

Number of likes, dislikes and comments on Shorts published in the selected period.
channel_shorts_video_view_count

Shorts: Number of total Video Views

Number of views of Shorts published in the selected period.
channel_shorts_videos_count

Shorts: Number of videos

Number of Shorts published in selected time period.
channel_videos_likes_count

Videos: Total Likes

Number of likes on Videos published in the selected period.
channel_videos_dislikes_count

Videos: Total Dislikes

Number of dislikes on Videos published in the selected period.
channel_videos_comments_count

Videos: Total Comments

Number of comments on Videos published in the selected period.
channel_videos_likes_dislikes_comments_count

Videos: Total Reactions, Comments, Shares

Number of likes, dislikes and comments on Videos published in the selected period.
channel_videos_video_view_count

Videos: Number of total Video Views

Number of views of Videos published in the selected period.
channel_videos_videos_count

Videos: Number of videos

Number of Videos published in selected time period.

LINKEDIN

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

LinkedIn-Tasks:

Here is a detailed description of all available tasks for the network LinkedIn:
Task: /kpi
Title: Key Performance Indicators / Profile metrics
URL structure: www.fanpagekarma.com/api/v1/linkedin/ {PROFILE_ID} /kpi?token= {TOKEN} &period= {PERIOD}
Description: The task /kpi returns the metrics of the LinkedIn profile for the given {PROFILE_ID}. These are essentially all the numbers and details you see in your Dashboard.

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

Example: www.fanpagekarma.com/api/v1/linkedin/2029/kpi?token=abcdefghijklmnopqrstuvwxyz
Structure 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 description
company_followers

Follower
(identical to top metric: 'Fans')

Number of users on the last day of the selected period who follow the profile are called followers.
profile_followers_gain

New Follower

Accretion of new people who started to follow the profile in the selected period.
profile_followers_gain_organic

New Follower (organic)

Accretion of new people who started to follow the profile through organic content in the selected period.
profile_followers_gain_paid

New Follower (paid)

Accretion of new people who started to follow the profile through paid content in the selected period.
company_organic

Follower organic (obsolete)

Unfortunately, this KPI is obsolete.
company_paid

Follower paid (obsolete)

Unfortunately, this KPI is obsolete.
profile_followers_weekly_growth_rate

Follower Growth Average Weekly (in %)

Difference between the number of followers on the first and the last day of the selected period as an average weekly value.
profile_followers_growth_absolute

Follower Growth (absolute)

Difference between the number of followers on the first and the last day of the selected period.
profile_followers_growth_percent

Follower Growth (in %)

Percentage number of the difference between the number of followers of the first and last day of the selected period, divided by the number of followers of the first day in the selected period. Reflects the difference from the previous day in the history graph.
profile_followers_growth_since_first_date

Follower Growth since starting point (in %)

Percentage growth of followers between the first and last day of the selected period. Reflects the difference from the first day of the selected period for each day in the history graph.
profile_likes_on_day

Likes in time period

Number of likes in the selected period on your status updates through organic distribution.
profile_impressions_on_day

Impressions in time period
(identical to top metric: 'Impressions')

Number of times in the selected period any of your status updates entered a person's screen through organic distribution.
profile_clicks_on_day

Clicks in time period

Number of clicks in the selected period on your status updates through organic distribution.
profile_comments_on_day

Comments in time period

Number of comments in the selected period on your status updates through organic distribution.
profile_shares_on_day

Shares in time period

Number of shares in the selected period on your status updates through organic distribution.
profile_engagement_on_day

Engagement per day in time period

Average number of interactions in the selected period on status updates through organic distribution in relation to the number of followers of the same day in the selected period, divided by the number of days in the selected period.
profile_unique_impressions_on_day

Unique impressions per day in time period
(identical to top metric: 'Daily Reach (total)')

Number of people in the selected period per day who saw your status updates through organic distribution. - This is an unique KPI, same events are counted only once per visitor, with Fanpage Karma at most once per day. This gives you a good impression of the daily activities. In the network, the period can refer to other periods and is then not comparable.
company_updates_count

Number of status updates
(identical to top metric: 'Number of posts')

Number of status updates published in selected time period.
company_updates_count_per_day

Status Updates per day
(identical to top metric: 'Posts per day')

Average number of status updates per day published in the selected period.
company_updates_likes_count

Likes on status updates of time period
(identical to top metric: 'Number of Likes')

Number of likes on status updates published in the selected period.
company_updates_comments_count

Comments on status updates of time period
(identical to top metric: 'Number of comments')

Number of comments on status updates published in the selected period.
company_updates_comments_likes_count

Comments and Likes on updates of time period
(identical to top metric: 'Number of Reactions, Comments & Shares')

Number of reactions (like, celebrate, love, insightful, curious), comments and shares on status updates published in the selected period.
company_updates_likes_count_per_post

Likes per status update of time period

Average number of likes on status updates published in the selected period, divided by the number of status updates in the selected period.
company_updates_comments_count_per_post

Comments per status update of time period

Average number of comments on status updates published in the selected period, divided by the number of status updates in the selected period.
company_engagement

Engagement on status updates of time period
(identical to top metric: 'Engagement')

Engagement is the average number of interactions on a profile's posts per follower per day. Engagement shows how successfully a profile encourages users to interact. By dividing by the number of followers, the Engagement becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values ​​of all posts. Finally, you divide this sum by the number of days in the period.<br> <br>An example of the calculation: <br>A profile posts 2 times in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>Engagement for this week (7 days) is calculated as follows: <br>(50/100 + 75/150) / 7 = 14.2%<br>In comparison, the post interaction (2 posts) results in: <br>(50/100 + 75/150) / 2 = 50%<br> <br>Post-interaction is closely related to Engagement. For Post-Interaction, the number of interactions is also divided by the number of followers, but then divided by the number of posts and not - as with Engagement - per day. Engagement is higher if a profile posts more often. The post interaction shows how successful the posts are on average.
company_updates_interaction

Interaction on status updates of time period (in %)
(identical to top metric: 'Post interaction rate')

Post-Interaction is the average number of interactions on a profile's posts per follower per post. Post-Interaction shows how successful the individual posts of a profile are on average in encouraging users to interact. By dividing by the number of followers, Post-Interaction becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values of all posts. Finally, you divide the number of posts in the period.<br> <br>An example of the calculation: <br>A profile makes 2 posts in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>The Post-Interaction (2 posts) results in: <br> (50/100 + 75/150) / 2 = 50%<br> In comparison, Engagement for this week (7 days) is: <br>(50/100 + 75/150) / 7 = 14.2%<br> <br>Engagement is closely related to post-interaction. For Engagement, the number of interactions is also divided by the number of followers, but then the average is calculated per day and not - as for Post-Interaction - per post. Engagement is therefore usually higher when a profile posts more often. Engagement shows how successfully a profile in total motivates users to interact.
company_performance_index

Profile Performance Index
(identical to top metric: 'Page Performance Index')

Root product between the comparison values of the engagement value and the average weekly growth of a profile.
company_jobs_count

Number of job updates (obsolete)

Unfortunately, this KPI is obsolete.
company_jobs_count_per_day

Job updates per day (obsolete)

Unfortunately, this KPI is obsolete.
company_updates_and_jobs_count

Number of status & job updates (obsolete)

Unfortunately, this KPI is obsolete.
company_updates_and_jobs_count_per_day

Status & job updates per day (obsolete)

Unfortunately, this KPI is obsolete.
Task: /posts
Title: Posts and their metrics
URL structure: www.fanpagekarma.com/api/v1/linkedin/ {PROFILE_ID} /posts?token= {TOKEN} &period= {PERIOD}
Description:

The task /posts returns the posts and their metrics of the LinkedIn 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 metrics will be returned.

Example: www.fanpagekarma.com/api/v1/linkedin/2029/posts?token=abcdefghijklmnopqrstuvwxyz
Structure of the data-object:
{
"posts" : [
{
"id" : "identifier of the post",
"date" : "date of the post",
"message" : "message text of the post",
"link" : "link to the post",
"image" : "image url of the post",
"type" : "type of the post",
"kpi" : Same structure as data-object for the Task kpi,
},
...
]
}
Description of the elements of the kpi-object:
{NAME_OF_PROPERTY} title description
page_posts_likes_count

Number of Likes

Average number of "like" reactions on posts published in the selected period.
page_posts_comments_count

Number of comments

<p>Number of comments on posts, videos, tweets, pins, etc. <br><br><b>Benefit</b><br> Comments give a better indication of whether a post actually appeals to users, since creating a comment takes significantly more effort than a simple like. Unfortunately, most of the comments on Instagram are not made by real people but by bots. <br><br><b>Calculation</b><br> All comments added together. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. </p>
page_total_engagement_count

Number of Reactions, Comments & Shares

<p>This number is the sum of public accessible interactions (likes, hearts, reactions, comments, pins, shares etc.) of all posts in the selected period. <br><br><b>Benefit</b><br> This metric shows you how actively people have interacted with a profile's posts. More interactions lead to higher visibility of the content and is the most important driver for organic reach. <br><br><b>Calculation</b><br> Sum of likes, hearts, reactions, comments, and shares of all posts in the selected period. In order to make this metric comparable to competitor profiles, only public accessible interactions are taken into account. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. <br>On Instagram only likes and comments are publicy available. <br>Clicks on links do not count towards interactions. </p>

TIKTOK

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

TikTok-Tasks:

Here is a detailed description of all available tasks for the network TikTok:
Task: /kpi
Title: Key Performance Indicators / Profile metrics
URL structure: www.fanpagekarma.com/api/v1/tiktok/ {PROFILE_ID} /kpi?token= {TOKEN} &period= {PERIOD}
Description: The task /kpi returns the metrics of the TikTok profile for the given {PROFILE_ID}. These are essentially all the numbers and details you see in your Dashboard.

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

Example: www.fanpagekarma.com/api/v1/tiktok/nike/kpi?token=abcdefghijklmnopqrstuvwxyz
Structure 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 description
tiktoker_profile_follower_count

Follower
(identical to top metric: 'Fans')

Number of users on the last day of the selected period who follow the profile are called followers.
tiktoker_profile_followings_count

Following

Number of profiles followed by the profile of the last day of the selected period.
tiktoker_profile_followers_followings_ratio

Followers-Following-Ratio

Ratio between people who follow the profile to people who the profile follows of the last day of the selected period.
tiktoker_followers_weekly_growth_rate

Follower Growth (weekly, in %)
(identical to top metric: 'Follower Growth Average Weekly (in %)')

Difference between the number of followers on the first and the last day of the selected period as an average weekly value.
tiktoker_followers_growth_absolute

Follower Growth (absolute)

Difference between the number of followers on the first and the last day of the selected period.
tiktoker_followers_growth_percent

Follower Growth (in %)

Percentage number of the difference between the number of followers of the first and last day of the selected period, divided by the number of followers of the first day in the selected period. Reflects the difference from the previous day in the history graph.
tiktoker_followers_growth_absolute_per_day

Follower Growth per day (absolute)

Difference between the number of followers on the first and the last day of the selected period as an average value per day.
tiktoker_followers_growth_since_first_date

Follower Growth since starting point (in %)

Percentage growth of followers between the first and last day of the selected period. Reflects the difference from the first day of the selected period for each day in the history graph.
tiktoker_profile_media_count

Profile Videos count (overall)

All-time number of videos the profile has published.
tiktoker_profile_like_count

Profile Likes

All-time number of likes the profile has received for all videos.
tiktoker_video_count

Number of Videos
(identical to top metric: 'Number of posts')

Number of videos published in selected time period.
tiktoker_video_count_per_day

Number of Videos per day
(identical to top metric: 'Posts per day')

Average number of videos per day published in the selected period.
tiktoker_video_share_count

Number of Shares

Number of shares on videos published in the selected period.
tiktoker_video_like_count

Number of Likes

Number of likes on videos published in the selected period.
tiktoker_video_comment_count

Number of Comments
(identical to top metric: 'Number of comments')

Number of comments on your videos published in the selected period.
tiktoker_video_share_like_comment_count

Number of Shares, Likes, Comments
(identical to top metric: 'Number of Reactions, Comments & Shares')

Number of shares, likes and comments on videos published in the selected period.
tiktoker_video_play_count

Number of Plays
(identical to top metric: 'Impressions of posts')

Number of plays on videos published in the selected period.
tiktoker_plays_per_post_per_fans

Plays per Video per Follower

Plays per Video per Follower on videos published in the selected period.
tiktoker_plays_per_day

Plays per Day

Number of plays per day on videos published in the selected period.
tiktoker_video_count_is_duet

Number of Videos which are Duets

Number of videos which are duets published in selected time period.
tiktoker_video_count_is_stitch

Number of Videos which are Stitches

Number of videos which are stitches published in selected time period.
tiktoker_video_count_ad

Number of Videos with Spark Ads

Number of organic videos which were boosted with Spark Ads published in selected time period.
tiktoker_video_count_shareenabled

Number of Videos with share enabled

Number of videos which have share enabled published in selected time period.
tiktoker_video_count_duetenabled

Number of Videos with duet enabled

Number of videos which have the duet feature enabled published in selected time period.
tiktoker_video_count_stitchenabled

Number of Videos with stitch enabled

Number of videos which have the stitch feature enabled published in selected time period.
tiktoker_video_duration_sum

Video length in s (sum)

Sum of video length in seconds of videos published in the selected period.
tiktoker_video_duration_per_video

Video length in s (average)

Average video length in seconds of videos published in the selected period.
tiktoker_engagement

Engagement

Engagement is the average number of interactions on a profile's posts per follower per day. Engagement shows how successfully a profile encourages users to interact. By dividing by the number of followers, the Engagement becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values ​​of all posts. Finally, you divide this sum by the number of days in the period.<br> <br>An example of the calculation: <br>A profile posts 2 times in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>Engagement for this week (7 days) is calculated as follows: <br>(50/100 + 75/150) / 7 = 14.2%<br>In comparison, the post interaction (2 posts) results in: <br>(50/100 + 75/150) / 2 = 50%<br> <br>Post-interaction is closely related to Engagement. For Post-Interaction, the number of interactions is also divided by the number of followers, but then divided by the number of posts and not - as with Engagement - per day. Engagement is higher if a profile posts more often. The post interaction shows how successful the posts are on average.
tiktoker_video_interaction

Video Interaction
(identical to top metric: 'Post interaction rate')

Post-Interaction is the average number of interactions on a profile's posts per follower per post. Post-Interaction shows how successful the individual posts of a profile are on average in encouraging users to interact. By dividing by the number of followers, Post-Interaction becomes independent of the size of the profile. This makes profiles comparable.<br> <br>For the calculation, add the number of all interactions for each post. Interactions are likes, haha, etc. as well as comments and shares or retweets. Please note: On Instagram, only organic likes and comments count. For each post, the sum of interactions is divided by the number of followers at the time of the post. Then you add up the values of all posts. Finally, you divide the number of posts in the period.<br> <br>An example of the calculation: <br>A profile makes 2 posts in 7 days. Once on Monday and receives 50 likes and once on Friday and receives 75 likes. The profile had 100 followers on Monday and 150 followers on Friday.<br> <br>The Post-Interaction (2 posts) results in: <br> (50/100 + 75/150) / 2 = 50%<br> In comparison, Engagement for this week (7 days) is: <br>(50/100 + 75/150) / 7 = 14.2%<br> <br>Engagement is closely related to post-interaction. For Engagement, the number of interactions is also divided by the number of followers, but then the average is calculated per day and not - as for Post-Interaction - per post. Engagement is therefore usually higher when a profile posts more often. Engagement shows how successfully a profile in total motivates users to interact.
tiktoker_reactions_per_play

Reactions per Play

Number of reactions (shares, likes, comments) per play on videos published in the selected period.
tiktoker_performance_index

Profile Performance Index
(identical to top metric: 'Page Performance Index')

Root product between the comparison values of the engagement value and the average weekly growth of a profile.
Task: /posts
Title: Posts and their metrics
URL structure: www.fanpagekarma.com/api/v1/tiktok/ {PROFILE_ID} /posts?token= {TOKEN} &period= {PERIOD}
Description:

The task /posts returns the posts and their metrics of the TikTok 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 metrics will be returned.

Example: www.fanpagekarma.com/api/v1/tiktok/nike/posts?token=abcdefghijklmnopqrstuvwxyz
Structure of the data-object:
{
"posts" : [
{
"id" : "identifier of the post",
"date" : "date of the post",
"message" : "message text of the post",
"link" : "link to the post",
"image" : "image url of the post",
"type" : "type of the post",
"kpi" : Same structure as data-object for the Task kpi,
},
...
]
}
Description of the elements of the kpi-object:
{NAME_OF_PROPERTY} title description
tiktoker_video_share_count

Number of Shares

Number of shares on videos published in the selected period.
page_posts_likes_count

Number of Likes

Average number of "like" reactions on posts published in the selected period.
page_posts_comments_count

Number of comments

<p>Number of comments on posts, videos, tweets, pins, etc. <br><br><b>Benefit</b><br> Comments give a better indication of whether a post actually appeals to users, since creating a comment takes significantly more effort than a simple like. Unfortunately, most of the comments on Instagram are not made by real people but by bots. <br><br><b>Calculation</b><br> All comments added together. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. </p>
page_total_engagement_count

Number of Reactions, Comments & Shares

<p>This number is the sum of public accessible interactions (likes, hearts, reactions, comments, pins, shares etc.) of all posts in the selected period. <br><br><b>Benefit</b><br> This metric shows you how actively people have interacted with a profile's posts. More interactions lead to higher visibility of the content and is the most important driver for organic reach. <br><br><b>Calculation</b><br> Sum of likes, hearts, reactions, comments, and shares of all posts in the selected period. In order to make this metric comparable to competitor profiles, only public accessible interactions are taken into account. <br><br><b>Note</b> <br>Instagram only transmits organic interactions for competitor profiles. For all other networks, interactions include both paid and organic totals. <br>On Instagram only likes and comments are publicy available. <br>Clicks on links do not count towards interactions. </p>
page_posts_impressions

Impressions of posts

<p>Sum of total impressions of all posts posted during the selected period.<br><br><b>Benefit</b><br> Use this number to find out how many times all posts have been viewed in total. <br><br><b>Calculation</b><br> The total impressions are added together for all posts in the specified period. It doesn't matter when the impressions happened. It counts when the post was posted. </p>
tiktoker_video_count_is_duet

Number of Videos which are Duets

Number of videos which are duets published in selected time period.
tiktoker_video_count_is_stitch

Number of Videos which are Stitches

Number of videos which are stitches published in selected time period.
tiktoker_video_count_ad

Number of Videos with Spark Ads

Number of organic videos which were boosted with Spark Ads published in selected time period.
tiktoker_video_count_shareenabled

Number of Videos with share enabled

Number of videos which have share enabled published in selected time period.
tiktoker_video_count_duetenabled

Number of Videos with duet enabled

Number of videos which have the duet feature enabled published in selected time period.
tiktoker_video_count_stitchenabled

Number of Videos with stitch enabled

Number of videos which have the stitch feature enabled published in selected time period.
tiktoker_video_duration_sum

Video length in s (sum)

Sum of video length in seconds of videos published in the selected period.