Media API • Query

Query

Method: POST
URL: https://www.wellcomemat.com/api/media/query.php

Notes:

If no parameters are specified, query will return ALL medias for this account, including shared videos. This is inadvisable for users with large video libraries.
If hash or customid are not provided and user_id OR unique_id ARE provided, query will return ALL medias for the user specified account. I.E. If you are the key and secret owner, if you specify your user_id you will only receive your videos. If you were to specify an account’s user_id that shares videos to your account, it will return only those user’s videos.

Parameters

Key	Type	Description
key	text	`{{key}}`
secret	text	`{{secret}}`
hash	text	Media Hash. We highly recommended using the hash to avoid handling duplicates as this is a unique identifier for the video.
customid	text	Custom/Listing ID. A Custom ID is a unique code you can use to more easily identify your video when connecting to WellcomeMat via our API.
user_id	text	This is WellcomeMat’s internal ID for users of our system.
unique_id	text	This is an ID assigned to users externally from WellcomeMat (Example: agent, member or associate IDs)
ortitlewords	text	OR Title Words Comma separated list of title words Returned media will have at least one of the title words
andtitlewords	text	AND Title Words Comma separated list of title words Returned media will have all of the title words
orkeywords	text	OR Keywords Comma separated list of keywords(“tags”) Returned media will have at least one of the keywords(“tags”)
andkeywords	text	AND Keywords Comma separated list of keywords(“tags”) Returned media will have all of the keywords(“tags”)
status	text	Media Status. Must be a valid status code [100-700]
playlist	text	Must be a valid playlist id. To maintain the playlist’s video order, do not specify a sort
video_type	text	Must be a valid type id [1-99]
start_date	text	Show videos uploaded after start_date. Format: `YYYY-MM-DD hh:mm:ss`
end_data	text	Show videos uploaded before end_date. Format: `YYYY-MM-DD hh:mm:ss`
metadata_updated_start	text	Show videos with data modified after metadata_updated_start. Format: `YYYY-MM-DD hh:mm:ss`
metadata_updated_end	text	Show videos with data modified before metadata_updated_end. Format: `YYYY-MM-DD hh:mm:ss`
limit	text	Limit results. [Integer]
sort	text	Must be a valid sorting option, either “newest” or “oldest” first
include_playlists	text	Include playlists in results. Boolean: 1 or 0 (defaults to 0) Whether to include the playlists that a video is in

Response

type MediaQueryResponse = {
    success: 0 | 1;
    error: string;
    warnings: string;
    medias: Media[];
};

Upload Update