Locowise API | V1.0 Documentation
As you know, we are constantly developing the platform and this has been something in the pipeline that we are excited to share with you all. We are thrilled to introduce the newest part of our platform in the form of the Locowise API V1.0. This next stage will be taking the data selection process to your doorstep, allowing you to access it in a developer friendly way.
If you have any questions about our documentation, don't hesitate to contact us! Our tech-savvy customer support will ensure that they answer all of your questions so that you are able to utilize the Locowise API to the best of your abilities.
https://api.locowise.com/v1/
API Endpoint for all data queries
The REST API of Locowise helps you get the most out of your profile data on Locowise. It allows you to use the data within third-party software management platform by following the well-established practices of creating a REST API.
The Locowise API follows the JSON specification and uses two specific API commands to best streamline the data gathering process.
GetProfileList
Allows you to get the profile ID's for the social media channels from which you want to retrieve the data.
GetData
Allows you to retrieve data for the selected social media channels via the profile ID's that are requested.
To signify the code lines based on the JSON API Specification, the Locowise API utilizes two main sets of parameters via the two specific API commands. The first allows you to get the a list of profile ID's in your account, while the second allows you to access the resources and data itself.
GetProfileList
Follows the structure
https://api.locowise.com/v1/GetProfileList?api_key=XXXXXX&channel=XXXXXX&type=XXXXXX
api_key
Your encrypted authorization key.
API Key is the most vital element that makes the Locowise API work. It allows access to the API data endpoints. You can generate a new Key via the API page within your account on Locowise (profile menu located on the top right of your screen). Please note that your API key enables access to all your profile data, so keep it secret.
channel
The social media channel you want to get data for.
Values can be:
• facebook
• twitter
• instagram
• linkedin
• youtube
type
Values can be:
• owned
• benchmark
• all
GetData
Follows the structure
https://api.locowise.com/v1/GetData?api_key=XXXXXX&channel=XXXXXX&profile_id=XXXXXX&data_tabs=XXXXXX&date_from=XXXXXX&date_to=XXXXXX
api_key
Your encrypted authorization key. As explained in the first set of parameters.
channel
The social media channel you want to get data for.
Values can be:
• facebook
• twitter
• instagram
• linkedin
• youtube
date_from
The start date of the data selection period you want to retrieve from the Locowise API.
Format used: Ymd
date_to
The end date of the data selection period you want to retrieve from the Locowise API.
Format used: Ymd
profile_id
Used to signify the exact profile IDs of the social media channels you want to retrieve the data from, available through the GetProfileList API explained above.
data_tabs
Used to signify the exact type of data that needs to be retrieved. Can be from either one or multiple options as per the values available.
Values can be:
• page_data
• post_data
• comments_data
• summary_data
Note: To use multiple options use multiple values separated by a comma. Example: page_data, post_data, summary_data, comments_data. If left blank, data for all tabs is set.
Here is additional information that we believe might be useful in using the API and implementing the available solutions.
API Testing
API Testing can be done via multiple options. We suggest using the Postman Chrome extension, if you are using the chrome browser.
Install Postman for Chrome
Test any of the API url's in our "Examples" section with your own profiles available through the GetProfileList API in the "GET" input box:
API Codes and Error handling
Locowise uses conventional HTTP response codes to indicate success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information (e.g. a required parameter was missing etc.), and codes in the 5xx range indicate an error with Locowise's servers.
Code | Description |
---|---|
200 | Successful |
400 | Bad Request or Authentication error or malformed Url |
404 | Not found |
500 | Locowise server error |
Here is additional information that we believe might be useful in using the API and implementing the available solutions. We've listed all available metrics for each channel and type (owned or benchmark) below. Click on any data tab to view the metric names along with their definitions.
Facebook Owned
profile_id Facebook page ID |
name Facebook page name |
date Date converted in your page timezone |
day Day converted in your page timezone |
page_fans The total number of people who have liked your Page |
page_fan_adds_unique The number of new people who have liked your Page |
page_fan_removes_unique Unlikes of your Page |
page_engagement The number of times people have engaged with your posts through likes, comments and shares and more |
page_posts Total number of posts published by your page |
page_stories Total number of stories generated about your page |
page_engaged_users The number of people who engaged with your Page (includes any click) |
page_consumptions_unique The number of people who clicked on any of your content |
page_negative_feedback The number of times people took a negative action (e.g., un-liked or hid a post) |
page_negative_feedback_unique The number of people who took a negative action (e.g., un-liked or hid a post) |
page_views The number of times a Page's profile has been viewed by people |
page_impressions The number of times any content from your Page or about your Page entered a person's screen |
page_impressions_unique The number of people who had any content from your Page or about your Page enter their screen |
page_impressions_organic The number of times any content from your Page or about your Page entered a person's screen through unpaid distribution |
page_impressions_organic_unique The number of people who had any content from your Page or about your Page enter their screen through unpaid distribution |
page_impressions_viral The number of times any content from your Page or about your Page entered a person's screen with social information attached |
page_impressions_viral_unique The number of people who had any content from your Page or about your Page enter their screen through with social information attached |
page_impressions_paid The number of times any content from your Page entered a person's screen through paid distribution such as an ad |
page_impressions_paid_unique The number of people who had any content from your Page enter their screen through paid distribution such as an ad |
page_post_impressions The number of times your Page's posts entered a person's screen |
page_post_impressions_unique The number of people who had your Page's post enter their screen |
page_post_impressions_organic The number of times your Page's posts entered a person's screen through unpaid distribution |
page_post_impressions_organic_unique The number of people who had your Page's post enter their screen through unpaid distribution |
page_post_impressions_viral The number of times your Page's post entered a person's screen with social information attached |
page_post_impressions_viral_unique The number of people who had your Page's post enter their screen with social information attached |
page_post_impressions_paid The number of times your Page's post entered a person's screen through paid distribution such as an ad |
page_post_impressions_paid_unique The number of people who had your Page's post enter their screen through paid distribution such as an ad |
page_fans_country The number of people, aggregated per country, that like your Page |
page_fans_city The number of unique people, sorted by country, who engaged with your Page, resulting in the generation of a Story |
page_storytellers_by_country Aggregated Facebook location data, sorted by country, about the people who like your Page |
page_storytellers_by_city The number of unique people, sorted by city, who engaged with your Page, resulting in the generation of a Story |
page_fans_gender_age Aggregated demographic data about the people who like your Page |
page_reactions_like Daily total post "like" reactions of a page |
page_reactions_love Daily total post "love" reactions of a page |
page_reactions_wow Daily total post "wow" reactions of a page |
page_reactions_haha Daily total post "haha" reactions of a page |
page_reactions_sad Daily total post "sad" reactions of a page |
page_reactions_anger Daily total post "anger" reactions of a page |
page_video_views Total number of times page's videos have been viewed for more than 3 seconds |
page_video_views_time The total amount of time (in milliseconds) people spent watching videos on your Page |
page_video_organic_views Total number of times page's videos have been viewed for more than 3 seconds by organic reach |
page_video_paid_views Total number of times page's promoted videos have been viewed for more than 3 seconds |
page_video_complete_views_30s Total number of times page's videos have been viewed for more than 30 seconds |
total_video_complete_views_30s_organic Total number of times page's videos have been viewed to the end, or viewed for more than 30 seconds by organic reach |
page_video_complete_views_30s_paid Total number of times page's promoted videos have been viewed to the end, or for more than 30 seconds |
page_video_views_10s The number of times your Page's videos were watched for an aggregate of at least 10 seconds |
page_video_organic_views_10s The number of times your Page's videos were watched without any paid distribution for at least a total of 10 seconds |
page_video_paid_views_10s The number of times your Page's videos with paid activity were watched for at least a total of 10 seconds |
days_28_page_stories Total number of stories generated about your page |
days_28_page_story_adds The number of stories created about your Page |
days_28_page_stories_by_story_type The number of stories about your Page by story type |
days_28_page_impressions The number of times any content from your Page or about your Page entered a person's screen |
days_28_page_impressions_unique The number of people who had any content from your Page or about your Page enter their screen |
days_28_page_impressions_organic The number of times any content from your Page or about your Page entered a person's screen through unpaid distribution |
days_28_page_impressions_organic_unique he number of people who had any content from your Page or about your Page enter their screen through unpaid distribution |
days_28_page_impressions_viral The number of times any content from your Page or about your Page entered a person's screen with social information attached |
days_28_page_impressions_viral_unique The number of people who had any content from your Page or about your Page enter their screen through with social information attached |
days_28_page_impressions_paid The number of times any content from your Page entered a person's screen through paid distribution such as an ad |
days_28_page_impressions_paid_unique The number of people who had any content from your Page enter their screen through paid distribution such as an ad |
days_28_page_impressions_by_age_gender_unique The number of people who saw any content by your Page or about your Page, grouped by age and gender. |
days_28_page_post_engagements The number of times people have engaged with your posts through likes, comments and shares and more |
days_28_page_posts_impressions The number of times your Page's posts entered a person's screen. Posts include statuses, photos, links, videos and more |
days_28_page_posts_impressions_unique The number of people who had any of your Page's posts enter their screen. Posts include statuses, photos, links, videos and more |
days_28_page_posts_impressions_organic The number of times your Page's posts entered a person's screen through unpaid distribution |
days_28_page_posts_impressions_organic_unique The number of people who had any of your Page's posts enter their screen through unpaid distribution. |
days_28_page_posts_impressions_viral The number of times your Page's posts entered a person's screen with social information attached. Social information displays when a person's friend interacted with you 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 |
days_28_page_posts_impressions_viral_unique The number of people who had any of your Page's posts enter their screen with social information attached. As a form of organic distribution, social information displays when a person's friend interacted with you 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 |
days_28_page_posts_impressions_paid The number of times your Page's posts entered a person's screen through paid distribution such as an ad. |
days_28_page_posts_impressions_paid_unique ue* The number of people who had any of your Page's posts enter their screen through paid distribution such as an ad. |
days_28_page_consumptions The number of times people clicked on any of your content. |
days_28_page_consumptions_unique The number of people who clicked on any of your content |
days_28_page_consumptions_by_consumption_type The number of times people clicked on any of your content, by type. |
days_28_page_negative_feedback The number of times people took a negative action (e.g., un-liked or hid a post) |
days_28_page_negative_feedback_unique The number of people who took a negative action (e.g., un-liked or hid a post) |
days_28_page_negative_feedback_by_type The number of times people took a negative action broken down by type. |
days_28_page_storytellers_by_country Aggregated Facebook location data, sorted by country, about the people who like your Page |
days_28_page_storytellers_by_city The number of unique people, sorted by city, who engaged with your Page, resulting in the generation of a Story |
days_28_page_storytellers_by_age_gender Aggregated demographic data about the people who like your Page |
days_28_page_engaged_users The number of people who engaged with your Page (includes any click) |
days_28_page_video_views Total number of times page's videos have been viewed for more than 3 seconds |
days_28_page_video_views_organic Total number of times page's videos have been viewed for more than 3 seconds by organic reach |
days_28_page_video_views_paid Total number of times page's promoted videos have been viewed for more than 3 seconds |
days_28_page_video_complete_views_30s Total number of times page's videos have been viewed for more than 30 seconds |
days_28_page_video_complete_views_30s_organic Total number of times page's videos have been viewed to the end, or viewed for more than 30 seconds by organic reach |
days_28_page_video_complete_views_30s_paid Total number of times page's promoted videos have been viewed to the end, or for more than 30 seconds |
days_28_page_video_views_10s Total number of times page's videos have been viewed for more than 10 seconds |
days_28_page_video_views_10s_organic Total number of times page's videos have been viewed to the end, or viewed for more than 10 seconds by organic reach |
days_28_page_video_views_10s_paid Total number of times page's promoted videos have been viewed to the end, or for more than 10 seconds |
days_28_page_fan_adds_unique The number of new people who have liked your Page |
days_28_page_fan_removes_unique Unlikes of your Page |
days_28_page_views_total The number of times a Page's profile has been viewed by people |
profile_id Facebook page ID |
name Facebook page name |
date Date converted in your page timezone |
day Day converted in your page timezone |
timestamp Timestamp of the post |
type Type of post (photo, video, link or status) |
text Post caption |
engagement The number of people who engaged with your Page. Engagement includes any click |
engagement_rate The number of unique users who liked, clicked, commented, or shared the post divided by the post reach |
sentiment Positive (score of 60 and above), Neutral (score between 40 and 60) and Negative (score below 40) |
page_fans The total number of people who have liked your Page |
likes Total number of times users liked a post |
comments Total number of times users commented on a post |
shares Total number of times users shared a post |
all_likes Total number of times users liked a post including likes on shares |
all_comments Total number of times users commented on a post including comments on shares |
all_shares Total number of times users shared a post including shares on shares |
interactions The total number of likes, comments and shares |
all_interactions The total number of likes, comments and shares (including interactions received on shares) |
post_link_clicks The number of times people clicked on links posted on your page |
post_link_clicks_unique The number of people that clicked on links posted on your page |
post_photo_views The number of times people clicked or viewed your photos |
post_other_clicks The number of times people clicked on any content associated with your page, excluding photo clicks, video click, and link clicks |
post_other_clicks_unique The number of people that clicked on any content associated with your page, excluding photo clicks, video click, and link clicks |
post_consumptions The number of likes, comments, shares and clicks |
post_consumptions_unique The number of users that engaged with any post |
post_engaged_users The number of people who clicked anywhere in your posts |
post_storytellers The number of people who engage with your Page |
post_stories A Story is an item that appears in a users newsfeed when their friend interacts with a Page or its content |
post_story_adds Total number of stories generated |
post_story_adds_unique Total number of users that generated stories |
post_impressions The number of times your Page's post entered a person's screen |
post_impressions_unique The number of people who had your Page's post enter their screen |
post_impressions_organic The number of times your Page's posts entered a person's screen through unpaid distribution |
post_impressions_organic_unique The number of people who had your Page's post enter their screen through unpaid distribution |
post_impressions_viral The number of times your Page's post entered a person's screen with social information attached |
post_impressions_viral_unique The number of people who had your Page's post enter their screen with social information attached |
post_impressions_paid The number of times your Page's post entered a person's screen through paid distribution such as an ad |
post_impressions_paid_unique The number of people who had your Page's post enter their screen through paid distribution such as an ad |
post_impressions_fan The number of impressions for your Page post by people who have liked your Page |
post_impressions_fan_unique The number of people who have like your Page who saw your Page post |
post_impressions_fan_paid The number of impressions for your Page post by people who like your Page in an Ad or Sponsored Story |
post_impressions_fan_paid_unique The number of people who have like your Page and saw your Page post in an Ad or Sponsored Story |
post_negative_feedback The number of times people took a negative action in your post |
post_negative_feedback_unique The number of people who took a negative action in your post |
post_video_views The number of times your video was watched for an aggregate of at least 3 seconds |
post_video_views_unique The number of distinct people who viewed your video at least once |
post_video_views_organic The number of times your video was organically viewed for 3 seconds or more |
post_video_views_organic_unique The number of people who viewed at least 3 seconds of your video organically |
post_video_views_paid The number of times your video was viewed via paid impression for 3 seconds or more |
post_video_views_paid_unique The number of people who viewed at least 3 seconds of your video via paid impression |
post_video_views_autoplayed Number of times your video started automatically playing and people viewed it for more than 3 seconds |
post_video_views_clicked_to_play Number of times people clicked to play your video and viewed it more than 3 seconds |
post_video_views_complete_organic The number of times your video was organically viewed from the beginning to 95% of its length |
post_video_views_complete_organic_unique The number of people who viewed your video organically from the beginning to 95% of its length |
post_video_views_complete_paid The number of times your video was viewed via paid impression from the beginning to 95% of its length |
post_video_views_complete_paid_unique The number of people who viewed your video via paid impression from the beginning to 95% of its length |
post_video_views_complete_30s Total number of times page's videos have been viewed for more than 30 seconds |
post_video_views_complete_30s_unique Total number of times page's videos have been played for unique people to the end, or viewed for more than 30 seconds |
post_video_views_complete_30s_organic Total number of times page's videos have been viewed to the end, or viewed for more than 30 seconds by organic reach |
post_video_views_complete_30s_paid Total number of times page's promoted videos have been viewed to the end, or for more than 30 seconds |
post_video_views_complete_30s_autoplayed Number of times your video started automatically playing and people viewed it for 30 seconds or to the end, whichever came first |
post_video_views_complete_30s_clicked_to_play Number of times people clicked to play your video and viewed it for 30 seconds or to the end, whichever came first |
post_video_avg_time_watched The average length of time (in milliseconds) people spent viewing your video |
post_video_clicks_to_play Total number of times page's videos were clicked to play |
post_video_play_unique Total number of users that clicked any video to play |
post_reactions_like Total like reactions of a post |
post_reactions_love Total love reactions of a post |
post_reactions_wow Total wow reactions of a post |
post_reactions_haha Total haha reactions of a post |
post_reactions_sorry Total sad reactions of a post |
post_reactions_anger Total anger reactions of a post |
post_link URL pointing directly to the post on Facebook |
post_image URL pointing directly to the uploaded media file |
labels Labels assigned to the post via the Locowise label manager |
sponsor_tags Sponsor tags present in the post |
post_video_length Length of a video post (in milliseconds). |
profile_id Facebook page ID |
name Facebook page name |
date Date converted in your page timezone |
day Day converted in your page timezone |
timestamp Timestamp of the comment |
comment_id Unique ID of the comment |
post_id Unique ID of the parent post |
post_url URL pointing directly to the post on Facebook |
user_id Unique user_id of the commenting user |
type Type of message |
user_name Username of the commenting user |
comment Message posted in the body of the comment |
comment_url URL pointing directly to the comment on Facebook |
profile_id Facebook page ID |
name Facebook page name |
page_fans A count of the total number of fans |
page_fans_change A count of the total change in the number of fans |
posts Total number of posts published |
likes Total number of times users liked a post |
comments Total number of times users commented on a post |
shares Total number of times users shared a post |
all_likes Total number of times users liked a post including likes on shares |
all_comments Total number of times users commented on a post including comments on shares |
all_shares Total number of times users shared a post including shares on shares |
interactions The total number of likes, comments and shares |
all_interactions The total number of likes, comments and shares (including interactions received on shares) |
engagement The number of people who engaged with your posts. Engagement includes any click |
engagement_rate The number of unique users who liked, clicked, commented, or shared the post divided by the post reach |
page_engagement_rate Sum of engagement (likes, comments, shares) divided by page fans |
daily_page_engagement_rate Sum of engagement (likes, comments, shares) divided by page fans shown as average per day |
post_impressions The number of times your Page's post entered a person's screen |
post_impressions_unique The number of people who had your Page's post enter their screen |
post_impressions_organic The number of times your Page's posts entered a person's screen through unpaid distribution |
post_impressions_organic_unique The number of people who had your Page's post enter their screen through unpaid distribution |
post_impressions_viral The number of times your Page's post entered a person's screen with social information attached |
post_impressions_viral_unique The number of people who had your Page's post enter their screen with social information attached |
post_impressions_paid The number of times your Page's post entered a person's screen through paid distribution such as an ad |
post_impressions_paid_unique The number of people who had your Page's post enter their screen through paid distribution such as an ad |
Facebook Benchmarks
profile_id Facebook page ID |
name Facebook page name |
date Date converted in your page timezone |
day Day converted in your page timezone |
page_fans The total number of people who have liked your Page |
page_engagement The number of times people have engaged with your posts through likes, comments and shares |
page_posts Total number of posts published by your page |
profile_id Facebook page ID |
name Facebook page name |
date Date converted in your page timezone |
day Day converted in your page timezone |
timestamp Timestamp of the post |
type Type of post (photo, video, link or status) |
text Post caption |
engagement Total number of times users liked, shared or commented on your posts |
engagement_rate The number of likesd, comments and shares divided by the page fans |
sentiment Positive (score of 60 and above), Neutral (score between 40 and 60) and Negative (score below 40) |
page_fans The total number of people who have liked your Page |
likes Total number of times users liked a post |
comments Total number of times users commented on a post |
shares Total number of times users shared a post |
interactions The total number of likes, comments and shares |
post_reactions_like Total like reactions of a post |
post_reactions_love Total love reactions of a post |
post_reactions_wow Total wow reactions of a post |
post_reactions_haha Total haha reactions of a post |
post_reactions_sorry Total sad reactions of a post |
post_reactions_anger Total anger reactions of a post |
post_link URL pointing directly to the post on Facebook |
post_image URL pointing directly to the uploaded media file |
labels Labels assigned to the post via the Locowise label manager |
sponsor_tags Sponsor tags present in the post |
profile_id Facebook page ID |
name Facebook page name |
date Date converted in your page timezone |
day Day converted in your page timezone |
timestamp Timestamp of the comment |
comment_id Unique ID of the comment |
post_id Unique ID of the parent post |
post_url URL pointing directly to the post on Facebook |
type Type of message |
comment Message posted in the body of the comment |
comment_url URL pointing directly to the comment on Facebook |
profile_id Facebook page ID |
name Facebook page name |
page_fans A count of the total number of fans |
page_fans_change A count of the total change in the number of fans |
posts Total number of posts published |
likes Total number of times users liked a post |
comments Total number of times users commented on a post |
shares Total number of times users shared a post |
interactions The total number of likes, comments and shares |
engagement The number of people who engaged with your posts. Engagement includes any click |
engagement_rate The number of unique users who liked, clicked, commented, or shared the post divided by the page fans |
page_engagement The number of times people have engaged with your posts through likes, comments and shares |
Instagram Owned
profile_id Instagram page ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
followers The number of followers this account currently has |
followers_change Daily change in the total number of followers |
follows The number of users this account is following |
follows_change Daily change in the total number of follows |
impressions Total number of times the profile was viewed |
reach Total number of unique users who have viewed the profile |
email_contacts Total number of taps on the email link |
phone_call_clicks Total number of taps on the call link |
text_message_clicks Total number of taps on the text message link |
get_directions_clicks Total number of taps on the directions link |
website_clicks Total number of taps on the website link |
profile_views Total number of unique users who have viewed the profile within the specified period |
online_followers Total number of the followers who were online during the specified period |
audience_gender_age Lifetime gender and age distribution of the followers |
audience_country Lifetime country distribution of the followers |
audience_city Lifetime city distribution of the followers |
profile_id Instagram page ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
timestamp Timestamp of the post |
media_id Unique ID of the post |
type Type of post (photo, video or carousel) |
caption Post caption |
labels Labels assigned to the post via the Locowise label manager |
likes A count of how many times the post has been liked |
comments A count of how many times the post has been commented on |
engagement Total number of likes and comments on the media object |
engagement_rate Sum of engagements (Likes, Comments) divided by Followers |
sentiment Positive (score of 60 and above), Neutral (score between 40 and 60) and Negative (score below 40) |
story The number of stories published |
impressions The number of times the media object has been seen |
reach The number of unique accounts that have seen the media object |
taps_forward The number of taps a user made to see the next photo or video |
taps_back The number of taps a user made to see your previous photo or video |
replies The number of DMs associated with your Story you received in your DM box |
exits Total number of people that left your Story without watching it to the end |
media URL pointing directly to the post on Instagram |
media_url URL pointing directly to the uploaded media file |
video_views Total number of times video has been seen |
profile_id Instagram page ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
timestamp Timestamp of the comment |
media_id Unique ID of the parent post |
user_id Unique user_id of the commenting user |
user_name Username of the commenting user |
comment Message posted in the body of the comment |
media_url URL pointing directly to the post on Instagram |
profile_id Instagram page ID |
name The name, handle, or alias that this user identifies themselves with |
followers A count of the total number of followers |
followers_change A count of the total change in the number of followers |
likes A count of how many times the post has been liked |
comments A count of how many times the post has been commented on |
engagement Total number of likes and comments on the media object |
engagement_rate Sum of engagements (Likes, Comments) divided by Followers |
impressions Total number of times the profile was viewed |
reach Total number of unique users who have viewed the profile |
Instagram Benchmarks
profile_id Instagram page ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
followers The number of followers this account currently has |
followers_change Daily change in the total number of followers |
profile_id Instagram page ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
timestamp Timestamp of the post |
media_id Unique ID of the post |
type Type of post (photo, video or carousel) |
caption Post caption |
labels Labels assigned to the post via the Locowise label manager |
likes A count of how many times the post has been liked |
comments A count of how many times the post has been commented on |
engagement Total number of likes and comments on the media object |
engagement_rate Sum of engagements (Likes, Comments) divided by Followers |
sentiment Positive (score of 60 and above), Neutral (score between 40 and 60) and Negative (score below 40) |
media URL pointing directly to the post on Instagram |
media_url URL pointing directly to the uploaded media file |
profile_id Instagram page ID |
name The name, handle, or alias that this user identifies themselves with |
followers A count of the total number of followers |
followers_change A count of the total change in the number of followers |
likes A count of how many times the post has been liked |
comments A count of how many times the post has been commented on |
engagement Total number of likes and comments on the media object |
engagement Rate Sum of engagements (Likes, Comments) divided by Followers |
Twitter Owned
profile_id Twitter profile ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
followers The number of followers this account currently has |
followers_change Daily change in the total number of followers |
friends The number of users this account is following |
friends_change Daily change in the total number of friends |
tweets A count of the total original messages posted on Twitter |
retweets A count of how many times your tweets have been retweeted |
favorites A count of how many times your tweets have been favorited or liked |
replies A count of how many times your tweets have been replied to |
mentions A count of tweets that contain your @username anywhere in the body of the tweet |
retweets_out A count of how many times you have retweeted tweets by others |
replies_out A count of how many times you have replied to tweets by others |
profile_id Twitter profile ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
timestamp Timestamp of the tweet |
tweet_id Unique ID of the tweet |
type Type of tweet (text, photo, video, and animated_gif) |
text Tweet caption |
labels Labels assigned to the tweet via the Locowise label manager |
replies A count of how many times the tweet has been replied to |
retweets A count of how many times the tweet has been retweeted |
favorites A count of how many times the tweet has been favorited or liked |
followers Total number of followers the account had when the tweet was posted |
sentiment Positive (score of 60 and above), Neutral (score between 40 and 60) and Negative (score below 40) |
engagement A count of the number of times a user has interacted with the tweet |
engagement_rate Sum of engagements (Replies, Retweets, Likes) divided by Followers |
potential_impressions A count of the total number of estimated times the tweet has been viewed |
organic_impressions A count of how many times the tweet has been viewed |
organic_engagement_rate Sum of engagements (Clicks, Replies, Retweets, Likes) divided by Followers |
organic_user_profile_clicks A count of how many times the User has had their profile clicked from this tweet |
organic_url_clicks A count of how many times a URL in the tweet has been clicked |
organic_hashtag_clicks A count of how many times a hashtag in the tweet has been clicked |
organic_detail_expands A count of how many times the tweet has been clicked to see more details |
organic_permalink_clicks A count of how many times the permalink to the tweet has been clicked |
organic_media_clicks A count of how many times media such as an image or video in the tweet has been clicked |
organic_app_opens A count of how many times an App Open event has occurred from the tweet |
organic_app_install_attempts A count of how many times an App Install event has occurred from the tweet |
organic_follows A count of how many times the User has been followed from this tweet |
organic_email_tweets A count of how many times the tweet has been shared via email |
organic_dial_phone A count of how many times an phone dial event has occurred from the tweet |
organic_video_views A count of how many times a video in the tweet has been viewed |
all_clicks A count of the total number of times a tweet was clicked |
promoted_impressions A count of how many times the promoted tweet has been viewed |
promoted_engagements A count of the number of times a user has interacted with the promoted tweet |
promoted_engagement_rate Number of engagements divided by impressions for promoted tweet |
promoted_retweets A count of how many times the promoted tweet has been retweeted |
promoted_replies A count of how many times the promoted tweet has been replied to |
promoted_favorites A count of how many times the promoted tweet has been favorited or liked |
promoted_user_profile_clicks A count of how many times the User has had their profile clicked from the promoted tweet |
promoted_url_clicks A count of how many times a URL in the promoted tweet has been clicked |
promoted_hashtag_clicks A count of how many times a hashtag in the promoted tweet has been clicked |
promoted_detail_expands A count of how many times the promoted tweet has been clicked to see more details |
promoted_permalink_clicks A count of how many times the permalink to the promoted tweet has been clicked |
promoted_embedded_media_clicks A count of how many times media such as an image or video in the promoted tweet has been clicked |
promoted_app_opens A count of how many times an App Open event has occurred from the promoted tweet |
promoted_app_install_attempts A count of how many times an App Install event has occurred from the promoted tweet |
promoted_follows A count of how many times the User has been followed from the promoted tweet |
promoted_email_tweet A count of how many times the promoted tweet has been shared via email |
promoted_dial_phone A count of how many times an phone dial event has occurred from the promoted tweet |
promoted_video_views A count of how many times a video in the promoted tweet has been viewed |
in_reply_to_status_id Tweet ID replied to |
in_reply_to_user_id User ID replied to |
expanded_url expanded_url |
media_url An expanded version of display_url that links to the media display page |
hashtag Hashtags used within the body of the tweet |
source Platform used to publish the tweet |
profile_id Twitter profile ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
timestamp Timestamp of the mention |
mention_id Unique ID of the mention |
user_id Unique user_id of the mentioning user |
user_name Username of the mentioning user |
comment Message posted in the body of the mention |
source Platform used to publish the mention |
in_reply_to_status_id Tweet ID replied to |
profile_id Twitter profile ID |
name The name, handle, or alias that this user identifies themselves with |
followers A count of the total number of followers |
followers_change A count of the total change in the number of followers |
friends A count of the total number of friends |
tweets A count of the total number of tweets posted |
retweets A count of how many times your tweets have been retweeted |
favourites A count of how many times your tweets have been favorited or liked |
replies A count of how many times your tweets have been replied to |
engagement A count of the number of times a user has interacted with the tweet |
engagement_rate Sum of engagements (Replies, Retweets, Likes) divided by Followers per tweet |
Twitter Benchmarks
profile_id Twitter profile ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
followers The number of followers this account currently has |
followers_change Daily change in the total number of followers |
friends The number of users this account is following |
friends_change Daily change in the total number of friends |
tweets A count of the total original messages posted on Twitter |
retweets A count of how many times your tweets have been retweeted |
favorites A count of how many times your tweets have been favorited or liked |
replies A count of how many times your tweets have been replied to |
mentions A count of tweets that contain your @username anywhere in the body of the tweet |
retweets_out A count of how many times you have retweeted tweets by others |
replies_out A count of how many times you have replied to tweets by others |
profile_id Twitter profile ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
timestamp Timestamp of the tweet |
tweet_id Unique ID of the tweet |
type Type of tweet (text, photo, video, and animated_gif) |
text Tweet caption |
labels Labels assigned to the tweet via the Locowise label manager |
replies A count of how many times the tweet has been replied to |
retweets A count of how many times the tweet has been retweeted |
favorites A count of how many times the tweet has been favorited or liked |
followers Total number of followers the account had when the tweet was posted |
sentiment Positive (score of 60 and above), Neutral (score between 40 and 60) and Negative (score below 40) |
engagement A count of the number of times a user has interacted with the tweet |
engagement_rate Sum of engagements (Replies, Retweets, Likes) divided by Followers |
potential_impressions A count of the total number of estimated times the tweet has been viewed |
in_reply_to_status_id Tweet ID replied to |
in_reply_to_user_id User ID replied to |
expanded_url expanded_url |
media_url An expanded version of display_url that links to the media display page |
hashtag Hashtags used within the body of the tweet |
source Platform used to publish the tweet |
profile_id Twitter profile ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
timestamp Timestamp of the mention |
mention_id Unique ID of the mention |
user_id Unique user_id of the mentioning user |
user_name Username of the mentioning user |
comment Message posted in the body of the mention |
source Platform used to publish the mention |
in_reply_to_status_id Tweet ID replied to |
profile_id Twitter profile ID |
name The name, handle, or alias that this user identifies themselves with |
followers A count of the total number of followers |
followers_change A count of the total change in the number of followers |
friends A count of the total number of friends |
tweets A count of the total number of tweets posted |
retweets A count of how many times your tweets have been retweeted |
favourites A count of how many times your tweets have been favorited or liked |
replies A count of how many times your tweets have been replied to |
engagement A count of the number of times a user has interacted with the tweet |
engagement_rate Sum of engagements (Replies, Retweets, Likes) divided by Followers per tweet |
LinkedIn Owned
profile_id LinkedIn company ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
followers The total number of followers acquired through organic and paid campaigns |
followers_change Daily change in the total number of followers |
organic_followers The total number of followers acquired through organically |
organic_followers_change Daily change in the total number of organic followers |
paid_followers The total number of followers acquired through paid campaigns |
paid_followers_change Daily change in the total number of paid followers |
likes The total number of times users liked your posts |
comments The total number of times users commented on your posts |
shares The total number of times users shared your posts |
clicks The number of times that users clicked anywhere in your post |
impressions The total number of times users viewed your posts |
reach Number of people who have seen any content associated with the page |
profile_id LinkedIn company ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
post_id Unique ID of the post |
type Type of post |
caption Post caption |
description Post description |
labels Labels assigned to the post via the Locowise label manager |
followers The number of followers the account had when the post was published |
likes The total number of times users liked your posts |
comments The total number of times users commented on your posts |
shares The total number of times users shared your posts |
clicks The number of times that users clicked anywhere in your post |
impressions The total number of times users viewed your posts |
reach Number of people who have seen any content associated with the page |
engagement Total number of times members clicked, liked, commented on, and shared your posts |
engagement_rate Total engagement (likes, comments, clicks and followers acquired) divided by the total number of impressions |
post_url URL pointing directly to the post on LinkedIn |
media_url URL pointing directly to the uploaded media file |
profile_id LinkedIn company ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
username The name of the commenting user |
post_id Unique ID of the parent post |
user_id Unique user_id of the commenting user |
comment Message posted in the body of the comment |
profile_id LinkedIn company ID |
name The name, handle, or alias that this user identifies themselves with |
followers The total number of followers acquired through organic and paid campaigns |
followers_change Daily change in the total number of followers |
organic_followers The total number of followers acquired through organically |
organic_followers_change Daily change in the total number of organic followers |
paid_followers The total number of followers acquired through paid campaigns |
paid_followers_change Daily change in the total number of paid followers |
likes The total number of times users liked your posts |
comments The total number of times users commented on your posts |
shares The total number of times users shared your posts |
clicks The number of times that users clicked anywhere in your post |
impressions The total number of times users viewed your posts |
reach Number of people who have seen any content associated with the page |
Youtube Owned
profile_id Youtube channel ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
subscribers The number of times that users subscribed to a channel |
subscribers_gained The number of times that users subscribed to a channel |
subscribers_lost The number of times that users unsubscribed from a channel |
views The number of times that a video was viewed |
likes The number of times that users liked a video |
comments The number of times that users commented on a video |
shares The number of times that users shared a video through the Share button |
dislikes The number of times that users gave a negative rating on a video |
estimated_minutes_watched The number of minutes that users watched videos for the specified channel |
average_view_duration The average length, in seconds, of video playbacks |
average_view_percentage The average percentage of a video watched during a video playback |
annotation_click_through_rate The percentage of clickable annotations that received clicks |
annotation_close_rate The percentage of annotation impressions that were closed by the viewer |
annotation_impressions Number of times an annotations was displayed |
annotation_clickable_impressions Number of times an annotation with the option to click further was displayed |
annotation_closable_impressions Number of times an annotation with the option to close it was displayed |
annotation_clicks Number of clicks on annotations |
annotation_closes The number of closed annotations |
shares_source The physical form factor of the device on which the share occurred |
device The physical form factor of the device on which the view occurred |
traffic_source Sources aggregated based on the referrer type |
male Lifetime age distribution of the male subscribers |
female Lifetime age distribution of the male subscribers |
location Lifetime location distribution of subscribers |
profile_id Youtube channel ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
video_id Unique ID of the video |
caption Video title |
description Description |
image_path Image path |
labels Labels assigned to the post via the Locowise label manager |
subscribers The number of subscribers the channel had when the post was published |
likes The number of times that users liked a video |
comments The number of times that users commented on a video |
shares The number of times that users shared a video through the Share button |
views The number of times that a video was viewed |
dislikes The number of times that users gave a negative rating on a video |
engagement Total number of likes, comments, shares and dislikes on the video |
engagement_rate Sum of engagements (Likes, Comments, Shares, Dislikes) divided by Subscribers |
duration Running time of the video |
definition Quality of the video |
profile_id Youtube channel ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
video_id Unique ID of the video the comment was posted on |
user_name Name of the comment author |
comment Message posted in the body of the comment |
profile_id Youtube channel ID |
name The name, handle, or alias that this user identifies themselves with |
subscribers The number of subscribers this account currently has |
subscribers_gained The number of times that users subscribed to a channel |
subscribers_lost The number of times that users unsubscribed from a channel |
views The number of times that a video was viewed |
likes The number of times that users liked a video |
comments The number of times that users commented on a video |
shares The number of times that users shared a video through the Share button |
dislikes The number of times that users gave a negative rating on a video |
engagement Total number of likes, comments, shares and dislikes on the video |
engagement_rate Sum of engagements (Likes, Comments, Shares, Dislikes) divided by Subscribers |
Youtube Benchmark
profile_id Youtube channel ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
subscribers The number of times that users subscribed to a channel |
views The number of times that a video was viewed |
likes The number of times that users liked a video |
comments The number of times that users commented on a video |
shares The number of times that users shared a video through the Share button |
dislikes The number of times that users gave a negative rating on a video |
profile_id Youtube channel ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
video_id Unique ID of the video |
caption Video title |
description Description |
image_path Image path |
labels Labels assigned to the post via the Locowise label manager |
subscribers The number of subscribers the channel had when the post was published |
likes The number of times that users liked a video |
comments The number of times that users commented on a video |
shares The number of times that users shared a video through the Share button |
views The number of times that a video was viewed |
dislikes The number of times that users gave a negative rating on a video |
engagement Total number of likes, comments, shares and dislikes on the video |
engagement_rate Sum of engagements (Likes, Comments, Shares, Dislikes) divided by Subscribers |
duration Running time of the video |
definition Quality of the video |
profile_id Youtube channel ID |
name The name, handle, or alias that this user identifies themselves with |
date Date converted in the profile timezone |
day Day converted in the profile timezone |
video_id Unique ID of the video the comment was posted on |
user_name Name of the comment author |
comment Message posted in the body of the comment |
profile_id Youtube channel ID |
name The name, handle, or alias that this user identifies themselves with |
subscribers The number of subscribers this account currently has |
views The number of times that a video was viewed |
likes The number of times that users liked a video |
comments The number of times that users commented on a video |
shares The number of times that users shared a video through the Share button |
dislikes The number of times that users gave a negative rating on a video |
engagement Total number of likes, comments, shares and dislikes on the video |
engagement_rate Sum of engagements (Likes, Comments, Shares, Dislikes) divided by Subscribers |