Video Upload

Upload videos for a review.

🚧

Only API keys on our Conversations platform are eligible to use this API version. Refer to the Platforms section of our Platform & API Concepts documentation to learn which platform your API keys are on.

πŸ“˜

This example is applicable only for full submission.

πŸ“˜

Try out Video Upload API reference here .

Examples

The following examples demonstrate common video upload requests. For a complete overview of video uploads, refer to the Video Upload tutorial.

Upload a video from a file

Videos must be uploaded using HTTP POST.

Staging

POST /data/uploadvideo.json?ApiVersion=[latestApiVersion]&ContentType=[review]&PassKey=[API_key] HTTP/1.1  
Host: stgmedia.api.bazaarvoice.com
Content-Length: 71374  
Content-Type: multipart/form-data; boundary=----FormBoundarycSTk3Rd73AEuhGuD  
...      


\----FormBoundaryE19zNvXGzXaLvS5C  
Content-Disposition: form-data; name="video"; filename="your_video.mpeg"                    
  
\---FormBoundaryE19zNvXGzXaLvS5C

Production

POST /data/uploadvideo.json?ApiVersion=[latestApiVersion]&ContentType=[review]&PassKey=[API_key] HTTP/1.1  
Host: media.api.bazaarvoice.com  
Content-Length: 71374  
Content-Type: multipart/form-data; boundary=----FormBoundarycSTk3Rd73AEuhGuD  
...      


\----FormBoundaryE19zNvXGzXaLvS5C  
Content-Disposition: form-data; name="video"; filename="your_video.mpeg"                          
  
\---FormBoundaryE19zNvXGzXaLvS5C

Ellipses (...) in above example indicate that your app may generate other headers.

Parameters

NameDescription
[FORMAT]Response format (json).

πŸ“
Required
This field is required in all API requests.
ApiVersionThe API version, e.g. 5.4.

πŸ“
Required
This field is required in all API requests.
ContentTypeThe content type for which this media is being submitted. Valid values include: review.

πŸ“
Required
This field is required in all API requests.
LocaleLocale to display Labels, Configuration, Product Attributes and Category Attributes in. The default value is the locale defined in the display associated with the API key.

πŸ”Ί
Alert
Failure to submit this field will result in your content being ineligible for syndication, authenticity or other business processes.
PassKeyAPI key is required to authenticate API user and check permission to access particular client's data.

πŸ“
Required
This field is required in all API requests.
VideoA file representing the video to be submitted. Note that the parameter name is case-sensitive and must be lowercase. Use video parameter to define the video to upload.

⚠️
Caution
This field may be required depending on per client configurations.

Response format

The following is an example of a video upload response:

{  
    "Locale": "en_US",  
    "Errors": [],  
    "Form": [  
        {  
            "Type": "Field",  
            "Id": "video"  
        }  
    ],  
    "Video": {  
        "VideoId": "861f7833-1ef4-43a9-a214-43b8d06381ab",  
        "VideoHost": "BAZAARVOICE",  
        "VideoThumbnailUrl": "https://d2pg9tvqg9rw5b.cloudfront.net/861f7833-1ef4-43a9-a214-43b8d06381ab/thumbnail/image-00001.png",  
        "VideoUrl": "https://d2pg9tvqg9rw5b.cloudfront.net/861f7833-1ef4-43a9-a214-43b8d06381ab/video/movie.mp4" 
    },  
    "FormErrors": {},  
    "SubmissionId": null,  
    "Data": {  
        "Fields": {  
            "video": {  
                "Options": [],  
                "Type": "FileInput",  
                "Required": null,  
                "Label": null,  
                "Value": null,  
                "MinLength": null,  
                "Id": "video",  
                "MaxLength": null,  
                "Default": null  
            }  
        },  
        "Groups": {},  
        "FieldsOrder": [  
            "video"  
        ],  
        "GroupsOrder": []  
    },  
    "TypicalHoursToPost": null,  
    "AuthorSubmissionToken": null,  
    "HasErrors": false  
}

Error codes

Value Description
ERROR_FORBIDDEN

Your configuration is disabled to collect videos. Go to configuration Hub to enable if you wish to collect videos in the review.

VIDEO_PARSE_ERROR

The uploaded video could not be parsed. Ensure the video is a valid GP/3G2, ASF, AVI, DV, FLV, MOV, MP4/F4V, MPEG/MPG, QT, or WMV file.

VIDEO_TOO_LARGE

The video could not be uploaded due to its size. Video must be less than 200 MB.

ERROR_BAD_REQUEST

Invalid parameter in content submission.