get https://api.yotpo.com/v1/apps//images/export?utoken=
Get user-generated photos and/or video by source
and media_type
. The media source could be from review
, import
, onsite_upload
, or social
.
How to use this endpoint
- For example responses, click the relevant status code on the right.
Export Images - Images Array Response Attributes
Attribute | Description |
---|---|
images | The images array |
source | The source of the image. e.g. 'review', 'import', 'onsite_upload', 'social' |
image_id | The unique ID of the image |
standard_resolution | The image in its standard resolution |
low_resolution | The image in low resolution |
facebook_resolution | The image cropped to Facebook resolution |
twitter_resolution | The image cropped to Twitter resolution |
instagram_resolution | The image cropped to Instagram resolution |
original_image_url | The original image in its original resolution |
tagged_products | This array includes the unique product_id and product_name of the tagged_products |
post | This hash includes the content of the image post as well as the user_name and user_email of the reviewer who posted the image. |
content | The textual content of the post |
user_name | The name of the reviewer who posted the image |
user_email | The email address of the reviewer who posted the image |
albums | The array of albums including the album type and album name` |
type | The type of album in which the image is located. This could be CustomAlbum or ProductAlbum |
name | The 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. |
id | The album's unique identifier |
original_video_url | The link to the original Instagram post |
video_id | The video's unique identifier |
video_url | Hosted URL of the video itself |
video_duration | The length of the video (in seconds) |
thumbnail | The video's cover image thumbnail |