Search Endpoints

/v1/users/search
/v1/media/tags/search
/v1/media/search

User Search - /v1/users/search

HTTP Verb (GET)

Returns all users associated with a search query.  The third parameter of this endpoint determines in which field to search. You have the option of searching username, fill_name, email, Facebook username, and twitter usernames.  If this parameter is omitted, the search will default to username.

Input Parameters

Input

Optional

Description

access_token

N

A valid authority token

q

N

Search Query

search_type

Y

Describes which field to search in (username, fill_name, emaile, facebook, twitter).  Default search is by username.

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, or trending.
  • 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

 

Tag Search - /v1/media/tags/search

HTTP Verb (GET)

Searches the media database and returns all media with metadata (i.e. hashtags) that match the query keyword. If the search does not yield any results, the medias array will be empty.

If the count parameter (number of results) is not specified, the search defaults to 100.   

Input Parameters

Input

Optional

Description

q

N

Query string

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, or following
  • 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

 

Media Text Search - /v1/media/search

HTTP Verb (GET)

Searches the media database and returns all media for a particular search string. The search includes all fields for media (e.g. title, user).  This endpoint also allows for geolocation search by including a geocode parameter.  The geocode information should be a lat/long pair.  The default radius around the geocode location is set to 5 miles. The search will return no videos If there are no videos uploaded within the lat/long pair.

The page parameter determines which page of results to return.  The number of results per page is determined by the count.  A request for the the first 50 (i.e. 0-49) medias would have the page parameter as 1.  For the next 50 (i.e. 50-100), the page parameter would be 2.  The page parameter defaults to 1.

If the search does not yield any results, the medias array will be empty.

Input Parameters

Input

Optional

Description

q

N

Search Query

geocode

Y

String of lat/long pair

page

Y

The page number of results to return.

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, or following.
  • 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 25 as of 9 months ago by josh

0 Comments

Please sign in to post a comment.