Get media

Get user-generated photos and/or video by source and media_type. The media source could be from review, import, onsite_upload, or social.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

How to use this endpoint

  • For example responses, click the relevant status code on the right.

Export Images - Images Array Response Attributes

AttributeDescription
imagesThe images array
sourceThe source of the image. e.g. 'review', 'import', 'onsite_upload', 'social'
image_idThe unique ID of the image
standard_resolutionThe image in its standard resolution
low_resolutionThe image in low resolution
facebook_resolutionThe image cropped to Facebook resolution
twitter_resolutionThe image cropped to Twitter resolution
instagram_resolutionThe image cropped to Instagram resolution
original_image_urlThe original image in its original resolution
tagged_productsThis array includes the unique product_id and product_name of the tagged_products
postThis hash includes the content of the image post as well as the user_name and user_email of the reviewer who posted the image.
contentThe textual content of the post
user_nameThe name of the reviewer who posted the image
user_emailThe email address of the reviewer who posted the image
albumsThe array of albums including the album type and album name`
typeThe type of album in which the image is located. This could be CustomAlbum or ProductAlbum
nameThe name of the album in which the image is located. If the album type is ProductAlbum, the album name is represented by the product ID of the product tagged in the album.
idThe album's unique identifier
original_video_urlThe link to the original Instagram post
video_idThe video's unique identifier
video_urlHosted URL of the video itself
video_durationThe length of the video (in seconds)
thumbnailThe video's cover image thumbnail
Path Params
string
required

The store ID

Query Params
string
required

Must choose one of the following values: review, import, onsite_upload, social

date

since date must be before the until date

date

until is the current date by default. Must take place after since date

int32
Defaults to 1

Default is 1 page

int32
Defaults to 10

Default: 10 Maximum: 100

string

Possible values are video or image. Passing a blank value will return both images and video

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json