- Intro
- Authenticating
- get_video_status
- launch_video
- launch_cross_post
- launch_destination
- launch_feed
- list_available_sites
- list_available_destinations
- list_available_feeds
- list_available_cross_post_sites
- list_categories
- list_campaigns
- list_uploads
- list_upload_video_stats
- upload_video
- upload_video_url
- which_host
- recall_video
- add_mrss_feed
- get_mrss_feed_status
- Additional Inplay Info
- get_views
- get_viewed_minutes
- get_unique_viewers
- get_new_viewers
- get_video_list_analytics
- get_video_engagement
- get_player_embeds
- get_geo_analytics
- get_categories
- get_traffic_sources
- get_search_terms
- get_attention_span
- get_bandwidth_usage
- get_stream_rebuffers
- get_start_delays
- get_video_list_performance
- get_geo_performance
- get_os
- get_browser
- get_runtime
- get_demographics_age
- get_demographics_gender
- get_demographics_hh_income
- get_demographics_marital_status
- get_demographics_children
- get_demographics_homeowners
- get_trackers
- create_tracker
- update_tracker
- get_publishers
- share_inplay
- share_revoke
- share_list
- List of Video Sites
- PHP Reference Application
- Info For Partners
- Timezones
- Troubleshooting
Intro
The TubeMogul API allows developers to create customized applications that leverage the distribution and analytics capabilities available on the TubeMogul Web site.
TubeMogul's API is currently restricted to partners and paid customers (with some exceptions). To gain access, please contact us using this form.
Getting Started
We recommend the following for getting started with the TubeMogul API...
- Request your API token and secret key. Click here.
- Read this: Authenticating -- An overview of the API authentication model.
- Watch this Getting Started video:
-
- Using your tokens, try out a few methods using our API Explorer.
- Download and run our PHP reference app.
- Start coding.
API Format
Unless otherwise noted, all API calls must be implemented using HTTP requests with a content-type of application/x-www-form-urlencoded. All parameters sent in application/x-www-form-urlencoded requests must be URL encoded according to RFC 1738. The upload_video method must be a POST request with a content-type of multipart/form-data in order to upload a binary file. The responses will all be returned in a UTF-8 encoded XML file.
The endpoint URL of the API is:
http://api.tubemogul.com/api/v3/
Required Global Arguments
The arguments listed below are required for every API method call, in addition to any arguments that are specific to the method:
method(string)- The name of the method being called.
date(integer)- A UNIX timestamp displaying the number of seconds elapsed since January 1st, 1970 (UTC).
auth(string)- A SHA-1 hash that concatenates the query string with the partner's secret key (See Authenticating dor details.)
user_id(string)- Your user id obtained from TubeMogul. (See Authenticating for details.)
Partners only: note that user_id is unnecessary with a partner_id/user_token combo. See Partner Authentication for details.
API Standard Error Codes
Successful queries will result in a reponse status="ok". Unsuccessful queries will result in status="fail". (Note that for legacy support, the API also returns stat="error" and stat="ok". Please use the status attribute.) All methods can return the following status codes, in addition to per-method errors:
90- The request was malformed (or the video file may be too large).91- Limit exceeded.93- Invalid authentication hash.94- Specified date is more than 30 minutes old or is greater than the current time.95- Unconfirmed userToken.96- Invalid userToken.97- Invalid method.98- The partnerID has exceeded its API usage limit.99- Invalid partnerID.999- An unexpected error occurred.