API documentation
Documentation
Docs navigation
API navigation
Misc
When creating a Source there are certain fields that take numeric identifiers - these are defined below.
Identifiers
Network IDs
Source Type IDs
Network IDs
When filtering Posts using the network_id parameter use the following integers to represent the desired network:
| network_id | Network Name |
|---|---|
| 1 | |
| 2 | |
| 3 | |
| 5 | |
| 7 | Flickr |
| 8 | Youtube |
| 9 | Tumblr |
| 10 | RSS |
| 11 | |
| 12 | Vimeo |
| 13 | Diffbot |
| 15 | Glassdoor |
| 17 | Yelp |
| 18 | DeviantArt |
| 19 | Behance |
| 21 | Slack |
| 22 | Giphy |
| 23 | |
| 25 | Tiktok |
Source Type IDs
When creating a Source you can define the source_type using the follow integers:
| source_type | Description | Tag format |
|---|---|---|
| 1 | Twitter tag | hashtag |
| 3 | Twitter user | username |
| 5 | Facebook page | url part |
| 9 | Flickr tag | hashtag |
| 10 | YouTube tag | hashtag |
| 11 | Tumblr tag | hashtag |
| 13 | YouTube channel | username/channel id |
| 14 | Tumblr user | username |
| 15 | Flickr user | username |
| 16 | RSS | url |
| 18 | Linkedin Page | company id |
| 20 | Twitter user mention | username |
| 21 | Twitter geolocation | lat,long,distance |
| 24 | Facebook visitor posts | url part |
| 25 | Twitter timeline | username |
| 27 | Flickr album | album id |
| 28 | Vimeo tag | hashtag |
| 29 | Diffbot crawlbot | crawl bot id |
| 32 | Glassdoor employer | employer name |
| 33 | Instagram Business | username |
| 34 | Instagram Timeline | username* |
| 35 | Youtube Playlist | playlist id |
| 38 | Instagram tag | hashtag |
| 57 | Tiktok tag | hashtag |
| 58 | Google Reviews (Lite) | placeId |
| 59 | Google Reviews | placeId |
| 62 | Linkedn Profile | profile url |
Note: * For Instagram Timeline & Instagram Business - the username must match an existing Connection created through the Admin Dashboard.
Tag format
hashtag a string keyword without the # usually does not include spaces or none url
username a unique string identifier of the a user on the social network
url part the last part of a url identifying the source
channel id unique string id representing a YouTube Channel
lat,long,distance a location in the format latitude, longitude and radial distance (in miles)
placeId place ID used by google maps to identify a place.
Source description
1 - Twitter Tag - pulls Twitter posts based on a hashtag. tag should be Twitter hashtag without the # .
3 - Twitter user - pulls Twitter posts from a users public timeline. tag should be the Twitter username without the @.
5 - Facebook page - pulls posts from a Facebook page. tag should be the last part of the Facebook page's url.
9 - Flickr Tag - pulls Flickr+ posts based on a hashtag. tag should be Flickr hashtag without the #.
10 - YouTube tag - pulls YouTube posts based on a hashtag. tag should be YouTube hashtag without the #.
11 - Tumblr tag - pulls Tumblr posts based on a hashtag. tag should be Google+ Tumblr without the #.
13 - YouTube channel - pulls YouTube posts from a users channel. tag should be the channel identifier (either a username or channel id).
14 - Tumblr user- pulls Tumblr posts from a users public timeline. tag should be the Tumblr username without the @.
15 - Flickr user - pulls Flickr posts from a users public timeline. tag should be the Flickr username without the @.
16 - RSS - pulls posts from a public RSS feed. tag should be the full URL to the feed.
18 - Linkedin page - pulls LinkedIn posts from a companies public timeline. tag should be the Company Id - this can be found as the last part of the URL to a company page.
20 - Twitter user mention - pulls Twitter posts that mention a specific username. tag should be the Twitter username without the @.
21 - Twitter geolocation - pulls Twitter posts around a specific location. tag is a location in the format latitude, longitude and radial distance (in miles)
24 - Facebook visitor posts - pulls visitor posts from a Facebook page. tag should be the last part of the Facebook page's url.
25 - Twitter - pull Twitter timeline for a particular user. tag shoudld be the username without the @.
27 - Flickr album - pulls in post from a Flickr Album. tag should be the ID of the album (found at the end of the Album URL eg: https://www.flickr.com/photos/145167874@N03/albums/72157671881444944)
28 - Vimeo tag - pulls Vimeo posts based on a hashtag. tag should be Vimeo hashtag without the # .
29 - Diffbot Crawlbot - Pulls in posts from Crawl Bot (https://www.diffbot.com/products/crawlbot/).
32 - Glassdoor employer - pulls in reviews from a Glassdoor employer. tag should be the name of the employer.
33 - Instagram Business Account - pulls posts from a Instagram Business page. tag should be the Instagram Business name.
34 - Instagram Timeline - pulls Instagram posts from a users public timeline. tag should be the Instagram username without the @. Note the username must match an existing Connection created through the Admin Dashboard.
35 - Youtube Playlist - pulls YouTube posts from a playlist. tag should be the playlist identifier.
38 - Instagram Business Tag - pulls Instagram posts based on a hashtag. tag should be Instagram hashtag without the #.
57 - Tiktok Hashtag - pulls Tiktok posts based on a hashtag. tag should be Tiktok hashtag without the #.
58 - Google Reviews (Lite) - pulls 5 reviews of a specified place from Google Maps. tag parameter must be a valid Google Place ID associated with the desired location.
59 - Google Reviews - pulls reviews of a specified place from Google Maps. tag parameter must be a valid Google Place ID associated with the desired location.
Depreciated Source Types
The following sources are depreciated due to changes in various Social Networks.
| source_type | Description | Tag format |
|---|---|---|
| 2 | Instagram tag | hashtag |
| 4 | Instagram Account | username |
| 6 | Vine tag | hashtag |
| 8 | Google+ tag | username |
| 8 | Google+ user | username |
| 19 | Vine user | username |
| 22 | Instagram geolocation | lat,long,distance |
| 23 | Instagram location | Facebook Place ID |
| 26 | NOT USED | |
| 30 | NOT USED | |
| 31 | NOT USED |
2 - Instagram Tag - [DEPRECIATED] - pulls Instagram posts based on a hashtag. tag should be Instagram hashtag without the #.
4 - Instagram user - [DEPRECIATED] pulls Instagram posts from a users public timeline. tag should be the Instagram username without the @.
6 - Vine Tag - [DEPRECIATED] - pulls Vine posts based on a hashtag. tag should be Vine hashtag without the #.
8 - Google+ Tag - [DEPRECIATED] - pulls Google+ posts based on a hashtag. tag should be Google+ hashtag without the #.
12 - Google+ user - [DEPRECIATED] - pulls Google+ posts from a users public timeline. tag should be the Google+ username without the @.
19 - Vine user - [DEPRECIATED] - pulls Vine posts from a users public timeline. tag should be the Vine username without the @.
22 - Instagram geolocation - [DEPRECIATED] - pulls Instagram posts around a specific location. tag is a location in the format latitude, longitude and radial distance (in miles)
23 - Instagram location - [DEPRECIATED] - pulls Instagram posts around a specific location. tag is a Facebook Place ID that identifies the location tag