Types | API v1 Documentation

{ "id": long - topic id, "smallImageUrl": string - topic image url (16x16), "mediumImageUrl": string - topic image url (48x48), "imageUrl": string - topic image url (96x96), "largeImageUrl": string - topic image url (192x192), "backgroundImage":* string - URL of the topic's background image, if set "backgroundRepeat":* string - CSS background-repeat property to be applied to the topic's background image "backgroundColor":* string - topic's background color expressed as a six character hexa code (eg. FFCC00) "description": string - topic description, "name": string - topic name, "shortName": string - topic short name (used in website urls), "url": string - topic url "lang": string - the language of the topic "isCurator": boolean - true if topic is curated by current user, "isFollowing": boolean - true if topic is following by current user, "curablePostCount":* int - number of curable posts in this topic, "curatedPostCount": int - number of curated posts in this topic, "unreadPostCount":* int - number of unread posts, "score": int - the score of the topic "creator": < user > - creator of the topic "pinnedPost":* < post > - post pinned at the top of the topic "curablePosts":* < post[] > - an array of posts to curate on this topic, "curatedPosts":* < post[] > - an array of curated posts on this topic, "tags": < topic_tag[] > - an array of tags present on this topic "stats": < topic_stats > - the stats for this topic }

{ tag: string - the tag, postCount: int - the number of posts in the topic tagged with this tag }

{ "id": long - the id of the post, "content": string - post content in plain text, "htmlContent": string - post content in HTML, "htmlFragment": string - additional embedded HTML content if applicable (eg: embedded videos), "insight": string - the insight of the curator, "htmlInsight": string - the html version of the insight, "title": string - The post title, "thanksCount": int - The number of times this post was thanked, "reactionsCount": int - The number reactions on this post, "source": < source > - The source of the post, "twitterAuthor": string - if source is a twitter search, the twitter user who wrote the original tweet "url": string - original url of the post, "scoopUrl": string - url of the post on the scoop platform, "scoopShortUrl": string - shortened url of the post on the scoop platform, "smallImageUrl": string - url of the image chosen by the curator, referred below as "post image" (max width: 100px), "mediumImageUrl": string - url of the image chosen by the curator, referred below as "post image" (max width: 200px), "imageUrl": string - url of the image chosen by the curator, referred below as "post image" (max width: 400px), "largeImageUrl": string - url of the image chosen by the curator, referred below as "post image" (max width: 1024px), "imageWidth": int - width in pixel of the original post image, "imageHeight": int - height in pixel of the original post image, "imageSize": int - size of the post image in the topic view, "imagePosition": string - position of the post image in the topic view: "left" | "center" | "right", "imageUrls": string[] - array of urls of image selector in curation mode, "tags": string[] - array of tags, "commentsCount": int - the number of comments for this post, "isUserSuggestion": boolean - true if the post is a user suggestion, "pageViews": long - number of time this post has been viewed, "edited": boolean - true if the description of this post has been manually edited by the curator, "author": < user > - the author of the post "publicationDate": < timestamp > - the publication date of the original article "curationDate": < timestamp > - the curation date of the post (aka the publication date on Scoop.it) "comments": < post_comment[] > - the list of comments "thanked":* boolean - true if the user has already thanked this post, "topicId": long - the id of the topic this post is belonging to "topic":** < topic > - the topic this post is belonging to }

{ "type": enum - the type a the comment one of "text", "share", "thank", "rescoop" (see above) "text": string - the comment text if applicable, "sharerId": string - the sharer id if applicable, "rescoopedPostId": long - id of the rescooped post if applicable, "date": < timestamp > - the comment date, "author": < user > - the comment author }

{ "id": long - id of the source, "name": string - name of the source (human readable), "description": string - description of the source (human readable), "type": string - type of the source (developper readable identifier), "iconUrl": string - url of an icon representing this source, "url": string - url of this source (may be a user profile url, a link to a youtube search...) }

{ "id": long - user id, "name": string - user name, "shortName": string - user shortName (used in website urls), "bio": string - user bio, "smallAvatarUrl": string - user avatar url (16x16) "mediumAvatarUrl": string - user avatar url (48x48) "avatarUrl": string - user avatar url (96x96) "largeAvatarUrl": string - user avatar url (192x192) "sharers":* < sharer[] > - the list of sharers of the user "curatedTopics": < topic[] > - the list of topic this user is the curator "followedTopics": < topic[] > - the list of topics followed by this user }

{ "sharerName" string - display name of this sharer, "sharerId" string - internal id, "cnxId" long - internal id, "name" string - the name of the user on the external service represented by this sharer, for a facebook account it will be the facebook user name, "mustSpecifyShareText" boolean - true if the external service needs a manually specified text to publish a post, }

{ "type": < notification_type > - type of the notification ... (data related to type) }

enum { topicNewComment - a comment has been added on a topic, topicSubscription - a new user subscribed to a topic curated by the current user, userPostThanked - a post has been thanked on a topic curated by the current user, userWelcomeMessage - the welcome message notification, userSnsContact - a friend or someone followed by the current user has joined or is using Scoop.it, userSnsTopicCreated - a friend or someone followed by the current user created a topic, userSuggestionAccepted - a suggestion of the current user has been accepted, userNewCommentResponse - a comment has been posted on a post the current user has commented, userNewUserSuggestion - a user suggestion has been accepted on a topic the current user is following, topicCuratorNewUserSuggestion - a new user suggestion has been added on a topic curated by the current user, pendingUserSuggestionReminder - there is pending user suggestion on a topic curated by the current user, }

{ "uv": int - visitors, "uvp": int - visitors progression, "v": int - views, "vp": int - views progression "updated": < timestamp > - last update timestamp, "created": < timestamp > - creation timestamp, "creatorName": string - creator name, "creatorId": long - creator id, "followers": int - number of followers of this topic }