How to use the API

For use the ATRIBUS API you need to select a category id and a search id you will find this information in the respective endpoints. Then you need to set an interval of dates in UNIX time (seconds). This interval can't be more than 2 weeks (1.020.000 s). And the information will be returned in a JSON. If you have some doubt you can contact us by e-mail to soporte@atribus.com.

Access Token

For obtain the access token follow the steps in this link.

Searchs   GET

With this endpoint you can get all the searchs that you got in app.atribus.com https://api.atribus.com/api/searchs

Request

Parameter Type Position # Description
Authorization string Header Required Authorization token for request.

Response

								{
    "current_page": 1,
    "data": [
        {
            "search_id": *,
            "crawlers_id": "*****",
            "category_id": *,
            "search": "****",
            "active": *,
            "date": "******",
            "timezone": "********",
            "geo_unknown": **,
            "avatar": **,
            "min_follower": **,
            "max_follower": **,
            "verified": *,
            "description": "**",
            "app": **,
            "filter_not_lang": "",
            "filter_not_geo": "",
            "filter_sentiment": "",
            "rss": "",
            "pause": 0
        }
    ],
    "first_page_url": "https://api.atribus.com/api/searchs?page=1",
    "from": 1,
    "last_page": *,
    "last_page_url": "https://api.atribus.com/api/searchs?page=2",
    "next_page_url": "https://api.atribus.com/api/searchs?page=2",
    "path": "https://api.atribus.com/api/searchs",
    "per_page": **,
    "prev_page_url": null,
    "to": **,
    "total": **
}

Searchs Create   POST

With this endpoint you can create a search in Atribus https://api.atribus.com/api/create_search.

Request

Parameter Type Position # Description
Authorization string Header Required Authorization token for request.
search string Body Required Search Keyword.
category integer Body RequiredExists Category search keyword.
crawlers string Body Required Crawlers ID for search keyword. For Twitter, Youtube, Instagram and Facebook you MUST login inside the app. For multiple crawlers separate with " , ".
timezone string Body RequiredExists Search Timezone. The timezone must exists in this list
geo_unknown integer Body Required This field is to filter the information based on the geo in bio, 1 = users with unknown geo, 0 = users with defined geo in bio.
avatar integer Body Required This field is to filter the information based on the users avatar.1 = users with default avatar will be dismiss, 0 = users with default avatar will be accepted.
min_follower integer Body SometimesRequiredGreater than 0 Here you can filter the minimun followers of the account to get the infomation.
max_follower integer Body SometimesRequiredGreater than 0 Here you can filter the maximum followers of the account to get the infomation.
description string Body SometimesRequired Words that MUST appear in the users description, if the word does not appear in the description information will be dismissed. To separate differents words use " , ".
verified integer Body Required This field is to filter the information based on verified users.1 = verified users will be dismiss, 0 = verified users will be accepted.
facebooks_pages array Body SometimesRequired List of fanpages from facebook to add to the search.
facebooks_pages.*.id integer Body Required The id of the fanpage.
facebooks_pages.*.name string Body Required Name of the fanpage.
lang_include string Body SometimesRequired Languages which the information will be gathered. To add differents language use " , " between them . Here is the list of languages accepted
geo_include string Body SometimesRequired Countries which the information will be gathered. To add different countries use " , " between them. Here is the list of the countries accepted.
not_lang string Body SometimesRequired Languages which the information WON'T be gathered. To add differents language use " , " between them . Here is the list of languages accepted.
not_geo string Body SometimesRequired Countries witch the information WON'T be gathered. To add different countries use " , " between them. Here is the list of the countries accepted.
sentiment_positive string Body SometimesRequired Words to clasify information as positive. To add different words use " , " to separate them.
sentiment_negative string Body SometimesRequired Words to clasify information as negative. To add different words use " , " to separate them.
sentiment_neutro string Body SometimesRequired Words to clasify information as neutro. To add different words use " , " to separate them.
whitelist string Body SometimesRequired Words that the gathered information MUST contain. To add different words use " , " to separate them.
users_whitelist string Body SometimesRequired Users which we want to gather information. To add different users use " , " to separate them.
blacklist string Body SometimesRequired Words that the gathered information CAN'T contain. To add different words use " , " to separate them.
users_blacklist string Body SometimesRequired Users which we DON'T want to gather information. To add different users use " , " to separate them.
blacktuplas string Body SometimesRequired Words that the gathered information CAN'T contain and can be in any part of the text. To add different words use " , " to separate them.

Example 

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.atribus.com/api/create_search',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('search' => '****','category' => '**','crawlers' => '*,**,*,*,*',
  'verified' => '0','max_follower' => '100','min_follower' => '100','avatar' => '1',
  'lang_include' => 'es,de','geo_unknown' => '0','timezone' => 'Europe/Madrid',
  'geo_include' => 'Brasil,Afganistán,España,Antigua y Barbuda','description' => '***',
  'sentiment_positive' => '**','sentiment_negative' => '**** , **** ,*****',
  'sentiment_neutro' => '****','facebooks_pages[0][id]' => '****',
  'facebooks_pages[0][name]' => '****','facebooks_pages[1][id]' => '***',
  'facebooks_pages[1][name]' => '*******','whitelist' => '*****,******,*******',
  'blacklist' => '*****, ***','users_blacklist' => '****,******',
  'users_whitelist' => '******,*******,*******','blacktuplas' => '*******,******'),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer *********************'
  ),
));

Response 400

{
    "error": {
        "crawlers": [
            "The field crawlers is required.",
            "You entered a crawler that does not exist."
        ],
        "category": [
            "The field category is required"
        ],
        "search": [
            "The search field is required."
        ],
        ********:[
             ********************
        ]
    }
}

Response 200

{"Search created correctly with Id: ***"}

Searchs Delete   POST

With this endpoint you can delete a search in Atribus https://api.atribus.com/api/delete_search

Request

Parameter Type Position # Description
Authorization string Header Required Authorization token for request.
search integer Body Required Id of the search that you want to delete.

Response 200

{"Search deleted with Id: ***"}

Response 400

{"There was a problem deleting the search with Id: ***"}

Crawlers   GET

With this endpoint you can get all the Crawlers that we have in Atribus https://api.atribus.com/api/crawlers. To create a search in Monitoring you can only use the Crawlers: Twitter, Youtube, Facebook, DigitalNews, Blogs, Foros, Webs, Instagram, Reddits, TikTok, TV/Radio/Newspaper.

Request

Parameter Type Position # Description
Authorization string Header Required Authorization token for request.

Response

[
    {
        "crawlers_id": 1,
        "name": "twitter"
    },
    {
        "crawlers_id": 2,
        "name": "youtube"
    },
    {
        "crawlers_id": 3,
        "name": "digitalnews"
    },
    {
        "crawlers_id": 4,
        "name": "facebook"
    },
    {
        "crawlers_id": 5,
        "name": "blog"
    },
    {
        "crawlers_id": 6,
        "name": "foro"
    },
    {
        "crawlers_id": 7,
        "name": "web"
    },
    {
        "crawlers_id": 8,
        "name": "tumblr"
    },
    {
        "crawlers_id": 9,
        "name": "instagram"
    },
    {
        "crawlers_id": 10,
        "name": "reddit"
    },
    {
        "crawlers_id": 11,
        "name": "linkedin"
    },
    {
        "crawlers_id": 12,
        "name": "tiktok"
    },
    {
        "crawlers_id": 13,
        "name": "tv/radio/papernews"
    },
    {
        "crawlers_id": 14,
        "name": "googlemybusiness"
    },
    {
        "crawlers_id": 15,
        "name": "vimeo"
    },
    {
        "crawlers_id": 16,
        "name": "twitch"
    }
]

Categories   GET

With this endpoint you can get all the categories that you got in app.atribus.com https://api.atribus.com/api/categories

Request

Parameter Type Position # Description
Authorization string Header Required Authorization token for request.

Response

{
    "current_page": 1,
    "data": [
        {
            "category_id": **,
            "search": "***",
            "active": **,
            "date": "*******",
            "app": **
        }
    ],
    "first_page_url": "https://api.atribus.com/api/categories?page=1",
    "from": *,
    "last_page": *,
    "last_page_url": "https://api.atribus.com/api/categories?page=3",
    "next_page_url": "https://api.atribus.com/api/categories?page=2",
    "path": "https://api.atribus.com/api/categories",
    "per_page": *,
    "prev_page_url": null,
    "to": *,
    "total": **
}

Categories create   POST

With this endpoint you can create a category in app.atribus.com https://api.atribus.com/api/create_category

Request

Parameter Type Position # Description
Authorization string Header Required Authorization token for request.
name string Body Required Name that you want to change.
product int Body Required The product for what you want to create the category.1 for monitoring, 2 for profiles.

Example of post

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.atribus.com/api/create_category',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('name' => '*****','product' => '*'),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer **********************************'
  ),
));

Response with code 400

{
    "error": {
        "name": [
            "The name field is required."
        ],
        "product": [
            "The product field is required."
        ]
    }
}

Response with code 200

{"Category created correctly"}

Categories Update   POST

With this endpoint you can update a category in app.atribus.com https://api.atribus.com/api/create_category

Request

Parameter Type Position # Description
Authorization string Header Required Authorization token for request.
category int Body Required Category that you want update.
name int Body Required Name that you want to change.

Example post

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.atribus.com/api/update_category',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('name' => '***********','category' => '**'),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer *******'
  ),
));

Response 400

{
    "error": {
        "category": [
            "The category field is required."
        ],
        "name": [
            "The name field is required."
        ]
    }
}

Response 200

{"Category updated correctly"}

Categories Delete   POST

With this endpoint you can delete a category in app.atribus.com https://api.atribus.com/api/create_category

Request

Parameter Type Position # Description
Authorization string Header Required Authorization token for request.
category int Body Required Category that you want update.

Example

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.atribus.com/api/delete_category',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS => array('category' => '**'),
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer ***********'
  ),
));

Response 400

{
    "error": {
        "category": [
            "The category field is required."
        ]
    }
}

Response 200

{"Category deleted correctly"}

Profiles   GET

With this endpoint you can get all the profiles that you got in app.atribus.com https://api.atribus.com/api/profiles

Request

Parameter Type Position # Description
Authorization string Header Required Authorization token for request.

Response

{
    "current_page": 1,
    "data": [
        {
            "profiles_id": *,
            "category_id": *,
            "crawler": *,
            "screen_name": "**",
            "user_id": "**",
            "active": **,
            "date": "***",
            "timezone": "****",
            "refresh_token": "",
            "avatar": "*****",
            "count_follow": **,
            "count_follower": **,
            "count_publish": **,
            "description": "**",
            "is_login": *,
            "recover_mention": *,
            "recover_story": *,
            "date_refresh": **,
            "pause": *
        }
    ],
    "first_page_url": "https://api.atribus.com/api/profiles?page=1",
    "from": 1,
    "last_page": 2,
    "last_page_url": "https://api.atribus.com/api/profiles?page=2",
    "next_page_url": "https://api.atribus.com/api/profiles?page=2",
    "path": "https://api.atribus.com/api/profiles",
    "per_page": **,
    "prev_page_url": null,
    "to": **,
    "total": **
}

Twitter Tweets Timeline   POST

To get all the tweets that atribus has collect for you https://api.atribus.com/api/timeline_twitter

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
search int Body Required Search that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "twitters_tweets_id": **********,
            "category": **,
            "search": **,
            "text": "***",
            "picture": "",
            "lang": "**",
            "date_created": "***",
            "latitude": **,
            "longitude": **,
            "county": "",
            "county_code": "",
            "country": "",
            "country_code": "",
            "count_retweet": **,
            "count_favorite": **,
            "sentiment": *,
            "retweet_twitters_tweets_id":****;
            "gender": *,
            "description": "*********",
            "avatar": "*********",
            "count_follow": ******,
            "twitters_users_id": *****,
            "screen_name": "****",
            "name": "****",
            "count_tweet": *****,
            "count_follower": *****,
            "value_potential": ****,
            "engagement": ****,
            "impact_potential": ***,
            "impression_estimated": ****,
            "interaction": ****,
            "impression_potential": *****,
            "reach_potential": ****,
            "reach_estimated": ***,
            "value_estimated": *****,
            "value_ayzenberg": ****
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_twitter?page=1",
    "from": *,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_twitter?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_twitter?page=2",
    "path": "https://api.atribus.com/api/timeline_twitter",
    "per_page": **,
    "prev_page_url": null,
    "to": **,
    "total": **
}

Twitter Tweets Replies   POST

To get all the replies of a tweet that atribus has collect for you https://api.atribus.com/api/twitters_replies

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
twitter_tweet_id int Body Required The id of the Tweet that you want to know the replies.

Response

{
    "current_page": 1,
    "data": [
        {
            "twitters_tweets_id": **********,
            "category": **,
            "search": **,
            "text": "***",
            "picture": "",
            "lang": "**",
            "date_created": "***",
            "location": "***",
            "latitude": **,
            "longitude": **,
            "county": "",
            "county_code": "",
            "country": "",
            "country_code": "",
            "reply_twitters_tweets_id": "**",
            "count_retweet": **,
            "count_favorite": **,
            "sentiment": *           
        }
    ],
    "first_page_url": "https://api.atribus.com/api/twitters_replies?page=1",
    "from": *,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/twitters_replies?page=**",
    "next_page_url": "https://api.atribus.com/api/twitters_replies?page=2",
    "path": "https://api.atribus.com/api/twitters_replies",
    "per_page": **,
    "prev_page_url": null,
    "to": **,
    "total": **
}

Twitter Tweets Profiles Timeline   POST

To get all the tweets that atribus has collect for you https://api.atribus.com/api/timeline_twitter_profiles

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
profile int Body Required Profile that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": *,
    "data": [
        {
            "twitters_profile_tweets_id": ***,
            "category": **,
            "profile_id": **,
            "text": "*****",
            "source": "****",
            "picture": "",
            "lang": "***",
            "date_created": "****",
            "latitude": *******,
            "longitude": ****,
            "county": "***",
            "county_code": "***",
            "country": "******",
            "country_code": "**",
            "count_retweet":***,
            "count_favorite": **,
            "sentiment": *,
            "twitters_user_id": ****,
            "gender": **,
            "description": "*****",
            "avatar": "****",
            "count_follow": *******,
            "twitters_profile_users_id": ****,
            "screen_name": "***",
            "name": "Sprout ***",
            "count_tweet": ***,
            "count_list": ***,
            "is_verified": **,
            "is_default_profile_image": **,
            "count_follower": ***,
            "duration": ****,
            "value_potential": *****,
            "engagement": *****,
            "impact_potential": ****,
            "impression_estimated": *****,
            "interaction": *,
            "impact_estimated": ***,
            "impression_potential": ***,
            "reach_potential": **,
            "reach_estimated": ***,
            "value_estimated": ***,
            "value_ayzenberg": *****
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_twitter_profiles?page=1",
    "from": *,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_twitter_profiles?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_twitter_profiles?page=**",
    "path": "https://api.atribus.com/api/timeline_twitter_profiles",
    "per_page": *,
    "prev_page_url": null,
    "to": *,
    "total": **
}

Instagrams Timeline   POST

To get all the instagrams that atribus has collect for you https://api.atribus.com/api/timeline_instagram

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
search int Body Required Search that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "instagrams_id": "*****",
            "instagrams_users_id": ****,
            "search_id": **,
            "category_id": **,
            "text": "*****",
            "type": "***",
            "picture": "*****",
            "lang": "**",
            "url": "****",
            "date_created": "***",
            "location": "**",
            "longitude": *,
            "county": "**",
            "county_code": "",
            "country": "",
            "country_code": "",
            "count_like": ***,
            "count_comment": **,
            "sentiment": *,
            "screen_name": "***",
            "name": "***",
            "description": "****",
            "avatar": "*********",
            "website": "*******",
            "gender": ***,
            "count_media": ***,
            "count_follow": ***,
            "count_follower": ***,
            "impression_potential": ***,
            "impression_estimated": **,
            "reach_potential": **,
            "reach_estimated": **,
            "engagement": ****,
            "interaction": ***,
            "value_potential": ***,
            "value_estimated": ****,
            "impact_potential": ***,
            "impact_estimated": ***,
            "value_ayzenberg": ****
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_instagram?page=1",
    "from": *,
    "last_page": ***,
    "last_page_url": "https://api.atribus.com/api/timeline_instagram?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_instagram?page=2",
    "path": "https://api.atribus.com/api/timeline_instagram",
    "per_page": **,
    "prev_page_url": null,
    "to": *,
    "total": ***
}

Instagrams Timeline   POST

To get all the instagrams comment of a given instagram that atribus has collect for you https://api.atribus.com/api/instagrams_comments

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
instagrams_id int Body Required The id of the instagram that you want to get all the comments.

Response

{
    "current_page": 1,
    "data": [
        {
            "instagrams_comments_id": "*****",
            "instagrams_id": "*****",
            "instagrams_users_id": ****,
            "text": **,
            "date_created": "***",
            "sentiment": *
        }
    ],
    "first_page_url": "https://api.atribus.com/api/instagrams_comments?page=1",
    "from": *,
    "last_page": ***,
    "last_page_url": "https://api.atribus.com/api/instagrams_comments?page=**",
    "next_page_url": "https://api.atribus.com/api/instagrams_comments?page=2",
    "path": "https://api.atribus.com/api/instagrams_comments",
    "per_page": **,
    "prev_page_url": null,
    "to": *,
    "total": ***
}

Instagrams Profiles Timeline   POST

To get all the instagrams profiles timeline that atribus has collect for you https://api.atribus.com/api/timeline_instagram_profiles

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
profile int Body Required Profile that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "instagrams_profiles_id": "****",
            "instagrams_profiles_users_id": ****,
            "profile_id": **,
            "category_id": *,
            "text": "******",
            "type": "***",
            "picture": "******",
            "lang": "**",
            "url": "****",
            "date_created": "*****",
            "location": "**",
            "longitude": **,
            "county": "**",
            "county_code": "**",
            "country": "**",
            "country_code": "**",
            "count_like": **,
            "count_comment": *,
            "story":*,
            "sentiment": *,
            "screen_name": "****",
            "name": "****",
            "description": "**********",
            "avatar": "****"",
            "website": "****",
            "gender": **,
            "count_media": **,
            "count_follow": **,
            "count_follower": **,
            "impression_potential": **,
            "impression_estimated": **,
            "reach_potential": **,
            "reach_estimated": **,
            "engagement": ******,
            "interaction": **,
            "value_potential": ***,
            "value_estimated": ***,
            "impact_potential": **,
            "impact_estimated": **,
            "value_ayzenberg": ***
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_instagram_profiles?page=1",
    "from": **,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_instagram_profiles?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_instagram_profiles?page=2",
    "path": "https://api.atribus.com/api/timeline_instagram_profiles",
    "per_page": **,
    "prev_page_url": null,
    "to": **,
    "total": **
}

YouTube Timeline   POST

To get all the feeds from Youtube that atribus has collect for you https://api.atribus.com/api/timeline_youtube

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
search int Body Required Search that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "youtubes_id": "***",
            "category": *,
            "search": **,
            "title": "***",
            "description": "******",
            "license": "***",
            "vid_category":"******",
            "lang": "en",
            "date_created": "******",
            "datetime_created": "******",
            "duration": **,
            "count_view": **,
            "count_like": **,		
            "count_dislike": **,
            "count_comment": **,
            "sentiment": **,
            "youtubes_users_id": "***",
            "screen_name": "***",
            "description_user": "****",
            "avatar": "*****",
            "age": **,
            "gender": *,
            "country": "**",
            "country_code": "**",
            "count_subscriber": **,
            "count_video_playback": **,
            "count_video": *,
            "rapidity": *,
            "impression": *,
            "reach": *,
            "engagement": *,
            "interaction": *,
            "value": ***,
            "impact": *,
            "passion": *,
            "value_ayzenberg": ***
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_youtube?page=1",
    "from": *,
    "last_page": *,
    "last_page_url": "https://api.atribus.com/api/timeline_youtube?page=*",
    "next_page_url": null,
    "path": "https://api.atribus.com/api/timeline_youtube",
    "per_page": *,
    "prev_page_url": null,
    "to": *,
    "total": *
}

YouTube Profiles Timeline   POST

To get all the youtube profiles timeline that atribus has collect for you https://api.atribus.com/api/timeline_youtube_profiles

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
profile int Body Required Profile that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "youtubes_profiles_id": "****",
            "youtubes_profiles_users_id": "****",
            "category_id": *,
            "title": "*****",
            "description": "*****",
            "category": "***",
            "license": "****",
            "lang": "**",
            "date_created": "******",
            "date_updated": "***",
            "duration": **,
            "count_view": **,
            "count_like": **,
            "count_dislike": **,
            "count_comment": **,
            "sentiment": **,
            "vid_category":"****",
            "screen_name": "****",
            "user_description": "*********",
            "avatar": "****",
            "age": **,
            "gender": **,
            "country": "**",
            "country_code": "**",
            "count_subscriber": ****,
            "count_video_playback": ****,
            "count_video": ***,
            "rapidity": *,
            "impression": ***,
            "reach": ***,
            "engagement": ***,
            "interaction": ***,
            "value": ***,
            "impact": ***,
            "passion": **,
            "value_ayzenberg": ***
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_youtube_profiles?page=1",
    "from": *,
    "last_page": ***,
    "last_page_url": "https://api.atribus.com/api/timeline_youtube_profiles?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_youtube_profiles?page=2",
    "path": "https://api.atribus.com/api/timeline_youtube_profiles",
    "per_page": **,
    "prev_page_url": null,
    "to": **,
    "total": **
}

Facebook Timeline

To get all the feeds from Facebook that atribus has collect for you https://api.atribus.com/api/timeline_facebook

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
search int Body Required Search that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "facebooks_feeds_id": "****",
            "facebooks_users_pages_id": ***,
            "search_id": **,
            "category_id": *,
            "name": "**",
            "message": "****",
            "description": "**",
            "type": "***",
            "picture": "********",
            "link": "***",
            "lang": "**",
            "date_created": "**",
            "datetime_created": "***",
            "count_like": **,
            "count_comment": *,
            "count_share": *,
            "count_reaction": *,
            "sentiment": *,
            "screen_name": "*****",
            "about": "*****",
            "url": "******",
            "avatar": "****",
            "website": "****",
            "category": "***",
            "gender": **,
            "country": "**",
            "country_code": "**",
            "county": "***",
            "county_code": "***",
            "street": "****",
            "latitude": ****,
            "longitude": ****,
            "phone": "***",
            "count_checkin": *,
            "count_talking": *,
            "impression_potential": **,
            "impression_estimated": **,
            "reach_potential": **,
            "reach_estimated": **,
            "engagement": **,
            "interaction": **,
            "value_potential": ***,
            "value_estimated": ***,
            "impact_potential": ***,
            "impact_estimated": **,
            "value_ayzenberg": ***
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_facebook?page=1",
    "from": 1,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_facebook?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_facebook?page=2",
    "path": "https://api.atribus.com/api/timeline_facebook",
    "per_page": **,
    "prev_page_url": null,
    "to": 1,
    "total": **
}

Facebook Profiles Timeline   POST

To get all the facebooks profiles timeline that atribus has collect for you https://api.atribus.com/api/timeline_facebook_profiles

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
profile int Body Required Profile that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "facebooks_profiles_feeds_id": "*****",
            "facebooks_profiles_users_pages_id": ****,
            "category_id": *,
            "name": "***",
            "message": "****",
            "description": "******",
            "source": "******",
            "caption": "**",
            "type": "***",
            "picture": "********",
            "link": "*******",
            "lang": "****",
            "date_created": "******",
            "date_updated": "***",
            "count_like": ***,
            "count_comment": **,
            "count_share": **,
            "count_reaction": **,
            "sentiment": **,
            "sentiment_human": **,
            "screen_name": "****",
            "about": "*****",
            "url": "****",
            "avatar": "****",
            "website": "*****",
            "category": "*****",
            "gender": **,
            "country": "**",
            "country_code": "**",
            "county": "**",
            "county_code": "***",
            "street": "***",
            "latitude": ****,
            "longitude": ****,
            "phone": "***",
            "count_checkin": *,
            "count_talking": *,
            "impression_potential": **,
            "impression_estimated": **,
            "reach_potential": **,
            "reach_estimated": **,
            "engagement": **,
            "interaction": *,
            "value_potential": ****,
            "value_estimated": ****,
            "impact_potential": ***,
            "impact_estimated": **,
            "value_ayzenberg": ***
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_facebook_profiles?page=1",
    "from": **,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_facebook_profiles?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_facebook_profiles?page=2",
    "path": "https://api.atribus.com/api/timeline_facebook_profiles",
    "per_page": **,
    "prev_page_url": null,
    "to": **,
    "total": **
}

Tik Tok Timeline   POST

To get all the feeds from Tik Tok that atribus has collect for you https://api.atribus.com/api/timeline_tiktok

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
search int Body Required Search that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "tiktoks_id": "****",
            "tiktoks_users_id": ***,
            "search_id": **,
            "category_id": *,
            "picture": "****",
            "tiktoks_musics_id": "**",
            "date_created": "**",
            "lang": "**",
            "description": "***",
            "count_comment": "********",
            "likes": "***",
            "count_play": "**",
            "count_share": "**",
            "screen_name": "***",
            "name": **,
            "user_description": *,
            "avatar": *,
            "is_verified": *,
            "count_video": *,
            "count_digg": "*****",
            "count_follower": "**",
            "count_follow": "*****",
            "user_total_likes": "******",
            "age": "****",
            "gender": "****",
            "impression_potential": "***",
            "impression_estimated": **,
            "reach_estimated": "**",
            "reach_potential": "**",
            "engagement": "***",
            "interaction": "***",
            "value_potential": "****",
            "value_estimated": ****,
            "value_ayzenberg": ****,
            "impact_potential": "***",
            "impact_estimated": *,
            "count_follower": *
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_tiktok?page=1",
    "from": 1,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_tiktok?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_tiktok?page=2",
    "path": "https://api.atribus.com/api/timeline_tiktok",
    "per_page": **,
    "prev_page_url": null,
    "to": 1,
    "total": **
}

Tiktok Profiles Timeline   POST

To get all the tiktoks profiles that atribus has collect for you https://api.atribus.com/api/timeline_tiktok_profiles

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
profile int Body Required Profile that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "tiktoks_profiles_id": "****",
            "tiktoks_profiles_users_id": ***,
            "profile_id": **,
            "category_id": *,
            "picture": "****",
            "tiktoks_profiles_musics_id": "**",
            "date_created": "**",
            "lang": "**",
            "description": "***",
            "count_comment": "********",
            "likes": "***",
            "count_play": "**",
            "count_share": "**",
            "screen_name": "***",
            "name": **,
            "user_description": *,
            "avatar": *,
            "is_verified": *,
            "count_video": *,
            "count_digg": "*****",
            "count_follower": "**",
            "count_follow": "*****",
            "user_total_likes": "******",
            "age": "****",
            "gender": "****",
            "impression_potential": "***",
            "impression_estimated": **,
            "reach_estimated": "**",
            "reach_potential": "**",
            "engagement": "***",
            "interaction": "***",
            "value_potential": "****",
            "value_estimated": ****,
            "value_ayzenberg": ****,
            "impact_potential": "***",
            "impact_estimated": *,
            "count_follower": *
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_facebook_profiles?page=1",
    "from": **,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_facebook_profiles?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_facebook_profiles?page=2",
    "path": "https://api.atribus.com/api/timeline_facebook_profiles",
    "per_page": **,
    "prev_page_url": null,
    "to": **,
    "total": **
}

Linkedin Profiles Timeline   POST

To get all the linkedin profiles that atribus has collect for you https://api.atribus.com/api/timeline_linkedin_profiles

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
profile int Body Required Profile that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "linkedins_profiles_id": "****",
            "linkedins_profiles_users_id": ***,
            "profile_id": **,
            "category_id": *,
            "title": "****",
            "text": "**",
            "description": "**",
            "url_picture": "**",
            "eye_brow_url": "***",
            "source": "********",
            "lang": "***",
            "date_created": "**",
            "count_like": "**",
            "count_comment": "***",
            "count_share": **,
            "url": *,
            "longitude": *,
            "latitude": *,
            "sentiment": *,
            "name": "*****",
            "headline": "**",
            "gender": "*****",
            "avatar": "******",
            "user_url": "****",
            "min_employee": "****",
            "max_employee": "***",
            "count_follower": **,
            "foundation": "**",
            "location": "**",
            "county": "***",
            "county_code": "***",
            "country": "****",
            "country_code": "****"",
            "lat_user": ***,
            "lon_user": ***,
            "is_company": *,
            "max_for_hour": **,
            "hours_of_max": ***,
            "duration": ***,
            "rapidity": ***,
            "impression": ***,
            "reach": **,
            "engagement": ***,
            "interaction": ****,
            "value": ***,
            "value_ayzenberg": **,
            "impact": **,
            "click_count":**
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_linkedin_profiles?page=1",
    "from": **,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_linkedin_profiles?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_linkedin_profiles?page=2",
    "path": "https://api.atribus.com/api/timeline_linkedin_profiles",
    "per_page": **,
    "prev_page_url": null,
    "to": **,
    "total": **
}

Tumblr Profiles Timeline   POST

To get all the Tumblr profiles that atribus has collect for you https://api.atribus.com/api/timeline_tumblr_profiles

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
profile int Body Required Profile that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "category_id": *,
            "profile_id": **,
            "tumblrs_profiles_id": ***********,
            "tumblrs_profiles_users_id": "******",
            "name": "******",
            "user_title": "********",
            "user_url": "***************",
            "description": "",
            "avatar": "***********************",
            "date_updated": "*********",
            "user_likes": *,
            "users_post": *,
            "user_follower": *,
            "title": "****",
            "caption": "",
            "text": "**********",
            "source": "",
            "post_url": "***********",
            "picture": "",
            "lang": "***",
            "date_created": "*******",
            "type": "*****",
            "format": "***",
            "state": "***",
            "is_bookmarklet": *,
            "is_mobile": *,
            "is_reblog": *,
            "source_url": "***",
            "source_title": "***",
            "count_reblog": *,
            "count_like": *,
            "count_reply": *,
            "count_note": *,
            "sentiment": *,
            "duration": *,
            "rapidity": *,
            "impression_estimated": *,
            "reach_estimated": *,
            "reach_potential": *,
            "engagement": *,
            "interaction": *,
            "value_potential": *,
            "value_estimated": *,
            "value_ayzenberg": *,
            "impact_potential": *,
            "impact_estimated": *,
            "count_follower": *
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_tumblr_profiles?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.atribus.com/api/timeline_tumblr_profiles?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_tumblr_profiles?page=**",
    "path": "https://api.atribus.com/api/timeline_tumblr_profiles",
    "per_page": 100,
    "prev_page_url": null,
    "to": **,
    "total": **
}

WordCloud   POST

To get the WordCloud that Atribus has collect for you https://api.atribus.com/api/wordcloud

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
search int Body Required Search that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "crawlers_id": *,
            "category_id": *,
            "search_id": *,
            "sentiment": *,
            "word": "***********",
            "date_created": "*********",
            "count": **
        }
    ],
    "first_page_url": "https://api.atribus.com/api/wordcloud?page=**",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.atribus.com/api/wordcloud?page=**",
    "next_page_url": "https://api.atribus.com/api/wordcloud?page=**",
    "path": "https://api.atribus.com/api/wordcloud",
    "per_page": ***,
    "prev_page_url": null,
    "to": **,
    "total": **
}

Google Webs   POST

To get all the google webs that atribus has collect for you https://api.atribus.com/api/timeline_google_webs

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
search int Body Required Search that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "category_id": *,
            "search_id": **,
            "googles_webs_id": ***,
            "title": "*****",
            "url": "***",
            "lang": "**",
            "host": "***",
            "summary": "*****",
            "datetime_created": "***",
            "sentiment_human": **,
            "count_shared": **,
            "social_engagement": **,
            "engagement": **,
            "vep": **,
            "picture": "**"
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_google_webs?page=1",
    "from": *,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_google_webs?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_google_webs?page=2",
    "path": "https://api.atribus.com/api/timeline_google_blogs",
    "per_page": *,
    "prev_page_url": null,
    "to": *,
    "total": **
}

Google News   POST

To get all the google webs that atribus has collect for you https://api.atribus.com/api/timeline_google_news

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
search int Body Required Search that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "category_id": *,
            "search_id": **,
            "googles_news_id": ***,
            "title": "*****",
            "url": "***",
            "lang": "**",
            "host": "***",
            "summary": "*****",
            "datetime_created": "***",
            "sentiment_human": **,
            "count_shared": **,
            "social_engagement": **,
            "engagement": **,
            "vep": **,
            "picture": "**"
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_google_news?page=1",
    "from": *,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_google_news?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_google_news?page=2",
    "path": "https://api.atribus.com/api/timeline_google_news",
    "per_page": *,
    "prev_page_url": null,
    "to": *,
    "total": **
}

Google Discussions   POST

To get all the google discussions that atribus has collect for you https://api.atribus.com/api/timeline_google_discussions

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
search int Body Required Search that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "category_id": *,
            "search_id": **,
            "googles_discussions_id": ***,
            "title": "*****",
            "url": "***",
            "lang": "**",
            "host": "***",
            "summary": "*****",
            "datetime_created": "***",
            "sentiment_human": **,
            "count_shared": **,
            "social_engagement": **,
            "engagement": **,
            "vep": **,
            "picture": "**"
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_google_discussions?page=1",
    "from": *,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_google_discussions?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_google_discussions?page=2",
    "path": "https://api.atribus.com/api/timeline_google_discussions",
    "per_page": *,
    "prev_page_url": null,
    "to": *,
    "total": **
}

Google Blogs   POST

To get all the google blogs that atribus has collect for you https://api.atribus.com/api/timeline_google_blogs

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
search int Body Required Search that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "category_id": *,
            "search_id": **,
            "googles_blogs_id": ***,
            "title": "*****",
            "url": "***",
            "lang": "**",
            "host": "***",
            "summary": "*****",
            "datetime_created": "***",
            "sentiment_human": **,
            "count_shared": **,
            "social_engagement": **,
            "engagement": **,
            "vep": **,
            "picture": "**"
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_google_blos?page=1",
    "from": *,
    "last_page": **,
    "last_page_url": "https://api.atribus.com/api/timeline_google_blogs?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_google_blogs?page=2",
    "path": "https://api.atribus.com/api/timeline_google_blogs",
    "per_page": *,
    "prev_page_url": null,
    "to": *,
    "total": **
}

Google My Business   POST

To get all the reviews of google my business that atribus has collect for you https://api.atribus.com/api/timeline_gmb_profiles

Request

Parameter Type Position # Description
authorization string Header Required Bearer token for the request.
category int Body Required Category that you want gather all the information.
profile int Body Required Profile that you want gather all the information.
start_date date Body Required Start time for the gather information.
end_date date Body Required End time for the gather information.

Response

{
    "current_page": 1,
    "data": [
        {
            "category_id": **,
            "profile_id": ***,
            "review_id": "************",
            "account_id": "*****",
            "location_id": "*****",
            "text": "",
            "date_created": "****",
            "user_id": "******",
            "star_rating": *,
            "date_updated": "*****",
            "is_reply": **,
            "reply_comment": "**",
            "reply_date_updated": "***",
            "sentiment": *,
            "lang": "*",
            "location_lang": "*",
            "store_code": "",
            "website_url": "***",
            "location_name": "***",
            "primary_phone": "**",
            "additional_phones": "**",
            "address_lines": "**",
            "locality": "**",
            "county_code": "***",
            "county": "**",
            "country_code": "**",
            "country": "***",
            "latitude": *****,
            "longitude": *****,
            "place_id": "***",
            "can_delete": *,
            "can_modify_service_list": *,
            "can_update": *,
            "is_google_updated": *,
            "is_local_post_api_disabled": *,
            "is_published": *,
            "is_verified": *,
            "maps_url": "*************",
            "primary_category_id": "***",
            "primary_category_name": "**",
            "profile_description": "**",
            "account_name": "*****",
            "type": "***",
            "role": "**",
            "status": "**",
            "permission_level": "**",
            "registered_domain": "*",
            "account_phone": "*",
            "account_location": "**",
            "account_county_code": "*",
            "account_county": "*",
            "account_country": "*",
            "account_country_code": "*",
            "account_lang": "**",
            "user_name": **,
            "user_profile_url": **,
            "user_photo_url": **,
            "user_gender": **,
            "user_age": **
        }
    ],
    "first_page_url": "https://api.atribus.com/api/timeline_gmb_profiles?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.atribus.com/api/timeline_gmb_profiles?page=**",
    "next_page_url": "https://api.atribus.com/api/timeline_gmb_profiles?page=2",
    "path": "https://api.atribus.com/api/timeline_gmb_profiles",
    "per_page": 100,
    "prev_page_url": null,
    "to": **,
    "total": **
}