Users

GET
/campaigns/campaign-id/users

Get all campaign users.

Query parameters

count Set the number of users to return per response
sort Set the criteria for sorting users. Possible values: followers, following, score, username, user_id, item_score_sum, posts_published, posted_items_count
reverse Reverse the order of returned users
user_type Return only users of selected type. Possible values: instagram, twitter, facebook
start_date Return users who have contibuted after this date
end_date Return users who have contibuted before this date
GET https://analytics-api.flockler.com/v1/campaigns/92/users
{
  "meta": {
    "total_count": 39,
    "count": 9
  },
  "pagination": {
    "base": "https://analytics-api.flockler.com/v1/campaigns/92/users?api_key=618d58d76fcbcbba5333506d6a72ae83&count=9",
    "older": "https://analytics-api.flockler.com/v1/campaigns/92/users?api_key=618d58d76fcbcbba5333506d6a72ae83&count=9&page=2"
  },
  "users": [
    {
      "id": "1729800i",
      "user_id": "338435137",
      "username": "reemapere",
      "fullname": "Reema Pereira",
      "bio": "๐Ÿ“Indian ๐Ÿ‡ฎ๐Ÿ‡ณ, Born and Raised in Dubai ๐Ÿ‡ฆ๐Ÿ‡ช, currently in UK ๐Ÿ‡ฌ๐Ÿ‡ง | ๐Ÿ‘ฉ๐Ÿปโ€๐Ÿ’ปEnvironmental Scientist | ๐Ÿ‘ป reemapere",
      "profile_url": "https://instagram.com/reemapere",
      "profile_picture_url": "https://scontent.cdninstagram.com/vp/8ef10a57f0c3f4c5812bbadc23dbe0f2/5AEB0B55/t51.2885-19/s150x150/14676714_218977675204796_7169785109908815872_a.jpg",
      "followers": 1181,
      "following": 929,
      "posts_published": 419,
      "posted_items_count": 1,
      "user_type": "instagram",
      "score": 10.0,
      "item_score_sum": 86.43,
      "stat1_count": 1,
      "stat2_count": 0,
      "stat3_count": 0,
      "items_stat1_sum": 51,
      "items_stat2_sum": 0,
      "items_stat3_sum": 0
    },
    {
      "id": "1729801i",
      "user_id": "2092409880",
      "username": "pasztorerika",
      "fullname": "Eri๐Ÿ‡ญ๐Ÿ‡บ",
      "bio": "",
      "profile_url": "https://instagram.com/pasztorerika",
      "profile_picture_url": "https://scontent.cdninstagram.com/vp/690c2b94a6ed0a14d73b4a96a57c276c/5AE0DAEA/t51.2885-19/s150x150/22278231_180370469179323_9029394267042217984_n.jpg",
      "followers": 142,
      "following": 440,
      "posts_published": 428,
      "posted_items_count": 1,
      "user_type": "instagram",
      "score": 10.0,
      "item_score_sum": 11.26,
      "stat1_count": 0,
      "stat2_count": 1,
      "stat3_count": 0,
      "items_stat1_sum": 2,
      "items_stat2_sum": 2,
      "items_stat3_sum": 0
    },
    {
      "id": "1729802i",
      "user_id": "552907347",
      "username": "rekorderligcider_aus",
      "fullname": "Rekorderlig",
      "bio": "Find us wherever you are in Australia. Enjoy responsibly.",
      "profile_url": "https://instagram.com/rekorderligcider_aus",
      "profile_picture_url": "https://scontent.cdninstagram.com/vp/caf56586880729c215697019c4b99e11/5B00FB17/t51.2885-19/s150x150/21148993_890697164413224_8901075547774255104_a.jpg",
      "followers": 18290,
      "following": 7123,
      "posts_published": 1023,
      "posted_items_count": 1,
      "user_type": "instagram",
      "score": 10.0,
      "item_score_sum": 241.0,
      "stat1_count": 0,
      "stat2_count": 1,
      "stat3_count": 0,
      "items_stat1_sum": 41,
      "items_stat2_sum": 1,
      "items_stat3_sum": 0
    },
    {
      "id": "1729804i",
      "user_id": "8351985",
      "username": "geordiekirsty",
      "fullname": "Kirsty Jones",
      "bio": "",
      "profile_url": "https://instagram.com/geordiekirsty",
      "profile_picture_url": "https://scontent.cdninstagram.com/vp/a4ed1e3df078755be9d13a04d34f8cfb/5AF2277C/t51.2885-19/s150x150/12716998_1697145677221383_1425774282_a.jpg",
      "followers": 557,
      "following": 416,
      "posts_published": 777,
      "posted_items_count": 1,
      "user_type": "instagram",
      "score": 10.0,
      "item_score_sum": 63.71,
      "stat1_count": 0,
      "stat2_count": 3,
      "stat3_count": 0,
      "items_stat1_sum": 22,
      "items_stat2_sum": 7,
      "items_stat3_sum": 0
    },
    {
      "id": "1729835i",
      "user_id": "376357660",
      "username": "carly_pat",
      "fullname": "Carly Davis",
      "bio": "๐Ÿ“๐Ÿ‡ฌ๐Ÿ‡ง\n๐ŸŒž๐ŸŒŠ๐ŸŒด๐Ÿ‰๐Ÿฆ๐ŸŽพโœˆ๐Ÿ“š๐ŸŒ๐Ÿ’‹",
      "profile_url": "https://instagram.com/carly_pat",
      "profile_picture_url": "https://scontent.cdninstagram.com/vp/1deb011d88057d2a58867d4d12d6adc3/5AF3BDE4/t51.2885-19/s150x150/14723503_1701672880152485_8581057126527401984_a.jpg",
      "followers": 449,
      "following": 777,
      "posts_published": 1041,
      "posted_items_count": 1,
      "user_type": "instagram",
      "score": 10.0,
      "item_score_sum": 44.44,
      "stat1_count": 0,
      "stat2_count": 0,
      "stat3_count": 0,
      "items_stat1_sum": 26,
      "items_stat2_sum": 1,
      "items_stat3_sum": 0
    },
    {
      "id": "1729843i",
      "user_id": "827667986",
      "username": "mokai_official",
      "fullname": "MOKAร",
      "bio": "The content of this profile is for consumers of legal drinking age only. #DiamantKampagne ๐Ÿ’Ž Lรฆs mere:",
      "profile_url": "https://instagram.com/mokai_official",
      "profile_picture_url": "https://scontent.cdninstagram.com/vp/18b70fd3366a53297a78b5df7d9c51e0/5B202CE6/t51.2885-19/s150x150/14718046_109610506181833_3305844943435595776_a.jpg",
      "followers": 6092,
      "following": 1,
      "posts_published": 771,
      "posted_items_count": 1,
      "user_type": "instagram",
      "score": 10.0,
      "item_score_sum": 300.0,
      "stat1_count": 0,
      "stat2_count": 0,
      "stat3_count": 0,
      "items_stat1_sum": 100,
      "items_stat2_sum": 0,
      "items_stat3_sum": 0
    },
    {
      "id": "1729859i",
      "user_id": "9281233",
      "username": "lizakb",
      "fullname": "eb.",
      "bio": "sugar, spice and everything not so nice. ๐ŸŒˆ.",
      "profile_url": "https://instagram.com/lizakb",
      "profile_picture_url": "https://scontent.cdninstagram.com/vp/d08a7569f38a451259302b3cceeb46e4/5AE46D3E/t51.2885-19/11330773_1462169390777553_353066030_a.jpg",
      "followers": 355,
      "following": 588,
      "posts_published": 32,
      "posted_items_count": 1,
      "user_type": "instagram",
      "score": 10.0,
      "item_score_sum": 0.0,
      "stat1_count": 0,
      "stat2_count": 0,
      "stat3_count": 0,
      "items_stat1_sum": 20,
      "items_stat2_sum": 1,
      "items_stat3_sum": 0
    },
    {
      "id": "1729868i",
      "user_id": "2834461",
      "username": "jamieiri",
      "fullname": "Jamie Richards",
      "bio": "Ex-cocktail barman working in advertising. Drinks | London๐Ÿธ๐ŸŒƒ",
      "profile_url": "https://instagram.com/jamieiri",
      "profile_picture_url": "https://scontent.cdninstagram.com/vp/e102fb693edc1a73212ca8d6bc5f8d11/5AFF9AF6/t51.2885-19/s150x150/20634071_266861870466403_3536807140490477568_a.jpg",
      "followers": 353,
      "following": 197,
      "posts_published": 172,
      "posted_items_count": 1,
      "user_type": "instagram",
      "score": 10.0,
      "item_score_sum": 92.59,
      "stat1_count": 0,
      "stat2_count": 0,
      "stat3_count": 0,
      "items_stat1_sum": 62,
      "items_stat2_sum": 4,
      "items_stat3_sum": 0
    },
    {
      "id": "1729882i",
      "user_id": "43804524",
      "username": "bierefan",
      "fullname": "bierefan",
      "bio": "Just posting random stuff...my \"normal\" is probably not as exciting as yours, so \"follow\" at your peril...it's encouraged, but not required... ;)",
      "profile_url": "https://instagram.com/bierefan",
      "profile_picture_url": "https://scontent.cdninstagram.com/vp/79b87ef58b2b51fcb29c246141ab5682/5B03F9D4/t51.2885-19/s150x150/12357530_208826132792699_706832742_a.jpg",
      "followers": 854,
      "following": 1220,
      "posts_published": 5987,
      "posted_items_count": 1,
      "user_type": "instagram",
      "score": 10.0,
      "item_score_sum": 43.65,
      "stat1_count": 0,
      "stat2_count": 0,
      "stat3_count": 0,
      "items_stat1_sum": 18,
      "items_stat2_sum": 0,
      "items_stat3_sum": 0
    }
  ]
}
Field Data type Description values
bio string This user's bio
followers integer The amount of followers of this user. Only available for Twitter entries. Facebook and Instagram don't publish this information for privacy reasons.
following integer The amount of users this user is following. Only available for Twitter entries. Facebook and Instagram don't publish this information for privacy reasons.
fullname string Full name of this user. Not available for Instagram users due to privacy reasons.
id string ID of this entry
posted_items_count integer Amount of posts by this user related to this campaign
posts_published integer Total amount of posts this user has made. Only available for Twitter entries. Facebook and Instagram restrict 3rd party access to this information.
profile_picture_url string URL of this user's profile picture. Only available for Twitter entries and some Facebook entries. Instagram and Facebook partially restrict 3rd party access to this information.
profile_url string URL of this user's profile in the originating service
username string Username of this user
user_id string ID of this user in the originating service (e.g. Twitter) Global IDs not available for Facebook users due to 3rd party restrictions.
user_type string Type of this user twitter, instagram, facebook
score float Score calculated for this user based on the amount of content related to this campaign.
stat1 none Not available.
stat2 integer Campaign-related replies given. Only available for Twitter users
GET
/campaigns/campaign-id/users/id

Get single user.

GET https://analytics-api.flockler.com/v1/campaigns/92/users/1729931i
{
  "id": "1729931i",
  "user_id": "503239627",
  "username": "thehopfactory",
  "fullname": "The Hop Factory",
  "bio": "Craft Beer Bar ๐Ÿบ || Restaurant ๐Ÿด || Events & Functions ๐ŸŽ‰ Tag us #thehopfactory ๐Ÿ“ธ \nPh: 02 4929 4854",
  "profile_url": "https://instagram.com/thehopfactory",
  "profile_picture_url": "https://scontent.cdninstagram.com/vp/428a99719d8e95ea9a672c73390ad4b1/5AE102A9/t51.2885-19/s150x150/26073866_324407664713082_3565100989172154368_n.jpg",
  "followers": 3354,
  "following": 1429,
  "posts_published": 1756,
  "posted_items_count": 1,
  "user_type": "instagram",
  "score": 10.0,
  "stat1_count": 2,
  "stat2_count": 0,
  "stat3_count": 0,
  "items_stat1_sum": 85,
  "items_stat2_sum": 1,
  "items_stat3_sum": 0
}
Field Data type Description values
bio string This user's bio
followers integer The amount of followers of this user. Only available for Twitter entries. Facebook and Instagram don't publish this information for privacy reasons.
following integer The amount of users this user is following. Only available for Twitter entries. Facebook and Instagram don't publish this information for privacy reasons.
fullname string Full name of this user. Not available for Instagram users due to privacy reasons.
id string ID of this entry
posted_items_count integer Amount of posts by this user related to this campaign
posts_published integer Total amount of posts this user has made. Only available for Twitter entries. Facebook and Instagram restrict 3rd party access to this information.
profile_picture_url string URL of this user's profile picture. Only available for Twitter entries and some Facebook entries. Instagram and Facebook partially restrict 3rd party access to this information.
profile_url string URL of this user's profile in the originating service
username string Username of this user
user_id string ID of this user in the originating service (e.g. Twitter) Global IDs not available for Facebook users due to 3rd party restrictions.
user_type string Type of this user twitter, instagram, facebook
score float Score calculated for this user based on the amount of content related to this campaign.
stat1 none Not available.
stat2 integer Campaign-related replies given. Only available for Twitter users
GET
/campaigns/campaign-id/users/user-type/user-id

Get single user by external service id. This endpoint redirects (302) to the /campaigns/:campaign-id/users/:id endpoint.

GET https://analytics-api.flockler.com/v1/campaigns/92/users/instagram/503239627
Field Data type Description values
bio string This user's bio
followers integer The amount of followers of this user. Only available for Twitter entries. Facebook and Instagram don't publish this information for privacy reasons.
following integer The amount of users this user is following. Only available for Twitter entries. Facebook and Instagram don't publish this information for privacy reasons.
fullname string Full name of this user. Not available for Instagram users due to privacy reasons.
id string ID of this entry
posted_items_count integer Amount of posts by this user related to this campaign
posts_published integer Total amount of posts this user has made. Only available for Twitter entries. Facebook and Instagram restrict 3rd party access to this information.
profile_picture_url string URL of this user's profile picture. Only available for Twitter entries and some Facebook entries. Instagram and Facebook partially restrict 3rd party access to this information.
profile_url string URL of this user's profile in the originating service
username string Username of this user
user_id string ID of this user in the originating service (e.g. Twitter) Global IDs not available for Facebook users due to 3rd party restrictions.
user_type string Type of this user twitter, instagram, facebook
score float Score calculated for this user based on the amount of content related to this campaign.
stat1 none Not available.
stat2 integer Campaign-related replies given. Only available for Twitter users