User Endpoints

/v1/users/{user_id}/following
/v1/users/me/following
/v1/users/list/popular
/v1/users/{user_id}/followers
/v1/users/me/followers
/v1/users/users/user_id
/v1/users/me
/v1/users/user_id/media
/v1/users/me/media
/v1/media/favorite 
/v1/media/{user_id}/favorite

 

User Following - /v1/users/{user_id}/following

HTTP Verb (GET)

Returns a list of users that a particular user follows.  The returned list is ordered from newest to oldest and contains relevant data (e.g. full name, profile picture) on the user’s following list. This is the same list that users see when they login to Viddy and view their following list.

If the request fails, an error description will be returned.

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

user_id

N

A user id

older_than

Y

If specified, the returned entries will be older than this UTC timestamp

count

Y

Number of entries to return

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

follow-users[]

N

 
  • id

N

user ID
  • username

N

username
  • full_name

N

First and last name
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • profile

N

A link to the users Viddy profile
  • thumbnail

N

The users profile picture thumbnail object
  • profile_picture

N

The users profile picture object
  • followers_count

N

The number of followers this user has
  • following_count

N

The number of users that this user is following
  • videos_count

N

The number of active videos this user has uploaded
  • is_following

N

true if current user is also following that user
  • relationship_status

N

0 if the user is not following the particular user, 1 otherwise

 

Current User Following - /v1/users/me/following

HTTP Verb (GET)

Returns a list of users that the current user follows.  The returned list is ordered from newest to oldest and contains relevant data (e.g. full name, profile picture) on the current user’s following list.

If the request fails, an error description will be returned.

Input Parameters

Input

Optional

Description

access_token

N

Auth token

older_than

Y

if specified, the returned entries will be older than this UTC timestamp

count

Y

Number of entry to return

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

follow-users[]

N

 
  • id

N

user ID
  • username

N

username
  • full_name

N

First and last name
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • profile

N

A link to the users Viddy profile
  • thumbnail

N

The users profile picture thumbnail object
  • profile_picture

N

The users profile picture object
  • followers_count

N

The number of followers this user has
  • following_count

N

The number of users that this user is following
  • videos_count

N

The number of active videos this user has uploaded
  • is_following

N

true if current user is also following that user
  • relationship_status

N

0 if the user is not following the current user, 1 otherwise

 

User Followers - /v1/users/{user_id}/followers

HTTP Verb (GET)

Returns a list of followers for a particular user.  The returned list is ordered from newest to oldest and contains relevant data (e.g. full name, profile picture) on the user’s followers.  This is the same list that users see when they login to Viddy and view their followers.

If the request fails, an error description will be returned. 

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

user_id

N

A user id

older_than

Y

If specified, the returned entries will be older than this UTC timestamp

count

Y

Number of entries to return

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

follow-users[]

N

 
  • id

N

user ID
  • username

N

username
  • full_name

N

First and last name
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • profile

N

A link to the users Viddy profile
  • thumbnail

N

The users profile picture thumbnail object
  • profile_picture

N

The users profile picture object
  • followers_count

N

The number of followers this user has
  • following_count

N

The number of users that this user is following
  • videos_count

N

The number of active videos this user has uploaded
  • is_following

N

true if current user is also following that user
  • relationship_status

N

1 if the particular user is also following the user, 0 otherwise

 

Current User Followers - /v1/users/me/followers

HTTP Verb (GET)

Returns a list of followers for the current user.  The returned list is ordered from newest to oldest and contains relevant data (e.g. full name, profile picture) on the current user’s followers.

If the request fails, an error description will be returned. 

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

older_than

Y

If specified, the returned entries will be older than this UTC timestamp

count

Y

Number of entries to return

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

follow-users[]

N

 
  • id

N

user ID
  • username

N

username
  • full_name

N

First and last name
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • profile

N

A link to the users Viddy profile
  • thumbnail

N

The users profile picture thumbnail object
  • profile_picture

N

The users profile picture object
  • followers_count

N

The number of followers this user has
  • following_count

N

The number of users that this user is following
  • videos_count

N

The number of active videos this user has uploaded
  • is_following

N

true if current user is also following that user
  • relationship_status

N

1 if the current user is also following the user, 0 otherwise

 

Popular Users - v1/users/list/popular

HTTP Verb (GET)

Returns a list of popular users.  The returned list of users ranked based on a popularity algorithm.

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

follow-users[]

N

 
  • id

N

user ID
  • username

N

username
  • full_name

N

First and last name
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • profile

N

A link to the users Viddy profile
  • thumbnail

N

The users profile picture thumbnail object
  • profile_picture

N

The users profile picture object
  • followers_count

N

The number of followers this user has
  • following_count

N

The number of users that this user is following
  • videos_count

N

The number of active videos this user has uploaded
  • is_following

N

true if current user is also following that user
  • relationship_status

N

0 if the user is not following the particular user, 1 otherwise

 

User Information - /v1/users/users/user_id

HTTP Verb (GET)

Returns the profile information for a particular user.  This endpoint should be invoked when the details of a particular user profile (e.g. name, profile picture) is needed. 

If the request fails, an error description will be returned. 

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

user_id

N

A user id

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

follow-users[]

N

 
  • id

N

user ID
  • username

N

username
  • full_name

N

First and last name
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • profile

N

A link to the users Viddy profile
  • thumbnail

N

The users profile picture thumbnail object
  • profile_picture

N

The users profile picture object
  • followers_count

N

The number of followers this user has
  • videos_count

N

The number of users that this user is following
  • videos_count

N

The number of active videos this user has uploaded
  • is_following

N

true if current user is also following that user
  • relationship_status

N

1 if the current user is also following the user, 0 otherwise

 

Current User Information - /v1/users/me

HTTP Verb (GET)

Returns the profile information for the current user.  This method should be invoked when the details of the current user profile (e.g. name, profile picture) is needed. 

If the request fails, an error description will be returned. 

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

follow-users[]

N

 
  • id

N

user ID
  • username

N

username
  • full_name

N

First and last name
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • profile

N

A link to the users Viddy profile
  • thumbnail

N

The users profile picture thumbnail object
  • profile_picture

N

The users profile picture object
  • followers_count

N

The number of followers this user has
  • email

N

The e-mail address of this user
  • facebook_id

N

The Facebook id of this user
  • twitter_id

N

The Twitter id of this user
  • videos_count

N

The number of users that this user is following
  • videos_count

N

The number of active videos this user has uploaded

 

User Videos - /v1/users/user_id/media

HTTP Verb (GET)

Returns the list of videos for a particular user. The returned list is ordered from newest to oldest and contains relevant data (e.g. like count, thumbnail object) on each video in the list.

If the request fails, an error description will be returned. 

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

user_id

N

A user id

older_than

Y

If specified, the returned entries will be older than this UTC timestamp

count

Y

Number of entries to return

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

medias[]

N

 
  • id

N

Media id
  • type

N

Media type
  • title

N

Media title
  • thumbnail

N

A media thumbnail object
  • source

N

A url to the media file
  • share

N

A url to link to the web player for the video
  • comment_count

N

Comment count
  • like_count

N

Likes count
  • tag_count

N

Tags  count
  • flag_count

N

Flag count
  • location

N

 
  • name

N

Location name
  • latitude

N

Latitude
  • longitude

N

Longitude
  • altitude

N

Altitude
  • city

N

City
  • state

N

State
  • zip

N

Zip
  • country

N

Country
  • status

N

Status of the user: active or inactive
  • user

N

 
  • id

N

user ID
  • username

N

username
  • full_name

N

First and last name
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • profile

N

A url to the users Viddy profile
  • thumbnail

N

The users profile picture thumbnail object
  • profile_picture

N

The users profile picture object
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • packId

N

Production pack used on that video
  • short_url

N

Shortened url to media
  • description

N

Description of the video submitted by creator
  • visibility

N

The visibility of the video: public, private, followers
  • effectId

N

The ID of the effect that has been applied to the video.
  • fbLocationId

N

The FB location ID
  • duration

N

The duration of the video

 

Current User Videos - /v1/users/me/media

HTTP Verb (GET)

Returns the list of videos for the current user. The returned list is ordered from newest to oldest and contains relevant data (e.g. like count, thumbnail object) on each video in the list.

If the request fails, an error description will be returned. 

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

older_than

Y

If specified, the returned entries will be older than this UTC timestamp

count

Y

Number of entries to return

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

medias[]

N

 
  • id

N

Media id
  • type

N

Media type
  • title

N

Media title
  • thumbnail

N

A media thumbnail object
  • source

N

A url to the media file
  • share

N

A url to link to the web player for the video
  • comment_count

N

Comment count
  • like_count

N

Likes count
  • tag_count

N

Tags  count
  • flag_count

N

Flag count
  • location

N

 
  • name

N

Location name
  • latitude

N

Latitude
  • longitude

N

Longitude
  • altitude

N

Altitude
  • city

N

City
  • state

N

State
  • zip

N

Zip
  • country

N

Country
  • status

N

Status of the user: active or inactive
  • user

N

 
  • id

N

user ID
  • username

N

username
  • full_name

N

First and last name
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • profile

N

A url to the users Viddy profile
  • thumbnail

N

The users profile picture thumbnail object
  • profile_picture

N

The users profile picture object
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • packId

N

Production pack used on that video
  • short_url

N

Shortened url to media
  • description

N

Description of the video submitted by creator
  • visibility

N

The visibility of the video: public, private, followers
  • effectId

N

The ID of the effect that has been applied to the video.
  • fbLocationId

N

The FB location ID
  • duration

N

The duration of the video

User Videos - /v1/media/user_id/favorite

HTTP Verb (GET)

Returns the list of videos liked by a particular user. The returned list is ordered from newest to oldest and contains relevant data (e.g. like count, thumbnail object) on each video in the list.

If the request fails, an error description will be returned. 

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

user_id

N

A user id

older_than

Y

If specified, the returned entries will be older than this UTC timestamp

count

Y

Number of entries to return

Output Parameters

Output

Optional

Description

result

N

result code

desc

Y

error description if result != 0

medias[]

N

 
  • id

N

Media id
  • type

N

Media type
  • title

N

Media title
  • thumbnail

N

A media thumbnail object
  • source

N

A url to the media file
  • share

N

A url to link to the web player for the video
  • comment_count

N

Comment count
  • like_count

N

Likes count
  • tag_count

N

Tags  count
  • flag_count

N

Flag count
  • location

N

 
  • name

N

Location name
  • latitude

N

Latitude
  • longitude

N

Longitude
  • altitude

N

Altitude
  • city

N

City
  • state

N

State
  • zip

N

Zip
  • country

N

Country
  • status

N

Status of the user: active or inactive
  • user

N

 
  • id

N

user ID
  • username

N

username
  • full_name

N

First and last name
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • profile

N

A url to the users Viddy profile
  • thumbnail

N

The users profile picture thumbnail object
  • profile_picture

N

The users profile picture object
  • timestamp

N

Activity timestamp (unix timestamp 64-bit int)
  • unix_timestamp

N

Activity timestamp (unix timestamp 32-bit int)
  • packId

N

Production pack used on that video
  • short_url

N

Shortened url to media
  • description

N

Description of the video submitted by creator
  • visibility

N

The visibility of the video: public, private, followers
  • effectId

N

The ID of the effect that has been applied to the video.
  • fbLocationId

N

The FB location ID
  • duration

N

The duration of the video

version 21 as of 2 months ago by Viddy Admin

0 Comments

Please sign in to post a comment.