Socialid.selfie.posts
From Social ID Developers
(Difference between revisions)
Renato.neves (Talk | contribs) (→Example) |
Renato.neves (Talk | contribs) |
||
(6 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
+ | <span style="color: red; font-weight: bold">Deprecation notice:</span> this API is deprecated since July 19, 2018. | ||
+ | |||
== Description == | == Description == | ||
− | + | Searches for moderated posts for a given hashtag. | |
== Usage == | == Usage == | ||
− | socialid.selfie.posts(hashtag, handler, options) | + | socialid.selfie.posts(handler, options) |
+ | |||
+ | <span style="color:red">Important:</span> the parameters in the format socialid.selfie.posts(hashtag, handler, options) are deprecated. Use the hashtag parameter as an option. | ||
== Parameters == | == Parameters == | ||
{| | {| | ||
− | |||
− | |||
− | |||
− | |||
! align="left" width="200px" | handler | ! align="left" width="200px" | handler | ||
− | | width="200px" | | + | | width="200px" | required |
− | | | + | | callback function to be called on the API response. |
|+ | |+ | ||
! align="left" width="200px" | options | ! align="left" width="200px" | options | ||
− | | width="200px" | | + | | width="200px" | optional |
− | | | + | | object containing additional parameters. |
+ | |+ | ||
+ | ! align="left" width="200px" style="padding-left: 20px" | hashtag | ||
+ | | width="200px" | optional | ||
+ | | hashtag used to search the posts. If no hashtag is informed, the API will return posts from all hashtags registered in the app. | ||
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | page | ! align="left" width="200px" style="padding-left: 20px" | page | ||
− | | width="200px" | | + | | width="200px" | optional |
− | | | + | | results page number. Default: 1. |
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | limit | ! align="left" width="200px" style="padding-left: 20px" | limit | ||
− | | width="200px" | | + | | width="200px" | optional |
− | | | + | | max number of results per page. Default: 15. |
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | order | ! align="left" width="200px" style="padding-left: 20px" | order | ||
− | | width="200px" | | + | | width="200px" | optional |
− | | | + | | results sort order. Can be "created_at" to sort by post creation date in descending order, or "like" to sort by number of likes in descending order. Default: "created_at". |
|+ | |+ | ||
! align="left" width="200px" style="padding-left: 20px" | user_id | ! align="left" width="200px" style="padding-left: 20px" | user_id | ||
− | | width="200px" | | + | | width="200px" | optional |
− | | | + | | user identifier ("user_liked" attribute in the response). Default: User IP. <span style="color:red">This parameter is deprecated.</span> |
|} | |} | ||
Line 43: | Line 47: | ||
{| | {| | ||
! align="left" width="200px" | data | ! align="left" width="200px" | data | ||
− | | | + | | In case of success, an object containing search results. The object has the following properties: "results", "offset", "count", and "total". |
|+ | |+ | ||
! align="left" width="200px" | status | ! align="left" width="200px" | status | ||
− | | | + | | API call status. Can be '''"success"''' on a successful search, or '''"internal_server_error"''' if any unknown error happens. |
|} | |} | ||
== Example == | == Example == | ||
− | + | Returns the last moderated posts for all hashtags, with default options: | |
var handler = function(response) { | var handler = function(response) { | ||
Line 57: | Line 61: | ||
console.log(response.data.results); | console.log(response.data.results); | ||
} else { | } else { | ||
− | alert(" | + | alert("Couldn't perform the search."); |
} | } | ||
} | } | ||
var appId = 1; | var appId = 1; | ||
socialid.selfie.init(appId); | socialid.selfie.init(appId); | ||
− | socialid.selfie.posts( | + | socialid.selfie.posts(handler); |
+ | |||
+ | Returns the last moderated posts for the "focacbt" hashtag, with default options: | ||
+ | |||
+ | var handler = function(response) { | ||
+ | if (response.status == "success") { | ||
+ | console.log(response.data.results); | ||
+ | } else { | ||
+ | alert("Couldn't perform the search."); | ||
+ | } | ||
+ | } | ||
+ | var appId = 1, | ||
+ | options = { | ||
+ | hashtag: 'focacbt' | ||
+ | }; | ||
+ | socialid.selfie.init(appId); | ||
+ | socialid.selfie.posts(handler, options); | ||
− | + | Returns the last moderated posts for the "focacbt" hashtag, with custom options: | |
var handler = function(response) { | var handler = function(response) { | ||
Line 70: | Line 90: | ||
console.log(response.data.results); | console.log(response.data.results); | ||
} else { | } else { | ||
− | alert(" | + | alert("Couldn't perform the search."); |
} | } | ||
} | } | ||
var appId = 1, | var appId = 1, | ||
options = { | options = { | ||
+ | hashtag: 'focacbt', | ||
page: 2, | page: 2, | ||
limit: 40, | limit: 40, | ||
Line 81: | Line 102: | ||
}; | }; | ||
socialid.selfie.init(appId); | socialid.selfie.init(appId); | ||
− | socialid.selfie.posts( | + | socialid.selfie.posts(handler, options); |
− | + | Example "data" object: | |
data = { | data = { | ||
Line 90: | Line 111: | ||
results: [{ | results: [{ | ||
created_at: "2014-08-28T15:32:20+00:00", | created_at: "2014-08-28T15:32:20+00:00", | ||
− | display_name: " | + | display_name: "Jennyffer Suellen", |
likes: 0, | likes: 0, | ||
low_picture_url: "http://scontent-b.cdninstagram.com/hphotos-xfa1/t51.2885-15/10632020_1540533216169293_1066110938_a.jpg", | low_picture_url: "http://scontent-b.cdninstagram.com/hphotos-xfa1/t51.2885-15/10632020_1540533216169293_1066110938_a.jpg", | ||
Line 97: | Line 118: | ||
post_id: 3, | post_id: 3, | ||
post_url: "http://instagram.com/p/sP0HM_jwVv/", | post_url: "http://instagram.com/p/sP0HM_jwVv/", | ||
+ | profile_picture_url: "http://photos-e.ak.instagram.com/hphotos-ak-xaf1/10632016_256085694602076_741961532_a.jpg", | ||
provider: "instagram", | provider: "instagram", | ||
thumb_picture_url: "http://scontent-b.cdninstagram.com/hphotos-xfa1/t51.2885-15/10632020_1540533216169293_1066110938_s.jpg", | thumb_picture_url: "http://scontent-b.cdninstagram.com/hphotos-xfa1/t51.2885-15/10632020_1540533216169293_1066110938_s.jpg", | ||
− | user_liked: true | + | user_liked: true, |
+ | username: "jennyffer.suellen" | ||
}], | }], | ||
total: 1 | total: 1 | ||
} | } | ||
− | + | The low_picture_url, thumb_picture_url, and user_liked properties may return as null depending on the post. |
Latest revision as of 16:04, 29 October 2018
Deprecation notice: this API is deprecated since July 19, 2018.
Contents |
Description
Searches for moderated posts for a given hashtag.
Usage
socialid.selfie.posts(handler, options)
Important: the parameters in the format socialid.selfie.posts(hashtag, handler, options) are deprecated. Use the hashtag parameter as an option.
Parameters
handler | required | callback function to be called on the API response. | options | optional | object containing additional parameters. | hashtag | optional | hashtag used to search the posts. If no hashtag is informed, the API will return posts from all hashtags registered in the app. | page | optional | results page number. Default: 1. | limit | optional | max number of results per page. Default: 15. | order | optional | results sort order. Can be "created_at" to sort by post creation date in descending order, or "like" to sort by number of likes in descending order. Default: "created_at". | user_id | optional | user identifier ("user_liked" attribute in the response). Default: User IP. This parameter is deprecated. |
---|
API Response
data | In case of success, an object containing search results. The object has the following properties: "results", "offset", "count", and "total". | status | API call status. Can be "success" on a successful search, or "internal_server_error" if any unknown error happens. |
---|
Example
Returns the last moderated posts for all hashtags, with default options:
var handler = function(response) { if (response.status == "success") { console.log(response.data.results); } else { alert("Couldn't perform the search."); } } var appId = 1; socialid.selfie.init(appId); socialid.selfie.posts(handler);
Returns the last moderated posts for the "focacbt" hashtag, with default options:
var handler = function(response) { if (response.status == "success") { console.log(response.data.results); } else { alert("Couldn't perform the search."); } } var appId = 1, options = { hashtag: 'focacbt' }; socialid.selfie.init(appId); socialid.selfie.posts(handler, options);
Returns the last moderated posts for the "focacbt" hashtag, with custom options:
var handler = function(response) { if (response.status == "success") { console.log(response.data.results); } else { alert("Couldn't perform the search."); } } var appId = 1, options = { hashtag: 'focacbt', page: 2, limit: 40, order: 'like', user_id: '50.97.87.253' }; socialid.selfie.init(appId); socialid.selfie.posts(handler, options);
Example "data" object:
data = { count: 1, offset: 0, results: [{ created_at: "2014-08-28T15:32:20+00:00", display_name: "Jennyffer Suellen", likes: 0, low_picture_url: "http://scontent-b.cdninstagram.com/hphotos-xfa1/t51.2885-15/10632020_1540533216169293_1066110938_a.jpg", message: "Foca no iguana #focacbt", picture_url: "http://scontent-b.cdninstagram.com/hphotos-xfa1/t51.2885-15/10632020_1540533216169293_1066110938_n.jpg", post_id: 3, post_url: "http://instagram.com/p/sP0HM_jwVv/", profile_picture_url: "http://photos-e.ak.instagram.com/hphotos-ak-xaf1/10632016_256085694602076_741961532_a.jpg", provider: "instagram", thumb_picture_url: "http://scontent-b.cdninstagram.com/hphotos-xfa1/t51.2885-15/10632020_1540533216169293_1066110938_s.jpg", user_liked: true, username: "jennyffer.suellen" }], total: 1 }
The low_picture_url, thumb_picture_url, and user_liked properties may return as null depending on the post.